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, 15);
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 bool reverse; // true 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;
309 struct sockaddr_un clientAddress;
310 socklen_t clientLen = sizeof(clientAddress);
312 SysAssertf(pIpcServer != null, "Not yet constructed. Construct() should be called before use.\n");
313 SysAssertf(pIpcServer->__pListener != null, "Listener is null.\n");
315 server = g_io_channel_unix_get_fd(source);
317 client = accept(server, (struct sockaddr*) &clientAddress, &clientLen);
318 SysTryCatch(NID_IO, client != -1, , E_SYSTEM, "[E_SYSTEM] Accept failed.");
320 read(client, &helloMessage, sizeof(helloMessage));
322 pChannel = g_io_channel_unix_new(client);
323 SysTryCatch(NID_IO, pChannel != null, , E_OUT_OF_MEMORY, "[E_OUT_OF_MEMORY] Not enough memory.");
325 g_io_channel_set_encoding(pChannel, NULL, &pGError);
326 g_io_channel_set_flags(pChannel, G_IO_FLAG_NONBLOCK, &pGError);
328 g_io_channel_set_close_on_unref(pChannel, TRUE);
331 pClientInfo = pIpcServer->__clients[helloMessage.pid];
332 if (pClientInfo == null) // first connection request from this client
334 pClientInfo = new (std::nothrow) _ClientInfo;
335 SysTryCatch(NID_IO, pClientInfo != null, , E_OUT_OF_MEMORY, "[E_OUT_OF_MEMORY] Not enough memory.");
337 pClientInfo->pIpcServer = pIpcServer;
338 pClientInfo->clientId = helloMessage.pid;
341 int ret = app_manager_get_app_id(helloMessage.pid, &pAppId);
342 SysTryCatch(NID_IO, ret >= 0, delete pClientInfo, E_SYSTEM, "[E_SYSTEM] Failed to get_app_id: %d", ret);
344 pClientInfo->appId = pAppId;
347 pClientInfo->pReverseChannel = null;
349 pIpcServer->__clients[helloMessage.pid] = pClientInfo;
350 pIpcServer->__pCurrentClientInfo = pClientInfo;
351 pIpcServer->__pListener->OnIpcClientConnected(*pIpcServer, helloMessage.pid);
352 pIpcServer->__pCurrentClientInfo = null;
355 if (helloMessage.reverse)
357 pClientInfo->pReverseChannel = pChannel;
361 pChannelInfo = new (std::nothrow) _ChannelInfo;
362 SysTryCatch(NID_IO, pChannelInfo != null, , E_OUT_OF_MEMORY, "[E_OUT_OF_MEMORY] Not enough memory.");
364 pGSource = g_io_create_watch(pChannel, (GIOCondition) (G_IO_IN | G_IO_ERR | G_IO_NVAL | G_IO_HUP));
365 g_source_set_callback(pGSource, (GSourceFunc) OnReadMessage, pChannelInfo, NULL);
366 g_source_attach(pGSource, pIpcServer->__pHandlerGMainContext);
368 pChannelInfo->pClientInfo = pClientInfo;
369 pChannelInfo->pGIOChannel = pChannel;
370 pChannelInfo->pGSource = pGSource;
372 pClientInfo->channels.push_back(pChannelInfo);
378 if (pChannel != null)
380 g_io_channel_unref(pChannel);
392 IpcServer::GetClientId(void) const
394 if (__pCurrentClientInfo)
396 return __pCurrentClientInfo->clientId;
403 IpcServer::GetClientApplicationId(void) const
405 static String nullString;
407 if (__pCurrentClientInfo)
409 return __pCurrentClientInfo->appId;
416 IpcServer::HandleReceivedMessage(GIOChannel* source, GIOCondition condition, gpointer data)
418 GError* pGError = NULL;
420 IPC::Message* pMessage = NULL;
421 _ChannelInfo* pChannelInfo = (_ChannelInfo*) data;
422 _ClientInfo* pClientInfo = pChannelInfo->pClientInfo;
424 if (condition & G_IO_HUP)
426 SysLog(NID_IO, "Connection closed");
427 int clientId = pClientInfo->clientId;
429 g_io_channel_shutdown(source, FALSE, &pGError);
431 for (unsigned int i = 0; i < pClientInfo->channels.size(); i++)
433 if (pChannelInfo == pClientInfo->channels[i])
435 pClientInfo->channels.erase(pClientInfo->channels.begin() + i);
437 // Do not destroy a source in a dispatch callback
438 // because main loop will do it if the callback return FALSE.
439 pChannelInfo->destroySource = false;
446 if (pClientInfo->channels.size() == 0)
448 SysLog(NID_IO, "All connections of client(%d) are closed. delete client info", clientId);
450 __pListener->OnIpcClientDisconnected(*this, clientId);
452 __clients[clientId] = null;
459 else if (condition & G_IO_IN)
462 const char* pStart = NULL;
463 const char* pEnd = NULL;
464 const char* pEndOfMessage = NULL;
469 status = g_io_channel_read_chars(source, (char*) __messageBuffer, __MAX_MESSAGE_BUFFER_SIZE, &readSize, &pGError);
470 if (status != G_IO_STATUS_NORMAL)
472 if (status == G_IO_STATUS_EOF || status == G_IO_STATUS_ERROR)
474 if (status == G_IO_STATUS_EOF)
476 SysLog(NID_IO, "G_IO_STATUS_EOF, the connection is closed.");
480 SysLog(NID_IO, "G_IO_STATUS_ERROR, the connection is closed. ");
484 g_io_channel_shutdown(source, FALSE, &pGError);
486 int clientId = pClientInfo->clientId;
488 for (unsigned int i = 0; i < pClientInfo->channels.size(); i++)
490 if (pChannelInfo == pClientInfo->channels[i])
492 pClientInfo->channels.erase(pClientInfo->channels.begin() + i);
494 pChannelInfo->destroySource = false;
500 if (pClientInfo->channels.size() == 0)
502 SysLog(NID_IO, "All connections of client(%d) are closed normally by the client.", clientId);
506 __pListener->OnIpcClientDisconnected(*this, clientId);
509 __clients[clientId] = null;
523 if (__pending.empty())
525 pStart = __messageBuffer;
526 pEnd = pStart + readSize;
530 __pending.append(__messageBuffer, readSize);
531 pStart = __pending.data();
532 pEnd = pStart + __pending.size();
537 pEndOfMessage = IPC::Message::FindNext(pStart, pEnd);
538 if (pEndOfMessage == NULL)
540 __pending.assign(pStart, pEnd - pStart);
544 pMessage = new (std::nothrow) IPC::Message(pStart, pEndOfMessage - pStart);
545 SysTryReturn(NID_IO, pMessage != null, FALSE, E_OUT_OF_MEMORY, "[E_OUT_OF_MEMORY] The memory is insufficient.");
547 __pCurrentChannel = source;
551 __pListener->OnIpcRequestReceived(*this, *pMessage);
556 __pCurrentChannel = NULL;
558 pStart = pEndOfMessage;
571 IpcServer::OnReadMessage(GIOChannel* source, GIOCondition condition, gpointer data)
573 gboolean ret = FALSE;
574 _ChannelInfo* pChannelInfo = (_ChannelInfo*) data;
575 _ClientInfo* pClientInfo = pChannelInfo->pClientInfo;
576 IpcServer* pIpcServer = (IpcServer*) pClientInfo->pIpcServer;
578 pIpcServer->__pCurrentClientInfo = pClientInfo;
579 ret = pIpcServer->HandleReceivedMessage(source, condition, data);
580 pIpcServer->__pCurrentClientInfo = null;
586 IpcServer::ThreadProc(void* pParam)
588 IpcServer* pIpcServer = (IpcServer*) pParam;
589 if (pIpcServer != NULL)
591 pIpcServer->Run(NULL);
598 IpcServer::Run(void* pParam)
600 result r = E_SUCCESS;
602 if (__pListener == null)
607 __pEventDispatcher = new (std::nothrow) _EventDispatcher;
608 SysTryReturnVoidResult(NID_IO, __pEventDispatcher != null, E_OUT_OF_MEMORY, "[E_OUT_OF_MEMORY] The memory is insufficient.");
610 r = __pEventDispatcher->Construct(__pHandlerGMainContext);
613 delete __pEventDispatcher;
614 __pEventDispatcher = null;
617 __pListener->OnIpcServerStarted(*this);
619 g_main_loop_run(__pHandlerGMainLoop);
621 __pListener->OnIpcServerStopped(*this);
625 IpcServer::Start(void)
631 IpcServer::GetName(void) const
637 IpcServer::Stop(void)
639 result r = E_SUCCESS;
642 SysTryReturnResult(NID_IO, __pListener != null, E_SYSTEM, "Listener is null.");
644 if (!__runOnCallerThread)
646 pthread_t self = pthread_self();
648 if (__pHandlerGMainLoop)
650 g_main_loop_quit(__pHandlerGMainLoop);
653 if (__handlerThread != self)
655 ret = pthread_join(__handlerThread, null);
656 SysTryLog(NID_IO, ret == 0, "Join an IPC thread returns an error");
661 __pListener->OnIpcServerStopped(*this);
668 IpcServer::Send(IPC::Message* msg)
673 GError* pGError = NULL;
676 pData = (char*) msg->data();
677 remain = msg->size();
684 g_io_channel_write_chars(__pCurrentChannel, (char*) pData, remain, &written, &pGError);
690 g_io_channel_flush(__pCurrentChannel, &pGError);
701 IpcServer::SendResponse(int client, IPC::Message* pMessage)
703 result r = E_SUCCESS;
707 GError* pGError = null;
708 _ClientInfo* pClientInfo = null;
710 SysTryReturn(NID_IO, client >= 0 && pMessage != null, false, E_INVALID_ARG,
711 "[E_INVALID_ARG] pMessage(0x%x) is null or clinet(%d) < 0", pMessage,
713 SysTryCatch(NID_IO, !pMessage->is_sync(), r = E_INVALID_ARG, E_INVALID_ARG, "[E_INVALID_ARG] Can't send sync. messagee.");
715 pClientInfo = __clients[client];
716 SysTryCatch(NID_IO, pClientInfo != null, r = E_INVALID_ARG, E_INVALID_ARG,
717 "[E_INVALID_ARG] client(%d) has not been registered.",
720 pData = (char*) pMessage->data();
721 remain = pMessage->size();
726 g_io_channel_write_chars(pClientInfo->pReverseChannel, (char*) pData, remain, &written, &pGError);
727 SysTryCatch(NID_IO, pGError == null, , E_SYSTEM, "[E_SYSTEM] Error occurred during writing message to socket.");
733 g_io_channel_flush(pClientInfo->pReverseChannel, &pGError);
745 IpcServer::SendResponse(int client, const IPC::Message& message)
747 result r = E_SUCCESS;
751 GError* pGError = null;
752 _ClientInfo* pClientInfo = null;
754 SysTryReturn(NID_IO, client >= 0, false, E_INVALID_ARG, "[E_INVALID_ARG] clinet(%d) < 0", client);
755 SysTryCatch(NID_IO, !message.is_sync(), r = E_INVALID_ARG, E_INVALID_ARG, "[E_INVALID_ARG] Can't send sync. messagee.");
757 pClientInfo = __clients[client];
758 SysTryCatch(NID_IO, pClientInfo != null, r = E_INVALID_ARG, E_INVALID_ARG,
759 "[E_INVALID_ARG] client(%d) has not been registered.",
762 pData = (char*) message.data();
763 remain = message.size();
768 g_io_channel_write_chars(pClientInfo->pReverseChannel, (char*) pData, remain, &written, &pGError);
769 SysTryCatch(NID_IO, pGError == null, , E_SYSTEM, "[E_SYSTEM] Error occurred during writing message to socket.");
775 g_io_channel_flush(pClientInfo->pReverseChannel, &pGError);