3af860626a1b319a3fa0a1f762cf32e69710b2f6
[ipc/ipcdev.git] / qnx / src / api / MessageQ.c
1 /*
2  * Copyright (c) 2012-2015, Texas Instruments Incorporated
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  *
9  * *  Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  *
12  * *  Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  *
16  * *  Neither the name of Texas Instruments Incorporated nor the names of
17  *    its contributors may be used to endorse or promote products derived
18  *    from this software without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
22  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
23  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
24  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
25  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
26  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
27  * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
28  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
29  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
30  * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31  */
32 /*============================================================================
33  *  @file   MessageQ.c
34  *
35  *  @brief  MessageQ module "client" implementation
36  *
37  *  This implementation is geared for use in a "client/server" model, whereby
38  *  system-wide data is maintained in a "server" component and process-
39  *  specific data is handled here.  At the moment, this implementation
40  *  connects and communicates with LAD for the server connection.
41  *
42  *  The MessageQ module supports the structured sending and receiving of
43  *  variable length messages. This module can be used for homogeneous or
44  *  heterogeneous multi-processor messaging.
45  *
46  *  MessageQ provides more sophisticated messaging than other modules. It is
47  *  typically used for complex situations such as multi-processor messaging.
48  *
49  *  The following are key features of the MessageQ module:
50  *  -Writers and readers can be relocated to another processor with no
51  *   runtime code changes.
52  *  -Timeouts are allowed when receiving messages.
53  *  -Readers can determine the writer and reply back.
54  *  -Receiving a message is deterministic when the timeout is zero.
55  *  -Messages can reside on any message queue.
56  *  -Supports zero-copy transfers.
57  *  -Can send and receive from any type of thread.
58  *  -Notification mechanism is specified by application.
59  *  -Allows QoS (quality of service) on message buffer pools. For example,
60  *   using specific buffer pools for specific message queues.
61  *
62  *  Messages are sent and received via a message queue. A reader is a thread
63  *  that gets (reads) messages from a message queue. A writer is a thread that
64  *  puts (writes) a message to a message queue. Each message queue has one
65  *  reader and can have many writers. A thread may read from or write to multiple
66  *  message queues.
67  *
68  *  Conceptually, the reader thread owns a message queue. The reader thread
69  *  creates a message queue. Writer threads  a created message queues to
70  *  get access to them.
71  *
72  *  Message queues are identified by a system-wide unique name. Internally,
73  *  MessageQ uses the NameServermodule for managing
74  *  these names. The names are used for opening a message queue. Using
75  *  names is not required.
76  *
77  *  Messages must be allocated from the MessageQ module. Once a message is
78  *  allocated, it can be sent on any message queue. Once a message is sent, the
79  *  writer loses ownership of the message and should not attempt to modify the
80  *  message. Once the reader receives the message, it owns the message. It
81  *  may either free the message or re-use the message.
82  *
83  *  Messages in a message queue can be of variable length. The only
84  *  requirement is that the first field in the definition of a message must be a
85  *  MsgHeader structure. For example:
86  *  typedef struct MyMsg {
87  *      MessageQ_MsgHeader header;
88  *      ...
89  *  } MyMsg;
90  *
91  *  The MessageQ API uses the MessageQ_MsgHeader internally. Your application
92  *  should not modify or directly access the fields in the MessageQ_MsgHeader.
93  *
94  *  All messages sent via the MessageQ module must be allocated from a
95  *  Heap implementation. The heap can be used for
96  *  other memory allocation not related to MessageQ.
97  *
98  *  An application can use multiple heaps. The purpose of having multiple
99  *  heaps is to allow an application to regulate its message usage. For
100  *  example, an application can allocate critical messages from one heap of fast
101  *  on-chip memory and non-critical messages from another heap of slower
102  *  external memory
103  *
104  *  MessageQ does support the usage of messages that allocated via the
105  *  alloc function. Please refer to the staticMsgInit
106  *  function description for more details.
107  *
108  *  In a multiple processor system, MessageQ communications to other
109  *  processors via MessageQTransport instances. There must be one and
110  *  only one MessageQTransport instance for each processor where communication
111  *  is desired.
112  *  So on a four processor system, each processor must have three
113  *  MessageQTransport instance.
114  *
115  *  The user only needs to create the MessageQTransport instances. The instances
116  *  are responsible for registering themselves with MessageQ.
117  *  This is accomplished via the registerTransport function.
118  *
119  *  ============================================================================
120  */
123 /* Standard headers */
124 #include <ti/ipc/Std.h>
126 /* Linux specific header files, replacing OSAL: */
127 #include <pthread.h>
129 /* Module level headers */
130 #include <ti/ipc/NameServer.h>
131 #include <ti/ipc/MultiProc.h>
132 #include <ti/syslink/inc/_MultiProc.h>
133 #define MessageQ_internal 1     /* must be defined before include file */
134 #include <ti/ipc/MessageQ.h>
135 #include <_MessageQ.h>
136 #include <_IpcLog.h>
137 #include <ti/syslink/inc/MessageQDrvDefs.h>
139 #include <sys/select.h>
140 #include <sys/time.h>
141 #include <sys/types.h>
142 #include <sys/param.h>
144 #include <errno.h>
145 #include <stdio.h>
146 #include <string.h>
147 #include <stdlib.h>
148 #include <unistd.h>
149 #include <assert.h>
150 #include <fcntl.h>
152 #include <ti/syslink/inc/usr/Qnx/MessageQDrv.h>
154 /* TI IPC utils: */
155 #include <_TiIpcFxns.h>
157 #include <ti/syslink/inc/ti/ipc/ti_ipc.h>
159 /* =============================================================================
160  * Macros/Constants
161  * =============================================================================
162  */
164 /*!
165  *  @brief  Name of the reserved NameServer used for MessageQ.
166  */
167 #define MessageQ_NAMESERVER  "MessageQ"
169 /* More magic rpmsg port numbers: */
170 #define MESSAGEQ_RPMSG_PORT       61
171 #define MESSAGEQ_RPMSG_MAXSIZE    512
172 #define RPMSG_RESERVED_ADDRESSES  (1024)
174 /* Trace flag settings: */
175 #define TRACESHIFT    12
176 #define TRACEMASK     0x1000
178 /* =============================================================================
179  * Structures & Enums
180  * =============================================================================
181  */
183 /* params structure evolution */
184 typedef struct {
185     Void *synchronizer;
186 } MessageQ_Params_Legacy;
188 typedef struct {
189     Int __version;
190     Void *synchronizer;
191     MessageQ_QueueIndex queueIndex;
192 } MessageQ_Params_Version2;
194 /* structure for MessageQ module state */
195 typedef struct MessageQ_ModuleObject {
196     Int                 refCount;
197     /*!< Reference count */
198     NameServer_Handle   nameServer;
199     /*!< Handle to the local NameServer used for storing GP objects */
200     pthread_mutex_t     gate;
201     /*!< Handle of gate to be used for local thread safety */
202     int                 ipcFd[MultiProc_MAXPROCESSORS];
203     /*!< File Descriptors for sending to each remote processor */
204     int                 seqNum;
205     /*!< Process-specific sequence number */
206     MessageQ_PutHookFxn putHookFxn;
207     /*!< hook function for MessageQ_put method */
208 } MessageQ_ModuleObject;
210 /*!
211  *  @brief  Structure for the Handle for the MessageQ.
212  */
213 typedef struct MessageQ_Object_tag {
214     MessageQ_Params         params;
215     /*! Instance specific creation parameters */
216     MessageQ_QueueId        queue;
217     /* Unique id */
218     int                     ipcFd;
219     /* File Descriptors to receive from a message queue. */
220     int                     unblockFdW;
221     /* Write this fd to unblock the select() call in MessageQ _get() */
222     int                     unblockFdR;
223      /* File Descriptor to block on to listen to unblockFdW. */
224     void                    *serverHandle;
225 } MessageQ_Object;
227 /* traces in this file are controlled via _MessageQ_verbose */
228 Bool _MessageQ_verbose = FALSE;
229 #define verbose _MessageQ_verbose
231 /* =============================================================================
232  *  Globals
233  * =============================================================================
234  */
235 static MessageQ_ModuleObject MessageQ_state =
237     .refCount   = 0,
238     .nameServer = NULL,
239     .putHookFxn = NULL
240 };
242 /*!
243  *  @var    MessageQ_module
244  *
245  *  @brief  Pointer to the MessageQ module state.
246  */
247 MessageQ_ModuleObject * MessageQ_module = &MessageQ_state;
250 /* =============================================================================
251  * Forward declarations of internal functions
252  * =============================================================================
253  */
255 /* This is a helper function to initialize a message. */
256 static Int transportCreateEndpoint(int * fd, UInt16 queueIndex);
257 static Int transportCloseEndpoint(int fd);
258 static Int transportGet(int fd, MessageQ_Msg * retMsg);
259 static Int transportPut(MessageQ_Msg msg, UInt16 dstId, UInt16 dstProcId);
261 /* =============================================================================
262  * APIS
263  * =============================================================================
264  */
265 /* Function to get default configuration for the MessageQ module.
266  *
267  */
268 Void MessageQ_getConfig (MessageQ_Config * cfg)
270     Int status;
271     MessageQDrv_CmdArgs cmdArgs;
273     assert (cfg != NULL);
275     cmdArgs.args.getConfig.config = cfg;
276     status = MessageQDrv_ioctl (CMD_MESSAGEQ_GETCONFIG, &cmdArgs);
278     if (status < 0) {
279         PRINTVERBOSE1("MessageQ_getConfig: API (through IOCTL) failed, \
280             status=%d\n", status)
281     }
283     return;
286 /* Function to setup the MessageQ module. */
287 Int MessageQ_setup (const MessageQ_Config * cfg)
289     Int status;
290     MessageQDrv_CmdArgs cmdArgs;
292     Int i;
294     cmdArgs.args.setup.config = (MessageQ_Config *) cfg;
295     status = MessageQDrv_ioctl(CMD_MESSAGEQ_SETUP, &cmdArgs);
296     if (status < 0) {
297         PRINTVERBOSE1("MessageQ_setup: API (through IOCTL) failed, \
298             status=%d\n", status)
299         return status;
300     }
302     MessageQ_module->nameServer = cmdArgs.args.setup.nameServerHandle;
303     MessageQ_module->seqNum = 0;
305     /* Create a default local gate. */
306     pthread_mutex_init (&(MessageQ_module->gate), NULL);
308     /* Clear ipcFd array. */
309     for (i = 0; i < MultiProc_MAXPROCESSORS; i++) {
310        MessageQ_module->ipcFd[i]      = -1;
311     }
313     return status;
316 /*
317  * Function to destroy the MessageQ module.
318  */
319 Int MessageQ_destroy (void)
321     Int status;
322     MessageQDrv_CmdArgs    cmdArgs;
324     status = MessageQDrv_ioctl (CMD_MESSAGEQ_DESTROY, &cmdArgs);
325     if (status < 0) {
326         PRINTVERBOSE1("MessageQ_destroy: API (through IOCTL) failed, \
327             status=%d\n", status)
328     }
330     return status;
333 /*
334  *  ======== MessageQ_Params_init ========
335  *  Legacy implementation.
336  */
337 Void MessageQ_Params_init(MessageQ_Params *params)
339     ((MessageQ_Params_Legacy *)params)->synchronizer = NULL;
342 /*
343  *  ======== MessageQ_Params_init__S ========
344  *  New implementation which is version aware.
345  */
346 Void MessageQ_Params_init__S(MessageQ_Params *params, Int version)
348     MessageQ_Params_Version2 *params2;
350     switch (version) {
352         case MessageQ_Params_VERSION_2:
353             params2 = (MessageQ_Params_Version2 *)params;
354             params2->__version = MessageQ_Params_VERSION_2;
355             params2->synchronizer = NULL;
356             params2->queueIndex = MessageQ_ANY;
357             break;
359         default:
360             assert(FALSE);
361             break;
362     }
365 /*
366  *   Function to create a MessageQ object for receiving.
367  *
368  *   Create a file descriptor and bind the source address
369  *   (local ProcId/MessageQ ID) in
370  *   order to get messages dispatched to this messageQ.
371  */
372 MessageQ_Handle MessageQ_create (String name, const MessageQ_Params * pp)
374     Int                   status    = MessageQ_S_SUCCESS;
375     MessageQ_Object *     obj    = NULL;
376     UInt16                queuePort = 0u;
377     MessageQDrv_CmdArgs   cmdArgs;
378     int                   fildes[2];
379     MessageQ_Params       ps;
381     MessageQ_Params_init__S(&ps, MessageQ_Params_VERSION);
383     /* copy the given params into the current params structure */
384     if (pp != NULL) {
386         /* snoop the params pointer to see if it's a legacy structure */
387         if ((pp->__version == 0) || (pp->__version > 100)) {
388             ps.synchronizer = ((MessageQ_Params_Legacy *)pp)->synchronizer;
389         }
391         /* not legacy structure, use params version field */
392         else if (pp->__version == MessageQ_Params_VERSION_2) {
393             ps.__version = ((MessageQ_Params_Version2 *)pp)->__version;
394             ps.synchronizer = ((MessageQ_Params_Version2 *)pp)->synchronizer;
395             ps.queueIndex = ((MessageQ_Params_Version2 *)pp)->queueIndex;
396         }
397         else {
398             assert(FALSE);
399         }
400     }
402     cmdArgs.args.create.params = &ps;
403     cmdArgs.args.create.name = name;
405     if (name != NULL) {
406         cmdArgs.args.create.nameLen = (strlen (name) + 1);
407     }
408     else {
409         cmdArgs.args.create.nameLen = 0;
410     }
412     /* Create the generic obj */
413     obj = (MessageQ_Object *)calloc(1, sizeof (MessageQ_Object));
414     if (obj == NULL) {
415         PRINTVERBOSE0("MessageQ_create: memory allocation failed\n")
416         return NULL;
417     }
419     status = MessageQDrv_ioctl (CMD_MESSAGEQ_CREATE, &cmdArgs);
420     if (status < 0) {
421         PRINTVERBOSE1("MessageQ_create: API (through IOCTL) failed, \
422             status=%d\n", status)
423         goto cleanup;
424     }
426     /* Populate the params member */
427     memcpy(&obj->params, &ps, sizeof(ps));
429     obj->queue = cmdArgs.args.create.queueId;
430     obj->serverHandle = cmdArgs.args.create.handle;
432     /* Get the queue port # (queueIndex + PORT_OFFSET) */
433     queuePort = obj->queue & 0x0000FFFF;
435     PRINTVERBOSE2("MessageQ_create: creating endpoint for: %s"
436         "queuePort %d\n", (name == NULL) ? "NULL" : name , queuePort)
437     status = transportCreateEndpoint(&obj->ipcFd, queuePort);
438     if (status < 0) {
439        goto cleanup;
440     }
442     /*
443      * Now, to support MessageQ_unblock() functionality, create an event object.
444      * Writing to this event will unblock the select() call in MessageQ_get().
445      */
446     if (pipe(fildes) == -1) {
447         printf ("MessageQ_create: pipe creation failed: %d, %s\n",
448                    errno, strerror(errno));
449         status = MessageQ_E_FAIL;
450         obj->unblockFdW = obj->unblockFdR = -1;
451     }
452     else {
453         obj->unblockFdW = fildes[1];
454         obj->unblockFdR = fildes[0];
455     }
457 cleanup:
458     /* Cleanup if fail: */
459     if (status < 0) {
460         MessageQ_delete((MessageQ_Handle *)&obj);
461     }
463     return ((MessageQ_Handle) obj);
466 /*
467  * Function to delete a MessageQ object for a specific slave processor.
468  *
469  * Deletes the file descriptors associated with this MessageQ object.
470  */
471 Int MessageQ_delete (MessageQ_Handle * handlePtr)
473     Int               status    = MessageQ_S_SUCCESS;
474     MessageQ_Object * obj       = NULL;
475     MessageQDrv_CmdArgs cmdArgs;
477     assert(handlePtr != NULL);
478     obj = (MessageQ_Object *) (*handlePtr);
479     assert(obj != NULL);
481     if (obj->serverHandle != NULL) {
482         cmdArgs.args.deleteMessageQ.handle = obj->serverHandle;
483         status = MessageQDrv_ioctl (CMD_MESSAGEQ_DELETE, &cmdArgs);
484         if (status < 0) {
485             PRINTVERBOSE1("MessageQ_delete: API (through IOCTL) failed, \
486                 status=%d\n", status)
487         }
488     }
490     /* Close the fds used for MessageQ_unblock(): */
491     if (obj->unblockFdW >= 0) {
492         close(obj->unblockFdW);
493     }
494     if (obj->unblockFdR >= 0) {
495         close(obj->unblockFdR);
496     }
498     /* Close the communication endpoint: */
499     if (obj->ipcFd >= 0) {
500         transportCloseEndpoint(obj->ipcFd);
501     }
503     /* Now free the obj */
504     free (obj);
505     *handlePtr = NULL;
507     return (status);
510 /*
511  *  Opens an instance of MessageQ for sending.
512  *
513  *  We need not create a tiipc file descriptor here; the file descriptors for
514  *  all remote processors were created during MessageQ_attach(), and will be
515  *  retrieved during MessageQ_put().
516  */
517 Int MessageQ_open (String name, MessageQ_QueueId * queueId)
519     Int status = MessageQ_S_SUCCESS;
521     status = NameServer_getUInt32 (MessageQ_module->nameServer,
522                                      name, queueId, NULL);
524     if (status == NameServer_E_NOTFOUND) {
525         /* Set return queue ID to invalid. */
526         *queueId = MessageQ_INVALIDMESSAGEQ;
527         status = MessageQ_E_NOTFOUND;
528     }
529     else if (status >= 0) {
530         /* Override with a MessageQ status code. */
531         status = MessageQ_S_SUCCESS;
532     }
533     else {
534         /* Set return queue ID to invalid. */
535         *queueId = MessageQ_INVALIDMESSAGEQ;
536         /* Override with a MessageQ status code. */
537         if (status == NameServer_E_TIMEOUT) {
538             status = MessageQ_E_TIMEOUT;
539         }
540         else {
541             status = MessageQ_E_FAIL;
542         }
543     }
545     return (status);
548 /*
549  *  ======== MessageQ_openQueueId ========
550  */
551 MessageQ_QueueId MessageQ_openQueueId(UInt16 queueIndex, UInt16 procId)
553     MessageQ_QueueIndex queuePort;
554     MessageQ_QueueId queueId;
556     /* queue port is embedded in the queueId */
557     queuePort = queueIndex + MessageQ_PORTOFFSET;
558     queueId = ((MessageQ_QueueId)(procId) << 16) | queuePort;
560     return (queueId);
563 /* Closes previously opened instance of MessageQ module. */
564 Int MessageQ_close (MessageQ_QueueId * queueId)
566     Int32 status = MessageQ_S_SUCCESS;
568     /* Nothing more to be done for closing the MessageQ. */
569     *queueId = MessageQ_INVALIDMESSAGEQ;
571     return (status);
574 /*
575  * Place a message onto a message queue.
576  *
577  * Calls TransportShm_put(), which handles the sending of the message using the
578  * appropriate kernel interface (socket, device ioctl) call for the remote
579  * procId encoded in the queueId argument.
580  *
581  */
582 Int MessageQ_put (MessageQ_QueueId queueId, MessageQ_Msg msg)
584     Int      status;
585     UInt16   dstProcId  = (UInt16)(queueId >> 16);
586     UInt16   queuePort = queueId & 0x0000ffff;
588     /* use the queue port # for destination address */
589     msg->dstId     = queuePort;
590     msg->dstProc   = dstProcId;
592     /* invoke put hook function after addressing the message */
593     if (MessageQ_module->putHookFxn != NULL) {
594         MessageQ_module->putHookFxn(queueId, msg);
595     }
597     status = transportPut(msg, queuePort, dstProcId);
599     return (status);
602 /*
603  * Gets a message for a message queue and blocks if the queue is empty.
604  * If a message is present, it returns it.  Otherwise it blocks
605  * waiting for a message to arrive.
606  * When a message is returned, it is owned by the caller.
607  *
608  * We block using select() on the receiving tiipc file descriptor, then
609  * get the waiting message via a read.
610  * We use the file descriptors stored in the messageQ object via a previous
611  * call to MessageQ_create().
612  *
613  * Note: We currently do not support messages to be sent between threads on the
614  * lcoal processor.
615  *
616  */
617 Int MessageQ_get (MessageQ_Handle handle, MessageQ_Msg * msg ,UInt timeout)
619     Int     status = MessageQ_S_SUCCESS;
620     Int     tmpStatus;
621     MessageQ_Object * obj = (MessageQ_Object *) handle;
622     int     retval;
623     int     nfds;
624     fd_set  rfds;
625     struct  timeval tv;
626     void    *timevalPtr;
627     int     maxfd = 0;
629     /* Wait (with timeout) and retreive message */
630     FD_ZERO(&rfds);
631     FD_SET(obj->ipcFd, &rfds);
632     maxfd = obj->ipcFd;
634     /* Wait also on the event fd, which may be written by MessageQ_unblock(): */
635     FD_SET(obj->unblockFdR, &rfds);
637     if (timeout == MessageQ_FOREVER) {
638         timevalPtr = NULL;
639     }
640     else {
641         /* Timeout given in msec: convert:  */
642         tv.tv_sec = timeout / 1000;
643         tv.tv_usec = (timeout % 1000) * 1000;
644         timevalPtr = &tv;
645     }
646     /* Add one to last fd created: */
647     nfds = ((maxfd > obj->unblockFdR) ? maxfd : obj->unblockFdR) + 1;
649     retval = select(nfds, &rfds, NULL, NULL, timevalPtr);
650     if (retval)  {
651         if (FD_ISSET(obj->unblockFdR, &rfds))  {
652             /*
653              * Our event was signalled by MessageQ_unblock().
654              *
655              * This is typically done during a shutdown sequence, where
656              * the intention of the client would be to ignore (i.e. not fetch)
657              * any pending messages in the transport's queue.
658              * Thus, we shall not check for nor return any messages.
659              */
660             *msg = NULL;
661             status = MessageQ_E_UNBLOCKED;
662         }
663         else {
664             if (FD_ISSET(obj->ipcFd, &rfds)) {
665                 /* Our transport's fd was signalled: Get the message: */
666                 tmpStatus = transportGet(obj->ipcFd, msg);
667                 if (tmpStatus < 0) {
668                     printf ("MessageQ_get: tranposrtshm_get failed.");
669                     status = MessageQ_E_FAIL;
670                 }
671             }
672         }
673     }
674     else if (retval == 0) {
675         *msg = NULL;
676         status = MessageQ_E_TIMEOUT;
677     }
679     return (status);
682 /*
683  * Return a count of the number of messages in the queue
684  *
685  * TBD: To be implemented. Return -1 for now.
686  */
687 Int MessageQ_count (MessageQ_Handle handle)
689     Int               count = -1;
690     return (count);
693 /* Initializes a message not obtained from MessageQ_alloc. */
694 Void MessageQ_staticMsgInit (MessageQ_Msg msg, UInt32 size)
696     /* Fill in the fields of the message */
697     MessageQ_msgInit (msg);
698     msg->heapId  = MessageQ_STATICMSG;
699     msg->msgSize = size;
702 /*
703  * Allocate a message and initialize the needed fields (note some
704  * of the fields in the header are set via other APIs or in the
705  * MessageQ_put function,
706  */
707 MessageQ_Msg MessageQ_alloc (UInt16 heapId, UInt32 size)
709     MessageQ_Msg msg       = NULL;
711     /*
712      * heapId not used for local alloc (as this is over a copy transport), but
713      * we need to send to other side as heapId is used in BIOS transport:
714      */
715     msg = (MessageQ_Msg)calloc (1, size);
716     MessageQ_msgInit (msg);
717     msg->msgSize = size;
718     msg->heapId  = heapId;
720     return msg;
723 /* Frees the message back to the heap that was used to allocate it. */
724 Int MessageQ_free (MessageQ_Msg msg)
726     UInt32         status = MessageQ_S_SUCCESS;
728     /* Check to ensure this was not allocated by user: */
729     if (msg->heapId == MessageQ_STATICMSG)  {
730         status =  MessageQ_E_CANNOTFREESTATICMSG;
731     }
732     else {
733         free (msg);
734     }
736     return status;
739 /* Register a heap with MessageQ. */
740 Int MessageQ_registerHeap (Ptr heap, UInt16 heapId)
742     Int  status = MessageQ_S_SUCCESS;
744     /* Do nothing, as this uses a copy transport: */
746     return status;
749 /* Unregister a heap with MessageQ. */
750 Int MessageQ_unregisterHeap (UInt16 heapId)
752     Int  status = MessageQ_S_SUCCESS;
754     /* Do nothing, as this uses a copy transport: */
756     return status;
759 /* Unblocks a MessageQ */
760 Void MessageQ_unblock (MessageQ_Handle handle)
762     MessageQ_Object * obj   = (MessageQ_Object *) handle;
763     char         buf = 'n';
765     /* Write to pipe to awaken any threads blocked on this messageQ: */
766     write(obj->unblockFdW, &buf, 1);
769 /* Embeds a source message queue into a message. */
770 Void MessageQ_setReplyQueue (MessageQ_Handle handle, MessageQ_Msg msg)
772     MessageQ_Object * obj   = (MessageQ_Object *) handle;
774     msg->replyId   = (UInt16)(obj->queue);
775     msg->replyProc = (UInt16)(obj->queue >> 16);
778 /* Returns the QueueId associated with the handle. */
779 MessageQ_QueueId MessageQ_getQueueId (MessageQ_Handle handle)
781     MessageQ_Object * obj = (MessageQ_Object *) handle;
782     UInt32            queueId;
784     queueId = (obj->queue);
786     return queueId;
789 /* Sets the tracing of a message */
790 Void MessageQ_setMsgTrace (MessageQ_Msg msg, Bool traceFlag)
792     msg->flags = (msg->flags & ~TRACEMASK) |   (traceFlag << TRACESHIFT);
795 /*
796  *  Returns the amount of shared memory used by one transport instance.
797  *
798  *  The MessageQ module itself does not use any shared memory but the
799  *  underlying transport may use some shared memory.
800  */
801 SizeT MessageQ_sharedMemReq (Ptr sharedAddr)
803     SizeT memReq = 0u;
805     /* Do nothing, as this is a copy transport. */
807     return (memReq);
810 /*
811  *  Opens a file descriptor for this remote proc.
812  *
813  *  Only opens it if one does not already exist for this procId.
814  *
815  *  Note: remoteProcId may be MultiProc_Self() for loopback case.
816  */
817 Int MessageQ_attach (UInt16 remoteProcId, Ptr sharedAddr)
819     Int     status = MessageQ_S_SUCCESS;
820     int     ipcFd;
821     int     err;
823     PRINTVERBOSE1("MessageQ_attach: remoteProcId: %d\n", remoteProcId)
825     if (remoteProcId >= MultiProc_MAXPROCESSORS) {
826         status = MessageQ_E_INVALIDPROCID;
827         goto exit;
828     }
830     pthread_mutex_lock (&(MessageQ_module->gate));
832     /* Only open a fd if one doesn't exist: */
833     if (MessageQ_module->ipcFd[remoteProcId] == -1)  {
834         /* Create a fd for sending messages to the remote proc: */
835         ipcFd = open("/dev/tiipc", O_RDWR);
836         if (ipcFd < 0) {
837             status = MessageQ_E_FAIL;
838             printf ("MessageQ_attach: open of tiipc device failed: %d, %s\n",
839                        errno, strerror(errno));
840         }
841         else  {
842             PRINTVERBOSE1("MessageQ_attach: opened tiipc fd for sending: %d\n",
843                 ipcFd)
844             MessageQ_module->ipcFd[remoteProcId] = ipcFd;
845             /*
846              * Connect to the remote endpoint and bind any reserved address as
847              * local endpoint
848              */
849             Connect(ipcFd, remoteProcId, MESSAGEQ_RPMSG_PORT);
850             /* Bind to any port # above 1024 (MessageQCopy_MAXRESERVEDEPT) */
851             err = BindAddr(ipcFd, TIIPC_ADDRANY);
852             if (err < 0) {
853                 status = MessageQ_E_FAIL;
854                 printf ("MessageQ_attach: bind failed: %d, %s\n",
855                     errno, strerror(errno));
856             }
857         }
858     }
859     else {
860         status = MessageQ_E_ALREADYEXISTS;
861     }
863     pthread_mutex_unlock (&(MessageQ_module->gate));
865 exit:
866     return (status);
869 /*
870  *  Close the fd for this remote proc.
871  *
872  */
873 Int MessageQ_detach (UInt16 remoteProcId)
875     Int status = MessageQ_S_SUCCESS;
876     int ipcFd;
878     if (remoteProcId >= MultiProc_MAXPROCESSORS) {
879         status = MessageQ_E_INVALIDPROCID;
880         goto exit;
881     }
883     pthread_mutex_lock (&(MessageQ_module->gate));
885     ipcFd = MessageQ_module->ipcFd[remoteProcId];
886     if (close (ipcFd)) {
887         status = MessageQ_E_OSFAILURE;
888         printf("MessageQ_detach: close failed: %d, %s\n",
889                        errno, strerror(errno));
890     }
891     else {
892         PRINTVERBOSE1("MessageQ_detach: closed fd: %d\n", ipcFd)
893         MessageQ_module->ipcFd[remoteProcId] = -1;
894     }
896     pthread_mutex_unlock (&(MessageQ_module->gate));
898 exit:
899     return (status);
902 /*
903  * This is a helper function to initialize a message.
904  */
905 Void MessageQ_msgInit (MessageQ_Msg msg)
907     msg->reserved0 = 0;  /* We set this to distinguish from NameServerMsg */
908     msg->replyId   = (UInt16)MessageQ_INVALIDMESSAGEQ;
909     msg->msgId     = MessageQ_INVALIDMSGID;
910     msg->dstId     = (UInt16)MessageQ_INVALIDMESSAGEQ;
911     msg->flags     = MessageQ_HEADERVERSION | MessageQ_NORMALPRI;
912     msg->srcProc   = MultiProc_self();
914     pthread_mutex_lock(&(MessageQ_module->gate));
915     msg->seqNum  = MessageQ_module->seqNum++;
916     pthread_mutex_unlock(&(MessageQ_module->gate));
919 /*
920  * =============================================================================
921  * Transport: Fxns kept here until need for a transport layer is realized.
922  * =============================================================================
923  */
924 /*
925  * ======== transportCreateEndpoint ========
926  *
927  * Create a communication endpoint to receive messages.
928  */
929 static Int transportCreateEndpoint(int * fd, UInt16 queuePort)
931     Int          status    = MessageQ_S_SUCCESS;
932     int          err;
934     /* Create a fd to the ti-ipc to receive messages for this messageQ */
935     *fd= open("/dev/tiipc", O_RDWR);
936     if (*fd < 0) {
937         status = MessageQ_E_FAIL;
938         printf ("transportCreateEndpoint: Couldn't open tiipc device: %d, %s\n",
939                   errno, strerror(errno));
941         goto exit;
942     }
944     PRINTVERBOSE1("transportCreateEndpoint: opened fd: %d\n", *fd)
946     /* Bind to this port # in the transport */
947     err = BindAddr(*fd, (UInt32)queuePort);
948     if (err < 0) {
949         status = MessageQ_E_FAIL;
950         printf("transportCreateEndpoint: bind failed: %d, %s\n",
951                   errno, strerror(errno));
953         close(*fd);
954         goto exit;
955     }
957 exit:
958     return (status);
961 /*
962  * ======== transportCloseEndpoint ========
963  *
964  *  Close the communication endpoint.
965  */
966 static Int transportCloseEndpoint(int fd)
968     Int status = MessageQ_S_SUCCESS;
970     PRINTVERBOSE1("transportCloseEndpoint: closing fd: %d\n", fd)
972     /* Stop communication to this endpoint */
973     close(fd);
975     return (status);
978 /*
979  * ======== transportGet ========
980  *  Retrieve a message waiting in the queue.
981 */
982 static Int transportGet(int fd, MessageQ_Msg * retMsg)
984     Int           status    = MessageQ_S_SUCCESS;
985     MessageQ_Msg  msg;
986     int           ret;
987     int           byteCount;
988     tiipc_remote_params remote;
990     /*
991      * We have no way of peeking to see what message size we'll get, so we
992      * allocate a message of max size to receive contents from tiipc
993      * (currently, a copy transport)
994      */
995     msg = MessageQ_alloc (0, MESSAGEQ_RPMSG_MAXSIZE);
996     if (!msg)  {
997         status = MessageQ_E_MEMORY;
998         goto exit;
999     }
1001     /* Get message */
1002     byteCount = read(fd, msg, MESSAGEQ_RPMSG_MAXSIZE);
1003     if (byteCount < 0) {
1004         printf("read failed: %s (%d)\n", strerror(errno), errno);
1005         status = MessageQ_E_FAIL;
1006         goto exit;
1007     }
1008     else {
1009          /* Update the allocated message size (even though this may waste space
1010           * when the actual message is smaller than the maximum rpmsg size,
1011           * the message will be freed soon anyway, and it avoids an extra copy).
1012           */
1013          msg->msgSize = byteCount;
1015          /*
1016           * If the message received was statically allocated, reset the
1017           * heapId, so the app can free it.
1018           */
1019          if (msg->heapId == MessageQ_STATICMSG)  {
1020              msg->heapId = 0;  /* for a copy transport, heap id is 0. */
1021          }
1022     }
1024     PRINTVERBOSE1("transportGet: read from fd: %d\n", fd)
1025     ret = ioctl(fd, TIIPC_IOCGETREMOTE, &remote);
1026     if (ret == -1) {
1027         printf("ioctl failed: %s (%d)\n", strerror(errno), errno);
1028         status = MessageQ_E_FAIL;
1029         goto exit;
1030     }
1031     PRINTVERBOSE3("\tReceived a msg: byteCount: %d, rpmsg addr: %d, rpmsg \
1032         proc: %d\n", byteCount, remote.remote_addr, remote.remote_proc)
1033     PRINTVERBOSE2("\tMessage Id: %d, Message size: %d\n", msg->msgId,
1034         msg->msgSize)
1036     *retMsg = msg;
1038 exit:
1039     return (status);
1042 /*
1043  * ======== transportPut ========
1044  *
1045  * Write to tiipc file descriptor associated with
1046  * with this destination procID.
1047  */
1048 static Int transportPut(MessageQ_Msg msg, UInt16 dstId, UInt16 dstProcId)
1050     Int     status    = MessageQ_S_SUCCESS;
1051     int     ipcFd;
1052     int     err;
1054     /*
1055      * Retrieve the tiipc file descriptor associated with this
1056      * transport for the destination processor.
1057      */
1058     ipcFd = MessageQ_module->ipcFd[dstProcId];
1060     PRINTVERBOSE2("Sending msgId: %d via fd: %d\n", msg->msgId, ipcFd)
1062     /* send response message to remote processor */
1063     err = write(ipcFd, msg, msg->msgSize);
1064     if (err < 0) {
1065         printf ("transportPut: write failed: %d, %s\n",
1066                   errno, strerror(errno));
1067         status = MessageQ_E_FAIL;
1068         goto exit;
1069     }
1071     /*
1072      * Free the message, as this is a copy transport, we maintain MessageQ
1073      * semantics.
1074      */
1075     MessageQ_free (msg);
1077 exit:
1078     return (status);