/* * Copyright (c) 2012-2016 Texas Instruments Incorporated - http://www.ti.com * All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions * are met: * * * Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * * * Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in the * documentation and/or other materials provided with the distribution. * * * Neither the name of Texas Instruments Incorporated nor the names of * its contributors may be used to endorse or promote products derived * from this software without specific prior written permission. * * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ /*! * @file NameServer.c * * @brief NameServer Manager */ /* Standard IPC headers */ #include /* POSIX thread support */ #include /* Socket Headers */ #include #include #include #include #include #include #include #include #include #include #include #include #include /* Socket Protocol Family */ #include /* Module level headers */ #include #include #include <_MultiProc.h> /* Internal stuff: */ #include <_NameServer.h> #include /* Socket utils: */ #include #include <_lad.h> #if !defined(EFD_SEMAPHORE) # define EFD_SEMAPHORE (1 << 0) #endif #define MESSAGEQ_RPMSG_PORT 61 #define NAME_SERVER_RPMSG_ADDR 0 #define INVALIDSOCKET (-1) #define NameServer_Event_ACK (1 << 0) #define NameServer_Event_REFRESH (1 << 1) #define NameServer_Event_SHUTDOWN (1 << 2) #if defined (__cplusplus) extern "C" { #endif /* ============================================================================= * Structures & Enums * ============================================================================= */ /* Structure of entry in Name/Value table */ typedef struct NameServer_TableEntry_tag { CIRCLEQ_ENTRY(NameServer_TableEntry_tag) elem; /* List element */ UInt32 hash; /* Hash value */ String name; /* Name portion of the name/value pair. */ UInt len; /* Length of the value field. */ Ptr value; /* Value portion of the name/value entry. */ Bool collide; /* Does the hash collide? */ struct NameServer_TableEntry_tag * next; /* Pointer to the next entry, used incase of collision only */ } NameServer_TableEntry; /* Structure defining object for the NameServer */ struct NameServer_Object { CIRCLEQ_ENTRY(NameServer_Object) elem; CIRCLEQ_HEAD(dummy2, NameServer_TableEntry_tag) nameList; String name; /* name of the instance */ NameServer_Params params; /* the parameter structure */ UInt32 count; /* count of entries */ UInt32 refCount; /* reference count to this object */ pthread_mutex_t gate; /* crit sect gate */ } NameServer_Object; /* structure for NameServer module state */ typedef struct NameServer_ModuleObject { CIRCLEQ_HEAD(dummy1, NameServer_Object) objList; Int32 refCount; struct { Int refCount; /* attached reference count */ int sendSock; /* socket for sending */ int recvSock; /* socket for receiving */ } comm[MultiProc_MAXPROCESSORS]; pthread_t listener; /* Listener thread for NameServer replies and requests. */ int unblockFd; /* Event to wake up listener thread. */ int waitFd; /* Event to post to NameServer_get. */ NameServerRemote_Msg nsMsg; /* NameServer Message cache. */ NameServer_Params defInstParams; /* Default instance paramters */ pthread_mutex_t modGate; pthread_mutex_t attachGate; } NameServer_ModuleObject; #define CIRCLEQ_elemClear(elem) { \ (elem)->cqe_next = (elem)->cqe_prev = (Void *)(elem); \ } #define CIRCLEQ_traverse(x, y, tag) \ for (x = (y)->cqh_first; x != (struct tag *)(y); x = x->elem.cqe_next) /* ============================================================================= * Globals * ============================================================================= */ /* * NameServer_state * * Make the module gate "recursive" since NameServer_getHandle() needs to * use it and NameServer_create() needs to hold it around its call to * NameServer_getHandle(). Also, use the static initializer instead of a * run-time init call, so we can use this gate immediately in _setup(). */ static NameServer_ModuleObject NameServer_state = { .defInstParams.maxRuntimeEntries = 0u, .defInstParams.tableHeap = NULL, .defInstParams.checkExisting = TRUE, .defInstParams.maxValueLen = 0u, .defInstParams.maxNameLen = 16u, #if defined(IPC_BUILDOS_ANDROID) && (PLATFORM_SDK_VERSION < 23) .modGate = PTHREAD_RECURSIVE_MUTEX_INITIALIZER, #else // only _NP (non-portable) type available in CG tools which we're using .modGate = PTHREAD_RECURSIVE_MUTEX_INITIALIZER_NP, #endif .attachGate = PTHREAD_MUTEX_INITIALIZER, .refCount = 0 }; static NameServer_ModuleObject * NameServer_module = &NameServer_state; static const UInt32 stringCrcTab[256u] = { 0x00000000, 0x77073096, 0xee0e612c, 0x990951ba, 0x076dc419, 0x706af48f, 0xe963a535, 0x9e6495a3, 0x0edb8832, 0x79dcb8a4, 0xe0d5e91e, 0x97d2d988, 0x09b64c2b, 0x7eb17cbd, 0xe7b82d07, 0x90bf1d91, 0x1db71064, 0x6ab020f2, 0xf3b97148, 0x84be41de, 0x1adad47d, 0x6ddde4eb, 0xf4d4b551, 0x83d385c7, 0x136c9856, 0x646ba8c0, 0xfd62f97a, 0x8a65c9ec, 0x14015c4f, 0x63066cd9, 0xfa0f3d63, 0x8d080df5, 0x3b6e20c8, 0x4c69105e, 0xd56041e4, 0xa2677172, 0x3c03e4d1, 0x4b04d447, 0xd20d85fd, 0xa50ab56b, 0x35b5a8fa, 0x42b2986c, 0xdbbbc9d6, 0xacbcf940, 0x32d86ce3, 0x45df5c75, 0xdcd60dcf, 0xabd13d59, 0x26d930ac, 0x51de003a, 0xc8d75180, 0xbfd06116, 0x21b4f4b5, 0x56b3c423, 0xcfba9599, 0xb8bda50f, 0x2802b89e, 0x5f058808, 0xc60cd9b2, 0xb10be924, 0x2f6f7c87, 0x58684c11, 0xc1611dab, 0xb6662d3d, 0x76dc4190, 0x01db7106, 0x98d220bc, 0xefd5102a, 0x71b18589, 0x06b6b51f, 0x9fbfe4a5, 0xe8b8d433, 0x7807c9a2, 0x0f00f934, 0x9609a88e, 0xe10e9818, 0x7f6a0dbb, 0x086d3d2d, 0x91646c97, 0xe6635c01, 0x6b6b51f4, 0x1c6c6162, 0x856530d8, 0xf262004e, 0x6c0695ed, 0x1b01a57b, 0x8208f4c1, 0xf50fc457, 0x65b0d9c6, 0x12b7e950, 0x8bbeb8ea, 0xfcb9887c, 0x62dd1ddf, 0x15da2d49, 0x8cd37cf3, 0xfbd44c65, 0x4db26158, 0x3ab551ce, 0xa3bc0074, 0xd4bb30e2, 0x4adfa541, 0x3dd895d7, 0xa4d1c46d, 0xd3d6f4fb, 0x4369e96a, 0x346ed9fc, 0xad678846, 0xda60b8d0, 0x44042d73, 0x33031de5, 0xaa0a4c5f, 0xdd0d7cc9, 0x5005713c, 0x270241aa, 0xbe0b1010, 0xc90c2086, 0x5768b525, 0x206f85b3, 0xb966d409, 0xce61e49f, 0x5edef90e, 0x29d9c998, 0xb0d09822, 0xc7d7a8b4, 0x59b33d17, 0x2eb40d81, 0xb7bd5c3b, 0xc0ba6cad, 0xedb88320, 0x9abfb3b6, 0x03b6e20c, 0x74b1d29a, 0xead54739, 0x9dd277af, 0x04db2615, 0x73dc1683, 0xe3630b12, 0x94643b84, 0x0d6d6a3e, 0x7a6a5aa8, 0xe40ecf0b, 0x9309ff9d, 0x0a00ae27, 0x7d079eb1, 0xf00f9344, 0x8708a3d2, 0x1e01f268, 0x6906c2fe, 0xf762575d, 0x806567cb, 0x196c3671, 0x6e6b06e7, 0xfed41b76, 0x89d32be0, 0x10da7a5a, 0x67dd4acc, 0xf9b9df6f, 0x8ebeeff9, 0x17b7be43, 0x60b08ed5, 0xd6d6a3e8, 0xa1d1937e, 0x38d8c2c4, 0x4fdff252, 0xd1bb67f1, 0xa6bc5767, 0x3fb506dd, 0x48b2364b, 0xd80d2bda, 0xaf0a1b4c, 0x36034af6, 0x41047a60, 0xdf60efc3, 0xa867df55, 0x316e8eef, 0x4669be79, 0xcb61b38c, 0xbc66831a, 0x256fd2a0, 0x5268e236, 0xcc0c7795, 0xbb0b4703, 0x220216b9, 0x5505262f, 0xc5ba3bbe, 0xb2bd0b28, 0x2bb45a92, 0x5cb36a04, 0xc2d7ffa7, 0xb5d0cf31, 0x2cd99e8b, 0x5bdeae1d, 0x9b64c2b0, 0xec63f226, 0x756aa39c, 0x026d930a, 0x9c0906a9, 0xeb0e363f, 0x72076785, 0x05005713, 0x95bf4a82, 0xe2b87a14, 0x7bb12bae, 0x0cb61b38, 0x92d28e9b, 0xe5d5be0d, 0x7cdcefb7, 0x0bdbdf21, 0x86d3d2d4, 0xf1d4e242, 0x68ddb3f8, 0x1fda836e, 0x81be16cd, 0xf6b9265b, 0x6fb077e1, 0x18b74777, 0x88085ae6, 0xff0f6a70, 0x66063bca, 0x11010b5c, 0x8f659eff, 0xf862ae69, 0x616bffd3, 0x166ccf45, 0xa00ae278, 0xd70dd2ee, 0x4e048354, 0x3903b3c2, 0xa7672661, 0xd06016f7, 0x4969474d, 0x3e6e77db, 0xaed16a4a, 0xd9d65adc, 0x40df0b66, 0x37d83bf0, 0xa9bcae53, 0xdebb9ec5, 0x47b2cf7f, 0x30b5ffe9, 0xbdbdf21c, 0xcabac28a, 0x53b39330, 0x24b4a3a6, 0xbad03605, 0xcdd70693, 0x54de5729, 0x23d967bf, 0xb3667a2e, 0xc4614ab8, 0x5d681b02, 0x2a6f2b94, 0xb40bbe37, 0xc30c8ea1, 0x5a05df1b, 0x2d02ef8d, }; static UInt32 stringHash(String s) { UInt32 hash = strlen(s); UInt32 i; for (i = 0; i < strlen(s); i++) { hash = (hash >> 8u) ^ stringCrcTab[(hash & 0xff)] ^ s[i]; } return (hash); } static Int NameServer_reattach(UInt16 procId) { Int status = NameServer_S_SUCCESS; UInt16 clId; int sendSock = INVALIDSOCKET; int recvSock = INVALIDSOCKET; int err; /* procId already validated in API layer */ clId = procId - MultiProc_getBaseIdOfCluster(); if (NameServer_module->comm[clId].refCount == 0) { goto done; } LOG2("NameServer_reattach: --> procId=%d, refCount=%d\n", procId, NameServer_module->comm[clId].refCount) /* first create new sockets */ sendSock = socket(AF_RPMSG, SOCK_SEQPACKET, 0); if (sendSock < 0) { status = NameServer_E_FAIL; LOG2("NameServer_reattach: socket failed: %d, %s\n", errno, strerror(errno)); goto done; } LOG2("NameServer_reattach: created send socket: %d, procId %d\n", sendSock, procId); err = ConnectSocket(sendSock, procId, MESSAGEQ_RPMSG_PORT); if (err < 0) { status = NameServer_E_FAIL; LOG3("NameServer_reattach: connect failed: procId=%d, errno=%d (%s)\n", procId, errno, strerror(errno)); goto done; } /* create socket for receiving messages from remote processor */ recvSock = socket(AF_RPMSG, SOCK_SEQPACKET, 0); if (recvSock < 0) { status = NameServer_E_FAIL; LOG2("NameServer_reattach: socket failed: %d, %s\n", errno, strerror(errno)); goto done; } LOG2("NameServer_attach: created receive socket: %d, procId %d\n", recvSock, procId); err = SocketBindAddr(recvSock, procId, NAME_SERVER_RPMSG_ADDR); if (err < 0) { status = NameServer_E_FAIL; LOG2("NameServer_attach: bind failed: %d, %s\n", errno, strerror(errno)); goto done; } /* then close old sockets */ /* close the sending socket */ LOG1("NameServer_reattach: closing socket: %d\n", NameServer_module->comm[clId].sendSock) close(NameServer_module->comm[clId].sendSock); /* close the receiving socket */ LOG1("NameServer_reattach: closing socket: %d\n", NameServer_module->comm[clId].recvSock) close(NameServer_module->comm[clId].recvSock); /* assign new sockets */ NameServer_module->comm[clId].sendSock = sendSock; NameServer_module->comm[clId].recvSock = recvSock; done: if (status < 0) { if (recvSock >= 0) { LOG1(" closing receive socket: %d\n", recvSock) close(recvSock); } if (sendSock >= 0) { LOG1(" closing send socket: %d\n", sendSock) close(sendSock); } } LOG2("NameServer_reattach: <-- refCount=%d, status=%d\n", NameServer_module->comm[clId].refCount, status) return (status); } static void NameServerRemote_processMessage(NameServerRemote_Msg *msg, UInt16 procId) { NameServer_Handle handle; Int status = NameServer_E_FAIL; int err; uint64_t buf = 1; UInt16 clusterId; if (msg->request == NAMESERVER_REQUEST) { LOG2("NameServer Request: instanceName: %s, name: %s\n", (String)msg->instanceName, (String)msg->name) assert(msg->valueLen <= MAXVALUELEN); /* * Message is a request. Lookup name in NameServer table. * Send a response message back to source processor. */ handle = NameServer_getHandle((String)msg->instanceName); if (handle != NULL) { /* Search for the NameServer entry */ if (msg->valueLen <= sizeof (Bits32)) { LOG0("Calling NameServer_getLocalUInt32...\n") status = NameServer_getLocalUInt32(handle, (String)msg->name, &msg->value); } else { LOG0("Calling NameServer_getLocal...\n") status = NameServer_getLocal(handle, (String)msg->name, (Ptr)msg->valueBuf, &msg->valueLen); } } /* set the request status */ if (status < 0) { LOG3("NameServer Response: instance: %s, name: %s, value not " "found, status: %d\n", (String)msg->instanceName, (String)msg->name, status); msg->requestStatus = 0; } else { LOG3("NameServer Response: instance: %s, name: %s, value: 0x%x\n", (String)msg->instanceName, (String)msg->name, msg->value); msg->requestStatus = 1; } /* specify message as a response */ msg->request = NAMESERVER_RESPONSE; msg->reserved = NAMESERVER_MSG_TOKEN; /* send response message to remote processor */ clusterId = procId - MultiProc_getBaseIdOfCluster(); err = send(NameServer_module->comm[clusterId].sendSock, msg, sizeof(NameServerRemote_Msg), 0); if (err < 0) { LOG2("NameServer: send failed: %d, %s\n", errno, strerror(errno)) } } else { LOG3("NameServer Reply: instanceName: %s, name: %s, value: 0x%x\n", (String)msg->instanceName, (String)msg->name, msg->value); /* Save the response message. */ memcpy(&NameServer_module->nsMsg, msg, sizeof(NameServerRemote_Msg)); /* Post the eventfd upon which NameServer_get() is waiting */ write(NameServer_module->waitFd, &buf, sizeof(uint64_t)); } } /* * ======== listener_cb ======== */ static void *listener_cb(void *arg) { fd_set rfds; int ret = 0, maxfd; int i; UInt16 procId; struct sockaddr_rpmsg fromAddr; socklen_t len; NameServerRemote_Msg msg; int nbytes; UInt16 numProcs = MultiProc_getNumProcsInCluster(); UInt16 baseId = MultiProc_getBaseIdOfCluster(); int sock; uint64_t event; Bool run = TRUE; Bool reconnect = FALSE; (Void)arg; LOG0("listener_cb: Entered Listener thread.\n") do { /* Wait for NameServer messages or unblockFd notification */ FD_ZERO(&rfds); FD_SET(NameServer_module->unblockFd, &rfds); maxfd = NameServer_module->unblockFd; for (i = 0, procId = baseId; i < numProcs; i++, procId++) { if ((MultiProc_self() == procId) || (NameServer_module->comm[i].recvSock == INVALIDSOCKET)) { continue; } sock = NameServer_module->comm[i].recvSock; FD_SET(sock, &rfds); maxfd = sock > maxfd ? sock : maxfd; } LOG2("NameServer: waiting for unblockFd: %d, and socks: maxfd: %d\n", NameServer_module->unblockFd, maxfd) /* wait here until new data available */ ret = select(maxfd + 1, &rfds, NULL, NULL, NULL); if (ret == -1) { LOG0("listener_cb: select failed.") break; } LOG0("NameServer: back from select()\n") /* check all receive sockets for pending data */ for (i = 0, procId = baseId; i < numProcs; i++, procId++) { if ((MultiProc_self() == procId) || (NameServer_module->comm[i].recvSock == INVALIDSOCKET)) { continue; } sock = NameServer_module->comm[i].recvSock; if (FD_ISSET(sock, &rfds)) { LOG1("NameServer: Listener got NameServer message " "from sock: %d!\n", sock); /* Get NameServer message and process: */ memset(&fromAddr, 0, sizeof(fromAddr)); len = sizeof(fromAddr); nbytes = recvfrom(sock, &msg, sizeof(NameServerRemote_Msg), 0, (struct sockaddr *)&fromAddr, &len); if (len != sizeof(fromAddr)) { LOG1("recvfrom: got bad addr len (%d)\n", len) break; } if (nbytes < 0) { LOG2("recvfrom failed: %s (%d)\n", strerror(errno), errno) if (errno == ENOLINK) { LOG0("Socket is no longer valid, MUST re-attach!\n"); reconnect = TRUE; } break; } else { LOG1("listener_cb: recvfrom socket: fd: %d\n", sock) LOG3("\tReceived ns msg: nbytes: %d, from addr: %d, " "from vproc: %d\n", nbytes, fromAddr.addr, fromAddr.vproc_id); NameServerRemote_processMessage(&msg, procId); } } } /* check for events */ if (FD_ISSET(NameServer_module->unblockFd, &rfds)) { read(NameServer_module->unblockFd, &event, sizeof(event)); if (event & NameServer_Event_SHUTDOWN) { LOG0("NameServer: listener thread, event: SHUTDOWN\n") event &= ~NameServer_Event_SHUTDOWN; run = FALSE; } if (event & NameServer_Event_REFRESH) { LOG0("NameServer: listener thread, event: REFRESH\n") /* send ACK event */ event = NameServer_Event_ACK; write(NameServer_module->waitFd, &event, sizeof(event)); } } if (reconnect) { reconnect = FALSE; /* grab lock to prevent users from attach/deattach while recovering */ pthread_mutex_lock(&NameServer_module->attachGate); NameServer_reattach(procId); pthread_mutex_unlock(&NameServer_module->attachGate); } } while (run); return ((void *)ret); } /* ============================================================================= * APIS * ============================================================================= */ /* * ======== NameServer_setup ======== * Function to setup the name server module */ Int NameServer_setup(Void) { Int status = NameServer_S_SUCCESS; int ret; Int i; pthread_mutex_lock(&NameServer_module->modGate); LOG1("NameServer_setup: entered, refCount=%d\n", NameServer_module->refCount) NameServer_module->refCount++; if (NameServer_module->refCount > 1) { LOG0("NameServer_setup: already setup\n") status = NameServer_S_ALREADYSETUP; goto exit; } /* counter event object for passing commands to worker thread */ NameServer_module->unblockFd = eventfd(0, 0); if (NameServer_module->unblockFd < 0) { status = NameServer_E_FAIL; LOG0("NameServer_setup: failed to create unblockFd.\n") goto exit; } /* semaphore event object for acknowledging LAD command thread */ NameServer_module->waitFd = eventfd(0, EFD_SEMAPHORE); if (NameServer_module->waitFd < 0) { status = NameServer_E_FAIL; LOG0("NameServer_setup: failed to create waitFd.\n") goto exit; } for (i = 0; i < MultiProc_MAXPROCESSORS; i++) { NameServer_module->comm[i].refCount = 0; NameServer_module->comm[i].sendSock = INVALIDSOCKET; NameServer_module->comm[i].recvSock = INVALIDSOCKET; } /* Construct the list object */ CIRCLEQ_INIT(&NameServer_module->objList); /* Create the listener thread: */ LOG0("NameServer_setup: creating listener thread\n") ret = pthread_create(&NameServer_module->listener, NULL, listener_cb, NULL); if (ret) { LOG1("NameServer_setup: can't spawn thread: %s\n", strerror(ret)) status = NameServer_E_FAIL; } exit: LOG1("NameServer_setup: exiting, refCount=%d\n", NameServer_module->refCount) pthread_mutex_unlock(&NameServer_module->modGate); return (status); } /* * ======== NameServer_destroy ======== * Function to destroy the name server module */ Int NameServer_destroy(void) { Int status = NameServer_S_SUCCESS; uint64_t event; pthread_mutex_lock(&NameServer_module->modGate); LOG1("NameServer_destroy: entered, refCount=%d\n", NameServer_module->refCount) NameServer_module->refCount--; if (NameServer_module->refCount > 0) { LOG1("NameServer_destroy(): refCount(%d) > 0, exiting\n", NameServer_module->refCount) status = NameServer_S_SUCCESS; goto exit; } /* TODO: delete any remaining instances */ /* shutdown the NameServer listener thread */ LOG0("NameServer_destroy: shutdown listener...\n") event = NameServer_Event_SHUTDOWN; write(NameServer_module->unblockFd, &event, sizeof(event)); /* Join: */ LOG0("NameServer_destroy: joining listener thread...\n") pthread_join(NameServer_module->listener, NULL); close(NameServer_module->unblockFd); close(NameServer_module->waitFd); exit: LOG1("NameServer_destroy: exiting, refCount=%d\n", NameServer_module->refCount) pthread_mutex_unlock(&NameServer_module->modGate); return (status); } /* Function to retrieve a NameServer handle from name. */ NameServer_Handle NameServer_getHandle(String name) { NameServer_Handle handle = NULL; Bool found = FALSE; struct NameServer_Object * elem; assert(name != NULL); assert(NameServer_module->refCount != 0); pthread_mutex_lock(&NameServer_module->modGate); /* Lookup handle from name: */ CIRCLEQ_traverse(elem, &NameServer_module->objList, NameServer_Object) { handle = (NameServer_Handle) elem; if (strcmp(handle->name, name) == 0) { found = TRUE; break; } } if (found == FALSE) { handle = NULL; } pthread_mutex_unlock(&NameServer_module->modGate); return (handle); } /* Function to create a name server. */ NameServer_Handle NameServer_create(String name, const NameServer_Params * params) { NameServer_Handle handle = NULL; pthread_mutexattr_t mutex_attr; Int status = 0; assert(params != NULL); assert(name != NULL); assert(NameServer_module->refCount != 0); LOG1("NameServer_create(): '%s'\n", name) pthread_mutex_lock(&NameServer_module->modGate); status = pthread_mutexattr_init(&mutex_attr); assert(status == 0); /* check if the name is already created or not */ handle = NameServer_getHandle(name); if (handle != NULL) { if (memcmp((Ptr)&handle->params, (Ptr)params, sizeof(NameServer_Params)) == 0) { handle->refCount++; } else { LOG0("NameServer_create: NameServer params mismatch\n") handle = NULL; } goto leave; } else { handle = (NameServer_Handle)calloc(1, sizeof(NameServer_Object)); } if (!handle) { LOG0("NameServer_create: NameServer_Handle alloc failed\n") goto leave; } handle->refCount = 1; handle->name = (String)malloc(strlen(name) + 1u); if (!handle->name) { LOG0("NameServer_create: instance name alloc failed\n") goto cleanup; } strncpy(handle->name, name, strlen (name) + 1u); memcpy((Ptr) &handle->params, (Ptr) params, sizeof(NameServer_Params)); if (params->maxValueLen < sizeof(UInt32)) { handle->params.maxValueLen = sizeof(UInt32); } else { handle->params.maxValueLen = params->maxValueLen; } CIRCLEQ_INIT(&handle->nameList); handle->count = 0u; /* Put in the local list */ CIRCLEQ_elemClear(&handle->elem); CIRCLEQ_INSERT_HEAD(&NameServer_module->objList, handle, elem); /* * NameServer_removeEntry() enters gate and is called by * NameServer_remove() while holding the gate. */ pthread_mutexattr_settype(&mutex_attr, PTHREAD_MUTEX_RECURSIVE); pthread_mutex_init(&handle->gate, &mutex_attr); goto leave; cleanup: free(handle); handle = NULL; leave: pthread_mutexattr_destroy(&mutex_attr); pthread_mutex_unlock(&NameServer_module->modGate); return (handle); } /* * ======== NameServer_delete ======== * Delete a name server instance */ Int NameServer_delete(NameServer_Handle *handle) { Int status = NameServer_S_SUCCESS; struct NameServer_Object *obj; assert(handle != NULL); assert(*handle != NULL); assert(NameServer_module->refCount != 0); obj = *(struct NameServer_Object **)handle; pthread_mutex_lock(&NameServer_module->modGate); obj->refCount--; if (obj->refCount != 0) { goto leave; } /* delete each entry on the name list */ while (obj->nameList.cqh_first != (void *)&obj->nameList) { NameServer_removeEntry(*handle, (Ptr)(obj->nameList.cqh_first)); } /* free the instance name */ if (obj->name != NULL) { free(obj->name); obj->name = NULL; } /* destroy the mutex */ pthread_mutex_destroy(&obj->gate); /* remove from objList */ CIRCLEQ_REMOVE(&NameServer_module->objList, obj, elem); /* finally, free the instance object */ free(obj); /* set the caller's handle to null */ (*handle) = NULL; leave: pthread_mutex_unlock(&NameServer_module->modGate); return (status); } /* Adds a variable length value into the local NameServer table */ Ptr NameServer_add(NameServer_Handle handle, String name, Ptr buf, UInt len) { Int status = NameServer_S_SUCCESS; NameServer_TableEntry * node = NULL; NameServer_TableEntry * new_node = NULL; Bool found = FALSE; UInt32 hash; assert(handle != NULL); assert(name != NULL); assert(buf != NULL); assert(len != 0); assert(NameServer_module->refCount != 0); /* Calculate the hash */ hash = stringHash(name); pthread_mutex_lock(&handle->gate); if (strlen(name) > handle->params.maxNameLen - 1) { status = NameServer_E_INVALIDARG; LOG0("NameServer_add: name length exceeded maximum!\n") new_node = NULL; goto exit; } if (len > handle->params.maxValueLen) { status = NameServer_E_INVALIDARG; LOG0("NameServer_add: value length exceeded maximum!\n") new_node = NULL; goto exit; } /* Traverse the list to find duplicate check */ CIRCLEQ_traverse(node, &handle->nameList, NameServer_TableEntry_tag) { /* Hash matches */ if (node->hash == hash) { /* If the name matches, incase hash is duplicate */ if (strcmp(node->name, name) == 0) { if (handle->params.checkExisting == TRUE) { status = NameServer_E_INVALIDARG; LOG1("NameServer_add: '%s' - duplicate entry found!\n", name) break; } } else { found = TRUE; break; } /* name does not match */ } /* hash does not match */ } /* CIRCLEQ_traverse */ if (status != NameServer_S_SUCCESS) { new_node = NULL; goto exit; } /* Now add the new entry. */ new_node = (NameServer_TableEntry *)malloc(sizeof(NameServer_TableEntry)); if (new_node == NULL) { status = NameServer_E_MEMORY; LOG1("NameServer_add: %d - malloc new_node failed!\n", status) goto exit; } new_node->hash = hash; new_node->collide = found; /* Indicate if there is a collision*/ new_node->len = len; new_node->next = NULL; new_node->name = (String)malloc(strlen(name) + 1u); new_node->value = (Ptr)malloc(len); strncpy(new_node->name, name, strlen(name) + 1u); memcpy((Ptr)new_node->value, (Ptr)buf, len); if (found == TRUE) { /* If hash is found, need to stitch the list to link the * new node to the existing node with the same hash. */ new_node->next = node->next; node->next = new_node; } else { /* put the new node into the list */ CIRCLEQ_INSERT_HEAD(&handle->nameList, new_node, elem); } handle->count++; LOG2("NameServer_add: Entered key: '%s', data: 0x%x\n", name, *(UInt32 *)buf) exit: pthread_mutex_unlock(&handle->gate); return (new_node); } /* Function to add a UInt32 value into a name server. */ Ptr NameServer_addUInt32(NameServer_Handle handle, String name, UInt32 value) { Ptr entry = NULL; assert(handle != NULL); assert(name != NULL); assert(NameServer_module->refCount != 0); entry = NameServer_add(handle, name, &value, sizeof(UInt32)); return (entry); } /* Function to remove a name/value pair from a name server. */ Int NameServer_remove(NameServer_Handle handle, String name) { Int status = NameServer_S_SUCCESS; NameServer_TableEntry *prev = NULL; NameServer_TableEntry *temp = NULL; NameServer_TableEntry *node = NULL; Bool done = FALSE; UInt32 hash; assert(handle != NULL); assert(name != NULL); assert(NameServer_module->refCount != 0); /* Calculate the hash */ hash = stringHash(name); pthread_mutex_lock(&handle->gate); /* Traverse the list to find duplicate check */ CIRCLEQ_traverse(node, &handle->nameList, NameServer_TableEntry_tag) { /* Hash matchs */ if (node->hash == hash) { if (node->collide == TRUE) { if (strcmp(node->name, name) == 0){ free(node->value); free(node->name); memcpy((Ptr)node, (Ptr) node->next, sizeof(NameServer_TableEntry)); node->next = node->next->next; free(node->next); handle->count--; done = TRUE; break; } else { prev = node; temp = node->next; while (temp) { if (strcmp(temp->name, name) == 0){ free(temp->value); free(temp->name); prev->next = temp->next; free(temp); handle->count--; done = TRUE; break; } temp = temp->next; } break; } } else { NameServer_removeEntry(handle, (Ptr)node); done = TRUE; break; } } } if (done == FALSE) { status = NameServer_E_INVALIDARG; LOG1("NameServer_remove %d Entry not found!\n", status) } pthread_mutex_unlock(&handle->gate); return (status); } /* Function to remove a name/value pair from a name server. */ Int NameServer_removeEntry(NameServer_Handle handle, Ptr entry) { Int status = NameServer_S_SUCCESS; NameServer_TableEntry * node; assert(handle != NULL); assert(entry != NULL); assert(NameServer_module->refCount != 0); pthread_mutex_lock(&handle->gate); node = (NameServer_TableEntry *)entry; free(node->value); free(node->name); CIRCLEQ_REMOVE(&handle->nameList, node, elem); free(node); handle->count--; pthread_mutex_unlock(&handle->gate); return (status); } /* Initialize this config-params structure with supplier-specified * defaults before instance creation. */ Void NameServer_Params_init(NameServer_Params * params) { assert(params != NULL); memcpy(params, &(NameServer_module->defInstParams), sizeof (NameServer_Params)); } Int NameServer_getRemote(NameServer_Handle handle, String name, Ptr value, UInt32 * len, UInt16 procId) { Int status = NameServer_S_SUCCESS; struct NameServer_Object *obj = (struct NameServer_Object *)(handle); NameServerRemote_Msg nsMsg; NameServerRemote_Msg *replyMsg; fd_set rfds; int ret = 0, sock, maxfd, waitFd; struct timeval tv; uint64_t buf = 1; int err; UInt i; static int seqNum = 0; Bool done = FALSE; UInt16 clusterId; if (strlen(name) >= MAXNAMEINCHAR) { LOG0("Name is too long in remote query\n"); return NameServer_E_NAMETOOLONG; } if (strlen(obj->name) >= MAXNAMEINCHAR) { LOG0("Instance name is too long for remote query\n"); return NameServer_E_NAMETOOLONG; } /* Set Timeout to wait: */ tv.tv_sec = 0; tv.tv_usec = NAMESERVER_GET_TIMEOUT; /* Create request message and send to remote: */ clusterId = procId - MultiProc_getBaseIdOfCluster(); sock = NameServer_module->comm[clusterId].sendSock; if (sock == INVALIDSOCKET) { LOG1("NameServer_getRemote: no socket connection to processor %d\n", procId); status = NameServer_E_RESOURCE; goto exit; } LOG1("NameServer_getRemote: Sending request via sock: %d\n", sock) memset(&nsMsg, 0, sizeof(NameServerRemote_Msg)); /* Create request message and send to remote processor: */ nsMsg.reserved = NAMESERVER_MSG_TOKEN; nsMsg.request = NAMESERVER_REQUEST; nsMsg.requestStatus = 0; nsMsg.valueLen = *len; nsMsg.seqNum = seqNum++; strncpy((char *)nsMsg.instanceName, obj->name, strlen(obj->name) + 1); strncpy((char *)nsMsg.name, name, strlen(name) + 1); LOG3("NameServer_getRemote: requesting from procId %d, %s: %s\n", procId, (String)nsMsg.instanceName, (String)nsMsg.name); err = send(sock, &nsMsg, sizeof(NameServerRemote_Msg), 0); if (err < 0) { LOG2("NameServer_getRemote: send failed: %d, %s\n", errno, strerror(errno)) status = NameServer_E_FAIL; goto exit; } while (!done) { /* Block on waitFd for signal from listener thread: */ waitFd = NameServer_module->waitFd; FD_ZERO(&rfds); FD_SET(waitFd, &rfds); maxfd = waitFd + 1; LOG1("NameServer_getRemote: pending on waitFd: %d\n", waitFd) ret = select(maxfd, &rfds, NULL, NULL, &tv); if (ret == -1) { LOG0("NameServer_getRemote: select failed.") status = NameServer_E_FAIL; goto exit; } else if (!ret) { LOG0("NameServer_getRemote: select timed out.\n") status = NameServer_E_TIMEOUT; goto exit; } if (FD_ISSET(waitFd, &rfds)) { /* Read, just to balance the write: */ read(waitFd, &buf, sizeof(uint64_t)); /* Process response: */ replyMsg = &NameServer_module->nsMsg; if ((int)(replyMsg->seqNum) != seqNum - 1) { /* Ignore responses without current sequence # */ continue; } if (replyMsg->requestStatus) { /* name is found */ /* set length to amount of data that was copied */ *len = replyMsg->valueLen; /* set the contents of value */ if (*len <= sizeof (Bits32)) { *(UInt32 *)value = (UInt32)replyMsg->value; LOG4("NameServer_getRemote: Reply from: %d, %s: " "name: %s, value: 0x%x\n", procId, (String)replyMsg->instanceName, (String)replyMsg->name, *(UInt32 *)value); } else { memcpy(value, replyMsg->valueBuf, *len); LOG2("NameServer_getRemote: Reply from: %d, %s:", procId, (String)replyMsg->instanceName) for (i = 0; i < *len/4; i++) { LOG2("%s, value buffer content: 0x%x...\n", (String)replyMsg->name, ((uint32_t *)value)[i]) } } goto exit; } else { /* name is not found */ LOG2("NameServer_getRemote: value for %s:%s not found.\n", (String)replyMsg->instanceName, (String)replyMsg->name) /* set status to not found */ status = NameServer_E_NOTFOUND; } } done= TRUE; } exit: return (status); } /* Function to retrieve the value portion of a name/value pair from * local table. */ Int NameServer_get(NameServer_Handle handle, String name, Ptr value, UInt32 * len, UInt16 procId[]) { Int status = NameServer_S_SUCCESS; UInt16 numProcs; UInt32 i; UInt16 clusterId; UInt16 baseId; numProcs = MultiProc_getNumProcsInCluster(); baseId = MultiProc_getBaseIdOfCluster(); /* * BIOS side uses a gate (mutex) to protect NameServer_module->nsMsg, but * since this goes in a daemon, it will not be necessary. */ if (procId == NULL) { status = NameServer_getLocal(handle, name, value, len); if (status == NameServer_E_NOTFOUND) { for (clusterId = 0; clusterId < numProcs; clusterId++) { /* getLocal call already covers "self", keep going */ if ((baseId + clusterId) == MultiProc_self()) { continue; } status = NameServer_getRemote(handle, name, value, len, baseId + clusterId); if (status >= 0) { break; } } } } else { /* * Search the query list. It might contain the local proc * somewhere in the list. */ i = 0; while (procId[i] != MultiProc_INVALIDID) { if (procId[i] == MultiProc_self()) { status = NameServer_getLocal(handle, name, value, len); } else { status = NameServer_getRemote(handle, name, value, len, procId[i]); } if (status >= 0) { break; } i++; } } if (status == NameServer_E_RESOURCE) { status = NameServer_E_NOTFOUND; } return (status); } /* Gets a 32-bit value by name */ Int NameServer_getUInt32(NameServer_Handle handle, String name, Ptr value, UInt16 procId[]) { Int status; UInt32 len = sizeof(UInt32); assert(handle != NULL); assert(name != NULL); assert(value != NULL); assert(NameServer_module->refCount != 0); status = NameServer_get(handle, name, value, &len, procId); return (status); } /* Function to Retrieve the value portion of a name/value pair from * local table. */ Int NameServer_getLocal(NameServer_Handle handle, String name, Ptr value, UInt32 * len) { Int status = NameServer_E_NOTFOUND; NameServer_TableEntry * node = NULL; NameServer_TableEntry * temp = NULL; Bool done = FALSE; UInt32 length; UInt32 hash; assert(handle != NULL); assert(name != NULL); assert(value != NULL); assert(len != NULL); assert(NameServer_module->refCount != 0); length = *len; /* Calculate the hash */ hash = stringHash(name); pthread_mutex_lock(&handle->gate); /* Traverse the list to find duplicate check */ CIRCLEQ_traverse(node, &handle->nameList, NameServer_TableEntry_tag) { if (node->hash == hash) { if (node->collide == TRUE) { temp = node; while (temp) { if (strcmp(temp->name, name) == 0u){ if (length <= node->len) { memcpy(value, node->value, length); *len = length; } else { memcpy(value, node->value, node->len); *len = node->len; } done = TRUE; break; } temp = temp->next; } break; } else { if (length <= node->len) { memcpy(value, node->value, length); *len = length; } else { memcpy(value, node->value, node->len); *len = node->len; } done = TRUE; break; } } } pthread_mutex_unlock(&handle->gate); if (done == FALSE) { LOG1("NameServer_getLocal: entry key: '%s' not found!\n", name) } else { LOG2("NameServer_getLocal: Found entry key: '%s', data: 0x%x\n", node->name, (UInt32)node->value) status = NameServer_S_SUCCESS; } return (status); } /* * Gets a 32-bit value by name from the local table * * If the name is found, the 32-bit value is copied into the value * argument and a success status is returned. * * If the name is not found, zero is returned in len and the contents * of value are not modified. Not finding a name is not considered * an error. * * This function only searches the local name/value table. * */ Int NameServer_getLocalUInt32(NameServer_Handle handle, String name, Ptr value) { Int status; UInt32 len = sizeof(UInt32); assert(handle != NULL); assert(name != NULL); assert(value != NULL); assert(NameServer_module->refCount != 0); LOG0("NameServer_getLocalUInt32: calling NameServer_getLocal()...\n") status = NameServer_getLocal(handle, name, value, &len); return (status); } /* * ======== NameServer_attach ======== */ Int NameServer_attach(UInt16 procId) { Int status = NameServer_S_SUCCESS; int sock; int err; UInt16 clId; uint64_t event; /* procId already validated in API layer */ clId = procId - MultiProc_getBaseIdOfCluster(); pthread_mutex_lock(&NameServer_module->attachGate); LOG2("NameServer_attach: --> procId=%d, refCount=%d\n", procId, NameServer_module->comm[clId].refCount) /* must reference count because we have multiple clients */ if (NameServer_module->comm[clId].refCount > 0) { NameServer_module->comm[clId].refCount++; goto done; } /* create socket for sending messages to remote processor */ sock = socket(AF_RPMSG, SOCK_SEQPACKET, 0); if (sock < 0) { status = NameServer_E_FAIL; LOG2("NameServer_attach: socket failed: %d, %s\n", errno, strerror(errno)); goto done; } NameServer_module->comm[clId].sendSock = sock; LOG2("NameServer_attach: created send socket: %d, procId %d\n", sock, procId); err = ConnectSocket(sock, procId, MESSAGEQ_RPMSG_PORT); if (err < 0) { status = NameServer_E_FAIL; LOG3("NameServer_attach: connect failed: procId=%d, errno=%d (%s)\n", procId, errno, strerror(errno)); goto done; } /* create socket for receiving messages from remote processor */ sock = socket(AF_RPMSG, SOCK_SEQPACKET, 0); if (sock < 0) { status = NameServer_E_FAIL; LOG2("NameServer_attach: socket failed: %d, %s\n", errno, strerror(errno)); goto done; } NameServer_module->comm[clId].recvSock = sock; LOG2("NameServer_attach: created receive socket: %d, procId %d\n", sock, procId); err = SocketBindAddr(sock, procId, NAME_SERVER_RPMSG_ADDR); if (err < 0) { status = NameServer_E_FAIL; LOG2("NameServer_attach: bind failed: %d, %s\n", errno, strerror(errno)); goto done; } /* getting here means we have successfully attached */ NameServer_module->comm[clId].refCount++; pthread_mutex_unlock(&NameServer_module->attachGate); /* tell the listener thread to add new receive sockets */ event = NameServer_Event_REFRESH; write(NameServer_module->unblockFd, &event, sizeof(event)); /* wait for ACK event */ read(NameServer_module->waitFd, &event, sizeof(event)); pthread_mutex_lock(&NameServer_module->attachGate); done: if (status < 0) { sock = NameServer_module->comm[clId].recvSock; if (sock != INVALIDSOCKET) { LOG1(" closing receive socket: %d\n", sock) close(sock); NameServer_module->comm[clId].recvSock = INVALIDSOCKET; } sock = NameServer_module->comm[clId].sendSock; if (sock != INVALIDSOCKET) { LOG1(" closing send socket: %d\n", sock) close(sock); NameServer_module->comm[clId].sendSock = INVALIDSOCKET; } } LOG2("NameServer_attach: <-- refCount=%d, status=%d\n", NameServer_module->comm[clId].refCount, status) pthread_mutex_unlock(&NameServer_module->attachGate); return (status); } /* * ======== NameServer_detach ======== */ Int NameServer_detach(UInt16 procId) { Int status = NameServer_S_SUCCESS; UInt16 clId; int sendSock; int recvSock; uint64_t event; /* procId already validated in API layer */ clId = procId - MultiProc_getBaseIdOfCluster(); pthread_mutex_lock(&NameServer_module->attachGate); LOG2("NameServer_detach: --> procId=%d, refCount=%d\n", procId, NameServer_module->comm[clId].refCount) /* decrement reference count regardless of outcome below */ if (--NameServer_module->comm[clId].refCount > 0) { pthread_mutex_unlock(&NameServer_module->attachGate); goto done; } /* remove sockets from active list */ sendSock = NameServer_module->comm[clId].sendSock; NameServer_module->comm[clId].sendSock = INVALIDSOCKET; recvSock = NameServer_module->comm[clId].recvSock; NameServer_module->comm[clId].recvSock = INVALIDSOCKET; pthread_mutex_unlock(&NameServer_module->attachGate); /* tell the listener thread to remove old sockets */ event = NameServer_Event_REFRESH; write(NameServer_module->unblockFd, &event, sizeof(event)); /* wait for ACK event */ read(NameServer_module->waitFd, &event, sizeof(event)); /* close the sending socket */ LOG1("NameServer_detach: closing socket: %d\n", sendSock) close(sendSock); /* close the receiving socket */ LOG1("NameServer_detach: closing socket: %d\n", recvSock) close(recvSock); done: LOG2("NameServer_detach: <-- refCount=%d, status=%d\n", NameServer_module->comm[clId].refCount, status) return (status); } #if defined (__cplusplus) } #endif /* defined (__cplusplus) */