2 // Open Service Platform
3 // Copyright (c) 2012 Samsung Electronics Co., Ltd.
5 // Licensed under the Apache License, Version 2.0 (the License);
6 // you may not use this file except in compliance with the License.
7 // You may obtain a copy of the License at
9 // http://www.apache.org/licenses/LICENSE-2.0
11 // Unless required by applicable law or agreed to in writing, software
12 // distributed under the License is distributed on an "AS IS" BASIS,
13 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 // See the License for the specific language governing permissions and
15 // limitations under the License.
19 * @file FIo_IpcServer.cpp
20 * @brief This is the implementation file for the IpcServer class.
32 #include <sys/types.h>
33 #include <sys/socket.h>
37 #include <sys/smack.h>
39 #include <ipc/ipc_message.h>
41 #include <app_manager.h>
43 #include <FBaseRtMutex.h>
44 #include <FBaseSysLog.h>
45 #include <FBase_StringConverter.h>
46 #include <FBaseRt_EventDispatcher.h>
48 #include "IIpcServerEventListener.h"
49 #include "IpcServer.h"
54 using namespace Tizen::Base;
55 using namespace Tizen::Base::Runtime;
56 using namespace Tizen::App;
58 IpcServer::_ChannelInfo::_ChannelInfo(void)
67 IpcServer::_ChannelInfo::~_ChannelInfo(void)
69 if (pGIOChannel != null)
71 g_io_channel_unref(pGIOChannel);
78 g_source_destroy(pGSource);
81 g_source_unref(pGSource);
85 IpcServer::_ClientInfo::_ClientInfo(void)
88 , pReverseChannel(null)
93 IpcServer::_ClientInfo::~_ClientInfo(void)
95 if (pReverseChannel != null)
97 g_io_channel_unref(pReverseChannel);
103 IpcServer::IpcServer(void)
104 : __runOnCallerThread(false)
105 , __pEventDispatcher(null)
108 , __pHandlerGMainContext(null)
109 , __pHandlerGMainLoop(null)
110 , __pConnectGSource(null)
111 , __pCurrentChannel(null)
112 , __pCurrentClientInfo(null)
114 __messageBuffer[0] = '\0';
118 IpcServer::~IpcServer(void)
120 if (__pConnectGSource != null)
122 g_source_destroy(__pConnectGSource);
123 g_source_unref(__pConnectGSource);
124 __pConnectGSource = null;
127 if (!__runOnCallerThread)
129 if (__pEventDispatcher)
131 delete __pEventDispatcher;
132 __pEventDispatcher = null;
135 if (__pHandlerGMainLoop)
137 g_main_loop_unref(__pHandlerGMainLoop);
138 __pHandlerGMainLoop = null;
141 if (__pHandlerGMainContext)
143 g_main_context_unref(__pHandlerGMainContext);
144 __pHandlerGMainContext = null;
153 IpcServer::Construct(const String& name, const IIpcServerEventListener& listener, bool runOnCallerThread)
155 result r = E_SUCCESS;
157 GIOChannel* pGIOChannel = null;
158 GSource* pGSource = null;
160 struct sockaddr_un serverAddress;
161 int serverSocket = -1;
164 std::string socketName;
166 size_t socketNameLength = 0;
169 __pListener = const_cast <IIpcServerEventListener*>(&listener);
170 __runOnCallerThread = runOnCallerThread;
172 pName = _StringConverter::CopyToCharArrayN(name);
173 SysTryReturnResult(NID_IO, pName != null, E_OUT_OF_MEMORY, "Not enough memory");
175 socketName.append("/tmp/");
176 socketName.append(pName);
180 socketNameLength = socketName.size() + 1;
181 SysTryReturnResult(NID_IO, socketNameLength < 108, E_INVALID_ARG, "Server name is too long");
183 if (!__runOnCallerThread)
185 __pHandlerGMainContext = g_main_context_new();
186 __pHandlerGMainLoop = g_main_loop_new(__pHandlerGMainContext, FALSE);
191 __pHandlerGMainContext = g_main_context_get_thread_default();
192 if (__pHandlerGMainContext == null) // is global?
194 __pHandlerGMainContext = g_main_context_default();
195 if (__pHandlerGMainContext == null)
202 ret = unlink(socketName.c_str());
203 SysTryLog(NID_IO, ret == 0, "Unlink a socket has failed.. but it is not a problem.");
205 serverSocket = socket(AF_UNIX, SOCK_STREAM, 0);
206 SysTryReturnResult(NID_IO, serverSocket != -1, E_SYSTEM, "Failed to create a socket.");
208 // SMACK (Add a * label to socket)
209 if(smack_fsetlabel(serverSocket, "@", SMACK_LABEL_IPOUT) != 0)
211 SysTryCatch(NID_IO, errno == EOPNOTSUPP, r = E_SYSTEM, E_SYSTEM, "[E_SYSTEM] SMACK labeling failed");
212 SysLog(NID_IO, "Kernel doesn't have Smack.");
215 if(smack_fsetlabel(serverSocket, "*", SMACK_LABEL_IPIN) != 0)
217 SysTryCatch(NID_IO, errno == EOPNOTSUPP, r = E_SYSTEM, E_SYSTEM, "[E_SYSTEM] SMACK labeling failed");
218 SysLog(NID_IO, "Kernel doesn't have Smack.");
221 bzero(&serverAddress, sizeof(serverAddress));
222 serverAddress.sun_family = AF_UNIX;
223 strncpy(serverAddress.sun_path, socketName.c_str(), socketNameLength);
224 serverLen = sizeof(serverAddress);
226 ret = bind(serverSocket, (const struct sockaddr*) &serverAddress, serverLen);
227 SysTryCatch(NID_IO, ret != -1, r = E_SYSTEM, E_SYSTEM, "[E_SYSTEM] Failed to bind a socket(%d, %s): %s", serverSocket,
228 socketName.c_str(), strerror(errno));
230 ret = chmod(socketName.c_str(), 0666);
231 SysTryCatch(NID_IO, ret == 0, r = E_SYSTEM, E_SYSTEM, "[E_SYSTEM] Failed to change permission of a socket(%d, %s): %s", serverSocket,
232 socketName.c_str(), strerror(errno));
234 ret = listen(serverSocket, 128);
235 SysTryCatch(NID_IO, ret == 0, r = E_SYSTEM, E_SYSTEM, "[E_SYSTEM] Failed to listen a socket(%d, %s): %s", serverSocket,
236 socketName.c_str(), strerror(errno));
238 pGIOChannel = g_io_channel_unix_new(serverSocket);
239 SysTryCatch(NID_IO, pGIOChannel != null, , E_OUT_OF_MEMORY, "[E_OUT_OF_MEMORY] Not enough memory.");
241 // socket will be closed when pGIOChannel is deleted.
242 g_io_channel_set_close_on_unref(pGIOChannel, TRUE);
245 pGSource = g_io_create_watch(pGIOChannel, (GIOCondition) (G_IO_IN | G_IO_ERR | G_IO_NVAL | G_IO_HUP));
246 SysTryCatch(NID_IO, pGSource != null, r = E_OUT_OF_MEMORY, E_OUT_OF_MEMORY,
247 "[E_OUT_OF_MEMORY] Failed to create watch for socket.");
249 // channel will be delete when pGSource is deleted.
250 g_io_channel_unref(pGIOChannel);
253 g_source_set_callback(pGSource, (GSourceFunc) OnConnectionRequest, this, NULL);
254 g_source_attach(pGSource, __pHandlerGMainContext);
256 if (__runOnCallerThread)
258 __pListener->OnIpcServerStarted(*this);
262 ret = pthread_create(&__handlerThread, null, &ThreadProc, (void*) this);
263 SysTryCatch(NID_IO, ret == 0, r = E_SYSTEM, E_SYSTEM, "[E_SYSTEM] Failed to an IPC thread");
266 __pConnectGSource = pGSource;
271 if (pGIOChannel != null)
273 g_io_channel_unref(pGIOChannel);
276 if (serverSocket != -1)
281 if (runOnCallerThread && __pHandlerGMainContext)
283 g_main_context_unref(__pHandlerGMainContext);
284 __pHandlerGMainContext = null;
293 int reverse; // if the connection is for reverse message
297 IpcServer::OnConnectionRequest(GIOChannel* source, GIOCondition condition, gpointer data)
299 IpcServer* pIpcServer = (IpcServer*) data;
300 GError* pGError = null;
301 HelloMessage helloMessage;
302 _ClientInfo* pClientInfo = null;
303 _ChannelInfo* pChannelInfo = null;
304 GSource* pGSource = null;
305 GIOChannel* pChannel = null;
306 ssize_t readBytes = 0;
310 struct sockaddr_un clientAddress;
311 socklen_t clientLen = sizeof(clientAddress);
313 SysAssertf(pIpcServer != null, "Not yet constructed. Construct() should be called before use.\n");
314 SysAssertf(pIpcServer->__pListener != null, "Listener is null.\n");
316 server = g_io_channel_unix_get_fd(source);
318 client = accept(server, (struct sockaddr*) &clientAddress, &clientLen);
319 SysTryCatch(NID_IO, client != -1, , E_SYSTEM, "[E_SYSTEM] Accept failed.");
321 readBytes = read(client, &helloMessage, sizeof(helloMessage));
322 SysTryCatch(NID_IO, readBytes >= 0, , E_SYSTEM, "[E_SYSTEM] Failed to receive hello message (%d, %s).",
323 errno, strerror(errno));
325 pChannel = g_io_channel_unix_new(client);
326 SysTryCatch(NID_IO, pChannel != null, , E_OUT_OF_MEMORY, "[E_OUT_OF_MEMORY] Not enough memory.");
328 g_io_channel_set_encoding(pChannel, NULL, &pGError);
329 g_io_channel_set_flags(pChannel, G_IO_FLAG_NONBLOCK, &pGError);
331 g_io_channel_set_close_on_unref(pChannel, TRUE);
334 pClientInfo = pIpcServer->__clients[helloMessage.pid];
335 if (pClientInfo == null) // first connection request from this client
337 pClientInfo = new (std::nothrow) _ClientInfo;
338 SysTryCatch(NID_IO, pClientInfo != null, , E_OUT_OF_MEMORY, "[E_OUT_OF_MEMORY] Not enough memory.");
340 pClientInfo->pIpcServer = pIpcServer;
341 pClientInfo->clientId = helloMessage.pid;
344 int ret = app_manager_get_app_id(helloMessage.pid, &pAppId);
345 SysTryCatch(NID_IO, ret >= 0, delete pClientInfo, E_SYSTEM, "[E_SYSTEM] Failed to get_app_id: %d", ret);
347 pClientInfo->appId = pAppId;
350 pClientInfo->pReverseChannel = null;
352 pIpcServer->__clients[helloMessage.pid] = pClientInfo;
353 pIpcServer->__pCurrentClientInfo = pClientInfo;
354 pIpcServer->__pListener->OnIpcClientConnected(*pIpcServer, helloMessage.pid);
355 pIpcServer->__pCurrentClientInfo = null;
358 if (helloMessage.reverse != 0)
360 pClientInfo->pReverseChannel = pChannel;
364 pChannelInfo = new (std::nothrow) _ChannelInfo;
365 SysTryCatch(NID_IO, pChannelInfo != null, , E_OUT_OF_MEMORY, "[E_OUT_OF_MEMORY] Not enough memory.");
367 pGSource = g_io_create_watch(pChannel, (GIOCondition) (G_IO_IN | G_IO_ERR | G_IO_NVAL | G_IO_HUP));
368 g_source_set_callback(pGSource, (GSourceFunc) OnReadMessage, pChannelInfo, NULL);
369 g_source_attach(pGSource, pIpcServer->__pHandlerGMainContext);
371 pChannelInfo->pClientInfo = pClientInfo;
372 pChannelInfo->pGIOChannel = pChannel;
373 pChannelInfo->pGSource = pGSource;
375 pClientInfo->channels.push_back(pChannelInfo);
381 if (pChannel != null)
383 g_io_channel_unref(pChannel);
395 IpcServer::GetClientId(void) const
397 if (__pCurrentClientInfo)
399 return __pCurrentClientInfo->clientId;
406 IpcServer::GetClientApplicationId(void) const
408 static String nullString;
410 if (__pCurrentClientInfo)
412 return __pCurrentClientInfo->appId;
419 IpcServer::HandleReceivedMessage(GIOChannel* source, GIOCondition condition, gpointer data)
421 GError* pGError = NULL;
423 IPC::Message* pMessage = NULL;
424 _ChannelInfo* pChannelInfo = (_ChannelInfo*) data;
425 _ClientInfo* pClientInfo = pChannelInfo->pClientInfo;
427 if (condition & G_IO_HUP)
429 SysLog(NID_IO, "Connection closed");
430 int clientId = pClientInfo->clientId;
432 g_io_channel_shutdown(source, FALSE, &pGError);
434 for (unsigned int i = 0; i < pClientInfo->channels.size(); i++)
436 if (pChannelInfo == pClientInfo->channels[i])
438 pClientInfo->channels.erase(pClientInfo->channels.begin() + i);
440 // Do not destroy a source in a dispatch callback
441 // because main loop will do it if the callback return FALSE.
442 pChannelInfo->destroySource = false;
449 if (pClientInfo->channels.size() == 0)
451 SysLog(NID_IO, "All connections of client(%d) are closed. delete client info", clientId);
453 __pListener->OnIpcClientDisconnected(*this, clientId);
455 __clients[clientId] = null;
462 else if (condition & G_IO_IN)
465 const char* pStart = NULL;
466 const char* pEnd = NULL;
467 const char* pEndOfMessage = NULL;
472 status = g_io_channel_read_chars(source, (char*) __messageBuffer, __MAX_MESSAGE_BUFFER_SIZE, &readSize, &pGError);
473 if (status != G_IO_STATUS_NORMAL)
475 if (status == G_IO_STATUS_EOF || status == G_IO_STATUS_ERROR)
477 if (status == G_IO_STATUS_EOF)
479 SysLog(NID_IO, "G_IO_STATUS_EOF, the connection is closed.");
483 SysLog(NID_IO, "G_IO_STATUS_ERROR, the connection is closed. ");
487 g_io_channel_shutdown(source, FALSE, &pGError);
489 int clientId = pClientInfo->clientId;
491 for (unsigned int i = 0; i < pClientInfo->channels.size(); i++)
493 if (pChannelInfo == pClientInfo->channels[i])
495 pClientInfo->channels.erase(pClientInfo->channels.begin() + i);
497 pChannelInfo->destroySource = false;
503 if (pClientInfo->channels.size() == 0)
505 SysLog(NID_IO, "All connections of client(%d) are closed normally by the client.", clientId);
509 __pListener->OnIpcClientDisconnected(*this, clientId);
512 __clients[clientId] = null;
526 if (__pending.empty())
528 pStart = __messageBuffer;
529 pEnd = pStart + readSize;
533 __pending.append(__messageBuffer, readSize);
534 pStart = __pending.data();
535 pEnd = pStart + __pending.size();
540 pEndOfMessage = IPC::Message::FindNext(pStart, pEnd);
541 if (pEndOfMessage == NULL)
543 __pending.assign(pStart, pEnd - pStart);
547 pMessage = new (std::nothrow) IPC::Message(pStart, pEndOfMessage - pStart);
548 SysTryReturn(NID_IO, pMessage != null, FALSE, E_OUT_OF_MEMORY, "[E_OUT_OF_MEMORY] The memory is insufficient.");
550 __pCurrentChannel = source;
554 __pListener->OnIpcRequestReceived(*this, *pMessage);
559 __pCurrentChannel = NULL;
561 pStart = pEndOfMessage;
574 IpcServer::OnReadMessage(GIOChannel* source, GIOCondition condition, gpointer data)
576 gboolean ret = FALSE;
577 _ChannelInfo* pChannelInfo = (_ChannelInfo*) data;
578 _ClientInfo* pClientInfo = pChannelInfo->pClientInfo;
579 IpcServer* pIpcServer = (IpcServer*) pClientInfo->pIpcServer;
581 pIpcServer->__pCurrentClientInfo = pClientInfo;
582 ret = pIpcServer->HandleReceivedMessage(source, condition, data);
583 pIpcServer->__pCurrentClientInfo = null;
589 IpcServer::ThreadProc(void* pParam)
591 IpcServer* pIpcServer = (IpcServer*) pParam;
592 if (pIpcServer != NULL)
594 pIpcServer->Run(NULL);
601 IpcServer::Run(void* pParam)
603 result r = E_SUCCESS;
605 if (__pListener == null)
610 __pEventDispatcher = new (std::nothrow) _EventDispatcher;
611 SysTryReturnVoidResult(NID_IO, __pEventDispatcher != null, E_OUT_OF_MEMORY, "[E_OUT_OF_MEMORY] The memory is insufficient.");
613 r = __pEventDispatcher->Construct(__pHandlerGMainContext);
616 delete __pEventDispatcher;
617 __pEventDispatcher = null;
620 __pListener->OnIpcServerStarted(*this);
622 g_main_loop_run(__pHandlerGMainLoop);
624 __pListener->OnIpcServerStopped(*this);
628 IpcServer::Start(void)
634 IpcServer::GetName(void) const
640 IpcServer::Stop(void)
642 result r = E_SUCCESS;
645 SysTryReturnResult(NID_IO, __pListener != null, E_SYSTEM, "Listener is null.");
647 if (!__runOnCallerThread)
649 pthread_t self = pthread_self();
651 if (__pHandlerGMainLoop)
653 g_main_loop_quit(__pHandlerGMainLoop);
656 if (__handlerThread != self)
658 ret = pthread_join(__handlerThread, null);
659 SysTryLog(NID_IO, ret == 0, "Join an IPC thread returns an error");
664 __pListener->OnIpcServerStopped(*this);
671 IpcServer::Send(IPC::Message* msg)
676 GError* pGError = NULL;
679 pData = (char*) msg->data();
680 remain = msg->size();
687 g_io_channel_write_chars(__pCurrentChannel, (char*) pData, remain, &written, &pGError);
693 g_io_channel_flush(__pCurrentChannel, &pGError);
706 IpcServer::SendResponse(int client, IPC::Message* pMessage)
708 result r = E_SUCCESS;
712 GError* pGError = null;
713 _ClientInfo* pClientInfo = null;
716 SysTryReturn(NID_IO, client >= 0 && pMessage != null, false, E_INVALID_ARG,
717 "[E_INVALID_ARG] pMessage(0x%x) is null or clinet(%d) < 0", pMessage,
719 SysTryCatch(NID_IO, !pMessage->is_sync(), r = E_INVALID_ARG, E_INVALID_ARG, "[E_INVALID_ARG] Can't send sync. messagee.");
721 pClientInfo = __clients[client];
722 SysTryCatch(NID_IO, pClientInfo != null, r = E_INVALID_ARG, E_INVALID_ARG,
723 "[E_INVALID_ARG] client(%d) has not been registered.",
726 pData = (char*) pMessage->data();
727 remain = pMessage->size();
732 ret = g_io_channel_write_chars(pClientInfo->pReverseChannel, (char*) pData, remain, &written, &pGError);
733 if (ret != G_IO_STATUS_NORMAL)
735 SysLog(NID_IO, "Failed to send a response: %d", ret);
736 SysTryCatch(NID_IO, ret != G_IO_STATUS_ERROR, , E_SYSTEM, "[E_SYSTEM] Error occurred during writing message to socket.");
743 g_io_channel_flush(pClientInfo->pReverseChannel, &pGError);
755 IpcServer::SendResponse(int client, const IPC::Message& message)
757 result r = E_SUCCESS;
761 GError* pGError = null;
762 _ClientInfo* pClientInfo = null;
765 SysTryReturn(NID_IO, client >= 0, false, E_INVALID_ARG, "[E_INVALID_ARG] clinet(%d) < 0", client);
766 SysTryCatch(NID_IO, !message.is_sync(), r = E_INVALID_ARG, E_INVALID_ARG, "[E_INVALID_ARG] Can't send sync. messagee.");
768 pClientInfo = __clients[client];
769 SysTryCatch(NID_IO, pClientInfo != null, r = E_INVALID_ARG, E_INVALID_ARG,
770 "[E_INVALID_ARG] client(%d) has not been registered.",
773 pData = (char*) message.data();
774 remain = message.size();
779 ret = g_io_channel_write_chars(pClientInfo->pReverseChannel, (char*) pData, remain, &written, &pGError);
780 if (ret != G_IO_STATUS_NORMAL)
782 SysLog(NID_IO, "Failed to send a response: %d", ret);
783 SysTryCatch(NID_IO, ret != G_IO_STATUS_ERROR, , E_SYSTEM, "[E_SYSTEM] Error occurred during writing message to socket.");
790 g_io_channel_flush(pClientInfo->pReverseChannel, &pGError);