2 * Copyright (c) 2000 - 2013 Samsung Electronics Co., Ltd All Rights Reserved
4 * Contact: Bumjin Im <bj.im@samsung.com>
6 * Licensed under the Apache License, Version 2.0 (the "License");
7 * you may not use this file except in compliance with the License.
8 * You may obtain a copy of the License at
10 * http://www.apache.org/licenses/LICENSE-2.0
12 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License
19 * @file socket-manager.cpp
20 * @author Bartlomiej Grzelewski (b.grzelewski@samsung.com)
22 * @brief Implementation of SocketManager.
28 #include <sys/select.h>
29 #include <sys/signalfd.h>
30 #include <sys/types.h>
31 #include <sys/socket.h>
32 #include <sys/smack.h>
41 #include <systemd/sd-daemon.h>
43 #include <dpl/log/log.h>
44 #include <dpl/assert.h>
46 #include <smack-check.h>
47 #include <socket-manager.h>
51 const time_t SOCKET_TIMEOUT = 20;
53 int getCredentialsFromSocket(int sock, CKM::Credentials &cred) {
54 CKM::Credentials credentials;
55 std::vector<char> result(1);
59 if ((0 > getsockopt(sock, SOL_SOCKET, SO_PEERSEC, result.data(), &length))
62 LogError("getsockopt failed");
66 result.resize(length);
68 if (0 > getsockopt(sock, SOL_SOCKET, SO_PEERSEC, result.data(), &length)) {
69 LogError("getsockopt failed");
73 length = sizeof(ucred);
75 if (0 > getsockopt(sock, SOL_SOCKET, SO_PEERCRED, &peerCred, &length)) {
76 LogError("getsockopt failed");
80 result.push_back('\0');
81 cred.smackLabel = result.data();
82 cred.uid = peerCred.uid;
86 } // namespace anonymous
90 struct DummyService : public GenericSocketService {
91 ServiceDescriptionVector GetServiceDescription() {
92 return ServiceDescriptionVector();
94 void Event(const AcceptEvent &event) { (void)event; }
95 void Event(const WriteEvent &event) { (void)event; }
96 void Event(const ReadEvent &event) { (void)event; }
97 void Event(const CloseEvent &event) { (void)event; }
100 struct SignalService : public GenericSocketService {
101 int GetDescriptor() {
105 sigaddset(&mask, SIGTERM);
106 if (-1 == pthread_sigmask(SIG_BLOCK, &mask, NULL))
108 return signalfd(-1, &mask, 0);
111 ServiceDescriptionVector GetServiceDescription() {
112 return ServiceDescriptionVector();
115 void Event(const AcceptEvent &event) { (void)event; } // not supported
116 void Event(const WriteEvent &event) { (void)event; } // not supported
117 void Event(const CloseEvent &event) { (void)event; } // not supported
119 void Event(const ReadEvent &event) {
120 LogDebug("Get signal information");
122 if(sizeof(struct signalfd_siginfo) != event.rawBuffer.size()) {
123 LogError("Wrong size of signalfd_siginfo struct. Expected: "
124 << sizeof(signalfd_siginfo) << " Get: "
125 << event.rawBuffer.size());
129 signalfd_siginfo *siginfo = (signalfd_siginfo*)(&(event.rawBuffer[0]));
131 if (siginfo->ssi_signo == SIGTERM) {
132 LogInfo("Got signal: SIGTERM");
133 static_cast<SocketManager*>(m_serviceManager)->MainLoopStop();
137 LogInfo("This should not happend. Got signal: " << siginfo->ssi_signo);
141 SocketManager::SocketDescription&
142 SocketManager::CreateDefaultReadSocketDescription(int sock, bool timeout)
144 if ((int)m_socketDescriptionVector.size() <= sock)
145 m_socketDescriptionVector.resize(sock+20);
147 auto &desc = m_socketDescriptionVector[sock];
148 desc.isListen = false;
150 desc.interfaceID = 0;
152 desc.counter = ++m_counter;
155 desc.timeout = time(NULL) + SOCKET_TIMEOUT;
156 if (false == desc.isTimeout) {
158 tm.time = desc.timeout;
160 m_timeoutQueue.push(tm);
164 desc.isTimeout = timeout;
166 FD_SET(sock, &m_readSet);
167 m_maxDesc = sock > m_maxDesc ? sock : m_maxDesc;
171 SocketManager::SocketManager()
176 FD_ZERO(&m_writeSet);
177 if (-1 == pipe(m_notifyMe)) {
179 ThrowMsg(Exception::InitFailed, "Error in pipe: " << strerror(err));
181 LogInfo("Pipe: Read desc: " << m_notifyMe[0] << " Write desc: " << m_notifyMe[1]);
183 auto &desc = CreateDefaultReadSocketDescription(m_notifyMe[0], false);
184 desc.service = new DummyService;
186 // std::thread bases on pthread so this should work fine
189 sigaddset(&set, SIGPIPE);
190 pthread_sigmask(SIG_BLOCK, &set, NULL);
192 // add support for TERM signal (passed from systemd)
193 auto *signalService = new SignalService;
194 signalService->SetSocketManager(this);
195 int filefd = signalService->GetDescriptor();
197 LogError("Error in SignalService.GetDescriptor()");
198 delete signalService;
200 auto &desc2 = CreateDefaultReadSocketDescription(filefd, false);
201 desc2.service = signalService;
202 LogInfo("SignalService mounted on " << filefd << " descriptor");
206 SocketManager::~SocketManager() {
207 std::set<GenericSocketService*> serviceMap;
209 // Find all services. Set is used to remove duplicates.
210 // In this implementation, services are not able to react in any way.
211 for (size_t i=0; i < m_socketDescriptionVector.size(); ++i)
212 if (m_socketDescriptionVector[i].isOpen)
213 serviceMap.insert(m_socketDescriptionVector[i].service);
215 // Time to destroy all services.
216 for(auto it = serviceMap.begin(); it != serviceMap.end(); ++it) {
217 LogDebug("delete " << (void*)(*it));
221 for (size_t i = 0; i < m_socketDescriptionVector.size(); ++i)
222 if (m_socketDescriptionVector[i].isOpen)
225 // All socket except one were closed. Now pipe input must be closed.
226 close(m_notifyMe[1]);
229 void SocketManager::ReadyForAccept(int sock) {
230 struct sockaddr_un clientAddr;
231 unsigned int clientLen = sizeof(clientAddr);
232 int client = accept4(sock, (struct sockaddr*) &clientAddr, &clientLen, SOCK_NONBLOCK);
233 // LogInfo("Accept on sock: " << sock << " Socket opended: " << client);
236 LogDebug("Error in accept: " << strerror(err));
240 Credentials peerCred;
241 if (0 > getCredentialsFromSocket(client, peerCred)) {
242 LogDebug("Error in getCredentialsFromSocket. Socket closed.");
243 TEMP_FAILURE_RETRY(close(client));
247 auto &desc = CreateDefaultReadSocketDescription(client, true);
248 desc.interfaceID = m_socketDescriptionVector[sock].interfaceID;
249 desc.service = m_socketDescriptionVector[sock].service;
251 GenericSocketService::AcceptEvent event;
252 event.connectionID.sock = client;
253 event.connectionID.counter = desc.counter;
254 event.interfaceID = desc.interfaceID;
255 event.credentials = peerCred;
256 desc.service->Event(event);
259 void SocketManager::ReadyForRead(int sock) {
260 if (m_socketDescriptionVector[sock].isListen) {
261 ReadyForAccept(sock);
265 GenericSocketService::ReadEvent event;
266 event.connectionID.sock = sock;
267 event.connectionID.counter = m_socketDescriptionVector[sock].counter;
268 event.rawBuffer.resize(4096);
270 auto &desc = m_socketDescriptionVector[sock];
271 desc.timeout = time(NULL) + SOCKET_TIMEOUT;
273 ssize_t size = read(sock, &event.rawBuffer[0], 4096);
277 } else if (size >= 0) {
278 event.rawBuffer.resize(size);
279 desc.service->Event(event);
280 } else if (size == -1) {
287 LogDebug("Reading sock error: " << strerror(err));
293 void SocketManager::ReadyForWriteBuffer(int sock) {
294 auto &desc = m_socketDescriptionVector[sock];
295 size_t size = desc.rawBuffer.size();
296 ssize_t result = write(sock, &desc.rawBuffer[0], size);
302 // select will trigger write once again, nothing to do
306 LogDebug("Error during write: " << strerror(err));
310 return; // We do not want to propagate error to next layer
313 desc.rawBuffer.erase(desc.rawBuffer.begin(), desc.rawBuffer.begin()+result);
315 desc.timeout = time(NULL) + SOCKET_TIMEOUT;
317 if (desc.rawBuffer.empty())
318 FD_CLR(sock, &m_writeSet);
320 GenericSocketService::WriteEvent event;
321 event.connectionID.sock = sock;
322 event.connectionID.counter = desc.counter;
324 event.left = desc.rawBuffer.size();
326 desc.service->Event(event);
329 void SocketManager::ReadyForWrite(int sock) {
330 ReadyForWriteBuffer(sock);
333 void SocketManager::MainLoop() {
334 // remove evironment values passed by systemd
335 // uncomment it after removing old security-server code
338 // Daemon is ready to work.
339 sd_notify(0, "READY=1");
343 fd_set readSet = m_readSet;
344 fd_set writeSet = m_writeSet;
346 timeval localTempTimeout;
347 timeval *ptrTimeout = &localTempTimeout;
349 // I need to extract timeout from priority_queue.
350 // Timeout in priority_queue may be deprecated.
351 // I need to find some actual one.
352 while(!m_timeoutQueue.empty()) {
353 auto &top = m_timeoutQueue.top();
354 auto &desc = m_socketDescriptionVector[top.sock];
356 if (top.time == desc.timeout) {
357 // This timeout matches timeout from socket.
361 // This socket was used after timeout in priority queue was set up.
362 // We need to update timeout and find some useable one.
363 Timeout tm = { desc.timeout , top.sock};
364 m_timeoutQueue.pop();
365 m_timeoutQueue.push(tm);
369 if (m_timeoutQueue.empty()) {
370 LogDebug("No usaable timeout found.");
371 ptrTimeout = NULL; // select will wait without timeout
373 time_t currentTime = time(NULL);
374 auto &pqTimeout = m_timeoutQueue.top();
376 // 0 means that select won't block and socket will be closed ;-)
378 currentTime < pqTimeout.time ? pqTimeout.time - currentTime : 0;
379 ptrTimeout->tv_usec = 0;
380 // LogDebug("Set up timeout: " << (int)ptrTimeout->tv_sec
381 // << " seconds. Socket: " << pqTimeout.sock);
384 int ret = select(m_maxDesc+1, &readSet, &writeSet, NULL, ptrTimeout);
386 if (0 == ret) { // timeout
387 Assert(!m_timeoutQueue.empty());
389 Timeout pqTimeout = m_timeoutQueue.top();
390 m_timeoutQueue.pop();
392 auto &desc = m_socketDescriptionVector[pqTimeout.sock];
394 if (!desc.isTimeout || !desc.isOpen) {
395 // Connection was closed. Timeout is useless...
396 desc.isTimeout = false;
400 if (pqTimeout.time < desc.timeout) {
402 // This socket was used after timeout. We need to update timeout.
403 pqTimeout.time = desc.timeout;
404 m_timeoutQueue.push(pqTimeout);
408 // timeout from m_timeoutQueue matches with socket.timeout
409 // and connection is open. Time to close it!
410 // Putting new timeout in queue here is pointless.
411 desc.isTimeout = false;
412 CloseSocket(pqTimeout.sock);
414 // All done. Now we should process next select ;-)
421 LogDebug("EINTR in select");
425 LogError("Error in select: " << strerror(err));
430 for(int i = 0; i<m_maxDesc+1 && ret; ++i) {
431 if (FD_ISSET(i, &readSet)) {
435 if (FD_ISSET(i, &writeSet)) {
444 void SocketManager::MainLoopStop()
450 int SocketManager::GetSocketFromSystemD(
451 const GenericSocketService::ServiceDescription &desc)
455 // TODO optimalization - do it once in object constructor
456 // and remember all information path->sockfd
457 int n = sd_listen_fds(0);
459 LogInfo("sd_listen_fds returns: " << n);
462 LogError("Error in sd_listend_fds");
463 ThrowMsg(Exception::InitFailed, "Error in sd_listend_fds");
466 for(fd = SD_LISTEN_FDS_START; fd < SD_LISTEN_FDS_START+n; ++fd) {
467 if (0 < sd_is_socket_unix(fd, SOCK_STREAM, 1,
468 desc.serviceHandlerPath.c_str(), 0))
470 LogInfo("Useable socket " << desc.serviceHandlerPath <<
471 " was passed by SystemD under descriptor " << fd);
475 LogError("No useable sockets were passed by systemd.");
479 int SocketManager::CreateDomainSocketHelp(
480 const GenericSocketService::ServiceDescription &desc)
484 if (-1 == (sockfd = socket(AF_UNIX, SOCK_STREAM, 0))) {
486 LogError("Error in socket: " << strerror(err));
487 ThrowMsg(Exception::InitFailed, "Error in socket: " << strerror(err));
491 LogInfo("Set up smack label: " << desc.smackLabel);
493 if (0 != smack_fsetlabel(sockfd, desc.smackLabel.c_str(), SMACK_LABEL_IPIN)) {
494 LogError("Error in smack_fsetlabel");
495 ThrowMsg(Exception::InitFailed, "Error in smack_fsetlabel");
498 LogInfo("No smack on platform. Socket won't be securied with smack label!");
502 if (-1 == (flags = fcntl(sockfd, F_GETFL, 0)))
505 if (-1 == fcntl(sockfd, F_SETFL, flags | O_NONBLOCK)) {
508 LogError("Error in fcntl: " << strerror(err));
509 ThrowMsg(Exception::InitFailed, "Error in fcntl: " << strerror(err));
512 sockaddr_un serverAddress;
513 memset(&serverAddress, 0, sizeof(serverAddress));
514 serverAddress.sun_family = AF_UNIX;
515 strcpy(serverAddress.sun_path, desc.serviceHandlerPath.c_str());
516 unlink(serverAddress.sun_path);
518 mode_t originalUmask;
519 originalUmask = umask(0);
521 if (-1 == bind(sockfd, (struct sockaddr*)&serverAddress, sizeof(serverAddress))) {
524 LogError("Error in bind: " << strerror(err));
525 ThrowMsg(Exception::InitFailed, "Error in bind: " << strerror(err));
528 umask(originalUmask);
530 if (-1 == listen(sockfd, 5)) {
533 LogError("Error in listen: " << strerror(err));
534 ThrowMsg(Exception::InitFailed, "Error in listen: " << strerror(err));
540 void SocketManager::CreateDomainSocket(
541 GenericSocketService *service,
542 const GenericSocketService::ServiceDescription &desc)
544 int sockfd = GetSocketFromSystemD(desc);
546 sockfd = CreateDomainSocketHelp(desc);
548 auto &description = CreateDefaultReadSocketDescription(sockfd, false);
550 description.isListen = true;
551 description.interfaceID = desc.interfaceID;
552 description.service = service;
554 LogDebug("Listen on socket: " << sockfd <<
555 " Handler: " << desc.serviceHandlerPath.c_str());
558 void SocketManager::RegisterSocketService(GenericSocketService *service) {
559 service->SetSocketManager(this);
560 auto serviceVector = service->GetServiceDescription();
562 for (auto iter = serviceVector.begin(); iter != serviceVector.end(); ++iter)
563 CreateDomainSocket(service, *iter);
564 } Catch (Exception::Base) {
565 for (int i =0; i < (int)m_socketDescriptionVector.size(); ++i)
567 auto &desc = m_socketDescriptionVector[i];
568 if (desc.service == service && desc.isOpen) {
573 ReThrow(Exception::Base);
577 void SocketManager::Close(ConnectionID connectionID) {
579 std::lock_guard<std::mutex> ulock(m_eventQueueMutex);
580 m_closeQueue.push(connectionID);
585 void SocketManager::Write(ConnectionID connectionID, const RawBuffer &rawBuffer) {
587 buffer.connectionID = connectionID;
588 buffer.rawBuffer = rawBuffer;
590 std::lock_guard<std::mutex> ulock(m_eventQueueMutex);
591 m_writeBufferQueue.push(buffer);
596 void SocketManager::NotifyMe() {
597 TEMP_FAILURE_RETRY(write(m_notifyMe[1], "You have message ;-)", 1));
600 void SocketManager::ProcessQueue() {
603 std::lock_guard<std::mutex> ulock(m_eventQueueMutex);
604 while (!m_writeBufferQueue.empty()) {
605 buffer = m_writeBufferQueue.front();
606 m_writeBufferQueue.pop();
608 auto &desc = m_socketDescriptionVector[buffer.connectionID.sock];
611 LogDebug("Received packet for write but connection is closed. Packet ignored!");
615 if (desc.counter != buffer.connectionID.counter)
617 LogDebug("Received packet for write but counter is broken. Packet ignored!");
622 buffer.rawBuffer.begin(),
623 buffer.rawBuffer.end(),
624 std::back_inserter(desc.rawBuffer));
626 FD_SET(buffer.connectionID.sock, &m_writeSet);
632 ConnectionID connection;
634 std::lock_guard<std::mutex> ulock(m_eventQueueMutex);
635 if (m_closeQueue.empty())
637 connection = m_closeQueue.front();
641 if (!m_socketDescriptionVector[connection.sock].isOpen)
644 if (connection.counter != m_socketDescriptionVector[connection.sock].counter)
647 CloseSocket(connection.sock);
651 void SocketManager::CloseSocket(int sock) {
652 // LogInfo("Closing socket: " << sock);
653 auto &desc = m_socketDescriptionVector[sock];
655 if (!(desc.isOpen)) {
656 // This may happend when some information was waiting for write to the
657 // socket and in the same time socket was closed by the client.
658 LogError("Socket " << sock << " is not open. Nothing to do!");
662 GenericSocketService::CloseEvent event;
663 event.connectionID.sock = sock;
664 event.connectionID.counter = desc.counter;
665 auto service = desc.service;
669 desc.interfaceID = -1;
670 desc.rawBuffer.clear();
673 service->Event(event);
675 LogError("Critical! Service is NULL! This should never happend!");
677 TEMP_FAILURE_RETRY(close(sock));
678 FD_CLR(sock, &m_readSet);
679 FD_CLR(sock, &m_writeSet);