Tests: ping_rpmsg: Update Test with Proper Socket Usage
[ipc/ipcdev.git] / linux / src / transport / TransportRpmsg.c
1 /*
2  * Copyright (c) 2014-2015 Texas Instruments Incorporated - http://www.ti.com
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  *  ======== TransportRpmsg.c ========
34  *  Implementation of functions specified in the IMessageQTransport interface.
35  */
37 /* Socket Headers */
38 #include <sys/socket.h>
39 #include <sys/select.h>
40 #include <sys/eventfd.h>
41 #include <stdio.h>
42 #include <stdlib.h>
43 #include <unistd.h>
44 #include <errno.h>
45 #include <string.h>
46 #include <fcntl.h>
47 #include <pthread.h>
50 /* Socket Protocol Family */
51 #include <net/rpmsg.h>
54 /* IPC headers */
55 #include <ti/ipc/Std.h>
56 #include <SocketFxns.h>         /* Socket utils: */
57 #include <ti/ipc/Ipc.h>
58 #include <ti/ipc/MessageQ.h>
59 #include <ti/ipc/MultiProc.h>
60 #include <ti/ipc/transports/TransportRpmsg.h>
61 #include <_MessageQ.h>
62 #include <_lad.h>
64 #if !defined(EFD_SEMAPHORE)
65 #  define EFD_SEMAPHORE (1 << 0)
66 #endif
68 /* More magic rpmsg port numbers: */
69 #define MESSAGEQ_RPMSG_PORT       61
70 #define MESSAGEQ_RPMSG_MAXSIZE   512
72 #define TransportRpmsg_GROWSIZE 32
73 #define INVALIDSOCKET (-1)
75 #define TransportRpmsg_Event_ACK        (1 << 0)
76 #define TransportRpmsg_Event_PAUSE      (1 << 1)
77 #define TransportRpmsg_Event_CONTINUE   (1 << 2)
78 #define TransportRpmsg_Event_SHUTDOWN   (1 << 3)
81 #define _MAX(a,b) (((a)>(b))?(a):(b))
83 /* traces in this file are controlled via _TransportMessageQ_verbose */
84 Bool _TransportMessageQ_verbose = FALSE;
85 #define verbose _TransportMessageQ_verbose
87 Int TransportRpmsg_bind(Void *handle, UInt32 queueId);
88 Int TransportRpmsg_unbind(Void *handle, UInt32 queueId);
89 Bool TransportRpmsg_put(Void *handle, Ptr msg);
91 typedef struct TransportRpmsg_Module {
92     int             sock[MultiProc_MAXPROCESSORS];
93     fd_set          rfds;
94     int             maxFd;
95     struct {
96         int     fd;
97         UInt32  qId;
98     } inFds[1024];
99     int             nInFds;
100     pthread_mutex_t gate;
101     int             unblockEvent;    /* unblock the dispatch thread */
102     int             waitEvent;       /* block the client thread */
103     pthread_t       threadId;        /* ID returned by pthread_create() */
104     Bool            threadStarted;
106     TransportRpmsg_Handle *inst;    /* array of instances */
107 } TransportRpmsg_Module;
109 IMessageQTransport_Fxns TransportRpmsg_fxns = {
110     .bind    = TransportRpmsg_bind,
111     .unbind  = TransportRpmsg_unbind,
112     .put     = TransportRpmsg_put
113 };
115 typedef struct TransportRpmsg_Object {
116     IMessageQTransport_Object base;
117     Int status;
118     UInt16 rprocId;
119     int numQueues;
120     int *qIndexToFd;
121 } TransportRpmsg_Object;
123 TransportRpmsg_Module TransportRpmsg_state = {
124     .sock = {INVALIDSOCKET},
125     .unblockEvent = -1,
126     .waitEvent = -1,
127     .threadStarted = FALSE,
128     .inst = NULL
129 };
130 TransportRpmsg_Module *TransportRpmsg_module = &TransportRpmsg_state;
132 static void *rpmsgThreadFxn(void *arg);
133 static Int transportGet(int sock, MessageQ_Msg *retMsg);
134 static Void bindFdToQueueIndex(TransportRpmsg_Object *obj,
135                                Int fd,
136                                UInt16 qIndex);
137 static Void unbindQueueIndex(TransportRpmsg_Object *obj, UInt16 qIndex);
138 static Int queueIndexToFd(TransportRpmsg_Object *obj, UInt16 qIndex);
140 /* factory functions */
141 Int TransportRpmsg_Factory_create(Void);
142 Void TransportRpmsg_Factory_delete(Void);
143 Int TransportRpmsg_Factory_attach(UInt16 procId);
144 Int TransportRpmsg_Factory_detach(UInt16 procId);
146 Ipc_TransportFactoryFxns TransportRpmsg_Factory = {
147     .createFxn = TransportRpmsg_Factory_create,
148     .deleteFxn = TransportRpmsg_Factory_delete,
149     .attachFxn = TransportRpmsg_Factory_attach,
150     .detachFxn = TransportRpmsg_Factory_detach
151 };
153 /* -------------------------------------------------------------------------- */
155 /* instance convertors */
156 IMessageQTransport_Handle TransportRpmsg_upCast(TransportRpmsg_Handle handle)
158     TransportRpmsg_Object *obj = (TransportRpmsg_Object *)handle;
159     return ((IMessageQTransport_Handle)&obj->base);
162 TransportRpmsg_Handle TransportRpmsg_downCast(IMessageQTransport_Handle base)
164     return ((TransportRpmsg_Handle)base);
167 /*
168  *  ======== TransportRpmsg_create ========
169  */
170 TransportRpmsg_Handle TransportRpmsg_create(TransportRpmsg_Params *params)
172     Int status = MessageQ_S_SUCCESS;
173     TransportRpmsg_Object *obj = NULL;
174     int sock;
175     int flags;
176     UInt16 clusterId;
177     int i;
180     clusterId = params->rprocId - MultiProc_getBaseIdOfCluster();
182     /* create socket for sending messages to remote processor */
183     sock = socket(AF_RPMSG, SOCK_SEQPACKET, 0);
185     if (sock < 0) {
186         status = Ipc_E_FAIL;
187         fprintf(stderr,
188                 "TransportRpmsg_create: socket failed: %d (%s)\n", errno,
189                 strerror(errno));
190         goto done;
191     }
192     TransportRpmsg_module->sock[clusterId] = sock;
193     PRINTVERBOSE1("attach: created send socket: %d\n", sock)
195     status = ConnectSocket(sock, params->rprocId, MESSAGEQ_RPMSG_PORT);
197     if (status < 0) {
198         status = Ipc_E_FAIL;
199         fprintf(stderr,
200                 "TransportRpmsg_create: connect failed: %d (%s) procId: %d\n",
201                 errno, strerror(errno), params->rprocId);
202         goto done;
203     }
205     /* make sure socket fd doesn't exist for 'fork() -> exec*()'ed child */
206     flags = fcntl(sock, F_GETFD);
207     if (flags != -1) {
208         fcntl(sock, F_SETFD, flags | FD_CLOEXEC);
209     }
211     /* create the instance object */
212     obj = calloc(1, sizeof(TransportRpmsg_Object));
214     if (obj == NULL) {
215         status = Ipc_E_MEMORY;
216         goto done;
217     }
219     /* initialize the instance */
220     obj->base.base.interfaceType = IMessageQTransport_TypeId;
221     obj->base.fxns = &TransportRpmsg_fxns;
222     obj->rprocId = params->rprocId;
223     obj->numQueues = TransportRpmsg_GROWSIZE;
225     obj->qIndexToFd = calloc(TransportRpmsg_GROWSIZE, sizeof(int));
227     if (obj->qIndexToFd == NULL) {
228         status = Ipc_E_MEMORY;
229         goto done;
230     }
232     /* must initialize array */
233     for (i = 0; i < TransportRpmsg_GROWSIZE; i++) {
234         obj->qIndexToFd[i] = -1;
235     }
237 done:
238     if (status < 0) {
239         TransportRpmsg_delete((TransportRpmsg_Handle *)&obj);
240     }
242     return (TransportRpmsg_Handle)obj;
245 /*
246  *  ======== TransportRpmsg_delete ========
247  */
248 Void TransportRpmsg_delete(TransportRpmsg_Handle *pHandle)
250     TransportRpmsg_Object *obj = *(TransportRpmsg_Object **)pHandle;
251     UInt16 clusterId;
252     int sock;
255     clusterId = obj->rprocId - MultiProc_getBaseIdOfCluster();
257     /* close the socket for the given transport instance */
258     sock = TransportRpmsg_module->sock[clusterId];
259     if (sock != INVALIDSOCKET) {
260         PRINTVERBOSE1("detach: closing socket: %d\n", sock)
261         close(sock);
262     }
263     TransportRpmsg_module->sock[clusterId] = INVALIDSOCKET;
265     if ((obj != NULL) && (obj->qIndexToFd != NULL)) {
266         free(obj->qIndexToFd);
267         obj->qIndexToFd = NULL;
268     }
270     if (obj != NULL) {
271         free(obj);
272         obj = NULL;
273     }
275     *pHandle = NULL;
278 /*
279  *  ======== TransportRpmsg_bind ========
280  */
281 Int TransportRpmsg_bind(Void *handle, UInt32 queueId)
283     TransportRpmsg_Object *obj = (TransportRpmsg_Object *)handle;
284     UInt16 queuePort = queueId & 0x0000ffff;
285     int fd;
286     int flags;
287     int err;
288     uint64_t event;
289     UInt16 rprocId;
290     pthread_t tid;
291     Int status = MessageQ_S_SUCCESS;
293     tid = pthread_self();
294     rprocId = obj->rprocId;
296     PRINTVERBOSE3("TransportRpmsg_bind: creating endpoint for rprocId %d "
297             "queuePort 0x%x, tid=0x%x\n", rprocId, queuePort, (unsigned int)tid)
299     pthread_mutex_lock(&TransportRpmsg_module->gate);
301     /*  Check if binding already exists.
302      *
303      *  There is a race condition between a thread calling MessageQ_create
304      *  and another thread calling Ipc_attach. Must make sure we don't bind
305      *  the same queue twice.
306      */
307     if (queueIndexToFd(obj, queueId) != -1) {
308         goto done;
309     }
311     /*  Create the socket to receive messages for this messageQ. */
312     fd = socket(AF_RPMSG, SOCK_SEQPACKET, 0);
313     if (fd < 0) {
314         fprintf(stderr, "TransportRpmsg_bind: socket call failed: %d (%s)\n",
315                 errno, strerror(errno));
316         status = MessageQ_E_OSFAILURE;
317         goto done;
318     }
319     PRINTVERBOSE2("TransportRpmsg_bind: created socket fd %d, tdi=0x%x\n", fd,
320             (unsigned int)tid);
322     err = SocketBindAddr(fd, rprocId, (UInt32)queuePort);
323     if (err < 0) {
324         /* don't hard-printf since this is no longer fatal */
325         PRINTVERBOSE2("TransportRpmsg_bind: bind failed: %d (%s)\n",
326                       errno, strerror(errno));
327         close(fd);
328         status = MessageQ_E_OSFAILURE;
329         goto done;
330     }
332     /* make sure socket fd doesn't exist for 'fork() -> exec*()'ed child */
333     flags = fcntl(fd, F_GETFD);
334     if (flags != -1) {
335         fcntl(fd, F_SETFD, flags | FD_CLOEXEC);
336     }
338     /*  pause the dispatch thread */
339     PRINTVERBOSE1("TransportRpmsg_bind: sending PAUSE event, tid=0x%x\n",
340             (unsigned int)tid);
341     event = TransportRpmsg_Event_PAUSE;
342     write(TransportRpmsg_module->unblockEvent, &event, sizeof(event));
344     /* wait for ACK event */
345     read(TransportRpmsg_module->waitEvent, &event, sizeof(event));
346     PRINTVERBOSE2("TransportRpmsg_bind: received ACK event (%d), tid=0x%x\n",
347             (int)event, (unsigned int)tid);
349     /* add to our fat fd array and update select() parameters */
350     TransportRpmsg_module->inFds[TransportRpmsg_module->nInFds].fd = fd;
351     TransportRpmsg_module->inFds[TransportRpmsg_module->nInFds++].qId = queueId;
352     TransportRpmsg_module->maxFd = _MAX(TransportRpmsg_module->maxFd, fd);
353     FD_SET(fd, &TransportRpmsg_module->rfds);
354     bindFdToQueueIndex(obj, fd, queuePort);
356     /* release the dispatch thread */
357     PRINTVERBOSE1("TransportRpmsg_bind: sending CONTINUE event, tid=0x%x\n",
358             (unsigned int)tid);
359     event = TransportRpmsg_Event_CONTINUE;
360     write(TransportRpmsg_module->unblockEvent, &event, sizeof(event));
362 done:
363     pthread_mutex_unlock(&TransportRpmsg_module->gate);
365     return (status);
368 /*
369  *  ======== TransportRpmsg_unbind ========
370  */
371 Int TransportRpmsg_unbind(Void *handle, UInt32 queueId)
373     TransportRpmsg_Object *obj = (TransportRpmsg_Object *)handle;
374     UInt16 queuePort = queueId & 0x0000ffff;
375     uint64_t event;
376     Int    status = MessageQ_S_SUCCESS;
377     int    maxFd;
378     int    fd;
379     int    i;
380     int    j;
382     pthread_mutex_lock(&TransportRpmsg_module->gate);
384     /*  pause the dispatch thread */
385     event = TransportRpmsg_Event_PAUSE;
386     write(TransportRpmsg_module->unblockEvent, &event, sizeof(event));
388     /* wait for ACK event */
389     read(TransportRpmsg_module->waitEvent, &event, sizeof(event));
391     /*  Check if binding already deleted.
392      *
393      *  There is a race condition between a thread calling MessageQ_delete
394      *  and another thread calling Ipc_detach. Must make sure we don't unbind
395      *  the same queue twice.
396      */
397     if ((fd = queueIndexToFd(obj, queuePort)) == -1) {
398         goto done;
399     }
400     PRINTVERBOSE1("TransportRpmsg_unbind: closing socket %d\n", fd)
402     /* guarenteed to work because queueIndexToFd above succeeded */
403     unbindQueueIndex(obj, queuePort);
405     /* remove from input fd array */
406     for (i = 0; i < TransportRpmsg_module->nInFds; i++) {
407         if (TransportRpmsg_module->inFds[i].fd == fd) {
408             TransportRpmsg_module->nInFds--;
410             /* shift subsequent elements down */
411             for (j = i; j < TransportRpmsg_module->nInFds; j++) {
412                 TransportRpmsg_module->inFds[j] =
413                         TransportRpmsg_module->inFds[j + 1];
414             }
415             TransportRpmsg_module->inFds[TransportRpmsg_module->nInFds].fd = -1;
416             TransportRpmsg_module->inFds[TransportRpmsg_module->nInFds].qId = 0;
417             break;
418         }
419     }
421     /* remove fd from the descriptor set, compute new max value */
422     FD_CLR(fd, &TransportRpmsg_module->rfds);
423     if (fd == TransportRpmsg_module->maxFd) {
424         /* find new max fd */
425         maxFd = TransportRpmsg_module->unblockEvent;
426         for (i = 0; i < TransportRpmsg_module->nInFds; i++) {
427             maxFd = _MAX(TransportRpmsg_module->inFds[i].fd, maxFd);
428         }
429         TransportRpmsg_module->maxFd = maxFd;
430     }
432     close(fd);
434     /* release the dispatch thread */
435     event = TransportRpmsg_Event_CONTINUE;
436     write(TransportRpmsg_module->unblockEvent, &event, sizeof(event));
438 done:
439     pthread_mutex_unlock(&TransportRpmsg_module->gate);
441     return (status);
444 /*
445  *  ======== TransportRpmsg_put ========
446  */
447 Bool TransportRpmsg_put(Void *handle, Ptr pmsg)
449     MessageQ_Msg msg  = (MessageQ_Msg)pmsg;
450     Int     status    = TRUE;
451     int     sock;
452     int     err;
453     UInt16  clusterId;
455     /*
456      * Retrieve the socket for the AF_SYSLINK protocol associated with this
457      * transport.
458      */
459     clusterId = msg->dstProc - MultiProc_getBaseIdOfCluster();
460     sock = TransportRpmsg_module->sock[clusterId];
461     if (!sock) {
462         return FALSE;
463     }
465     PRINTVERBOSE2("Sending msgId: %d via sock: %d\n", msg->msgId, sock)
467     err = send(sock, msg, msg->msgSize, 0);
468     if (err < 0) {
469         fprintf(stderr, "TransportRpmsg_put: send failed: %d (%s)\n",
470                 errno, strerror(errno));
471         status = FALSE;
473         goto exit;
474     }
476     /*
477      * Free the message, as this is a copy transport, we maintain MessageQ
478      * semantics.
479      */
480     MessageQ_free(msg);
482 exit:
483     return status;
486 /*
487  *  ======== TransportRpmsg_control ========
488  */
489 Bool TransportRpmsg_control(Void *handle, UInt cmd, UArg cmdArg)
491     return FALSE;
494 /*
495  *  ======== rpmsgThreadFxn ========
496  */
497 void *rpmsgThreadFxn(void *arg)
499     Int      status = MessageQ_S_SUCCESS;
500     Int      tmpStatus;
501     int      retval;
502     uint64_t event;
503     fd_set   rfds;
504     int      maxFd;
505     int      nfds;
506     MessageQ_Msg     retMsg;
507     MessageQ_QueueId queueId;
508     MessageQ_Handle handle;
509     Bool run = TRUE;
510     int i;
511     int j;
512     int fd;
515     while (run) {
516         maxFd = TransportRpmsg_module->maxFd;
517         rfds = TransportRpmsg_module->rfds;
518         nfds = TransportRpmsg_module->nInFds;
520         PRINTVERBOSE3("rpmsgThreadFxn: maxFd %d rfds[1:0] 0x%08x%08x\n", maxFd,
521                 (int)rfds.fds_bits[1], (int)rfds.fds_bits[0])
523         retval = select(maxFd + 1, &rfds, NULL, NULL, NULL);
525         /* if error, try again */
526         if (retval < 0) {
527             printf("Warning: rpmsgThreadFxn: select failed, trying again\n");
528             continue;
529         }
531         /* dispatch all pending messages, do this first */
532         for (i = 0; i < nfds; i++) {
533             fd = TransportRpmsg_module->inFds[i].fd;
535             if (FD_ISSET(fd, &rfds)) {
536                 PRINTVERBOSE1("rpmsgThreadFxn: getting from fd %d\n",
537                         TransportRpmsg_module->inFds[i].fd);
539                 /* transport input fd was signalled: get the message */
540                 tmpStatus = transportGet(fd, &retMsg);
541                 if (tmpStatus < 0 && tmpStatus != MessageQ_E_SHUTDOWN) {
542                     fprintf(stderr,
543                             "rpmsgThreadFxn: transportGet failed on fd %d, "
544                             "returned %d\n", fd, tmpStatus);
545                 }
546                 else if (tmpStatus == MessageQ_E_SHUTDOWN) {
547                     fprintf(stderr,
548                             "rpmsgThreadFxn: transportGet failed on fd %d, "
549                             "returned %d\n", fd, tmpStatus);
551                     pthread_mutex_lock(&TransportRpmsg_module->gate);
553                     /*
554                      * Don't close(fd) at this time since it will get closed
555                      * later when MessageQ_delete() is called in response to
556                      * this failure.  Just remove fd's bit from the select mask
557                      * 'rfds' for now, but don't remove it from inFds[].
558                      */
559                     FD_CLR(fd, &TransportRpmsg_module->rfds);
560                     if (fd == TransportRpmsg_module->maxFd) {
561                         /* find new max fd */
562                         maxFd = TransportRpmsg_module->unblockEvent;
563                         for (j = 0; j < TransportRpmsg_module->nInFds; j++) {
564                             maxFd = _MAX(TransportRpmsg_module->inFds[j].fd,
565                                          maxFd);
566                         }
567                         TransportRpmsg_module->maxFd = maxFd;
568                     }
569                     queueId = TransportRpmsg_module->inFds[i].qId;
571                     pthread_mutex_unlock(&TransportRpmsg_module->gate);
573                     handle = MessageQ_getLocalHandle(queueId);
575                     PRINTVERBOSE2("rpmsgThreadFxn: shutting down MessageQ "
576                                   "%p (queueId 0x%x)...\n", handle, queueId)
578                     if (handle != NULL) {
579                         MessageQ_shutdown(handle);
580                     }
581                     else {
582                         fprintf(stderr,
583                                 "rpmsgThreadFxn: MessageQ_getLocalHandle(0x%x) "
584                                 "returned NULL, can't shutdown\n", queueId);
585                     }
586                 }
587                 else {
588                     queueId = MessageQ_getDstQueue(retMsg);
589                     PRINTVERBOSE1("rpmsgThreadFxn: got message, "
590                             "delivering to queueId 0x%x\n", queueId)
591                     MessageQ_put(queueId, retMsg);
592                 }
593             }
594         }
596         /* check for events */
597         if (FD_ISSET(TransportRpmsg_module->unblockEvent, &rfds)) {
599             read(TransportRpmsg_module->unblockEvent, &event, sizeof(event));
601             do {
602                 if (event & TransportRpmsg_Event_SHUTDOWN) {
603                     PRINTVERBOSE0("rpmsgThreadFxn: event SHUTDOWN\n");
604                     run = FALSE;
605                     break; /* highest priority, stop processing events */
606                 }
607                 if (event & TransportRpmsg_Event_CONTINUE) {
608                     PRINTVERBOSE1("rpmsgThreadFxn: event CONTINUE (%d)\n",
609                             (int)event);
610                     event &= ~TransportRpmsg_Event_CONTINUE;
611                 }
612                 if (event & TransportRpmsg_Event_PAUSE) {
613                     /*  Our event was signalled by TransportRpmsg_bind()
614                      *  or TransportRpmsg_unbind() to tell us that the set
615                      *  of file descriptors has changed.
616                      */
617                     PRINTVERBOSE0("rpmsgThreadFxn: event PAUSE\n");
618                     /* send the acknowledgement */
619                     event = TransportRpmsg_Event_ACK;
620                     write(TransportRpmsg_module->waitEvent, &event,
621                             sizeof(event));
622                     /* now wait to be released */
623                     read(TransportRpmsg_module->unblockEvent, &event,
624                             sizeof(event));
625                 }
626             } while (event != 0);
627         }
628     }
630     return (void *)status;
633 /*
634  * ======== transportGet ========
635  *  Retrieve a message waiting in the socket's queue.
636  */
637 static Int transportGet(int sock, MessageQ_Msg *retMsg)
639     Int           status    = MessageQ_S_SUCCESS;
640     MessageQ_Msg  msg;
641     struct sockaddr_rpmsg fromAddr;  /* [Socket address of sender] */
642     unsigned int  len;
643     int           byteCount;
645     /*
646      * We have no way of peeking to see what message size we'll get, so we
647      * allocate a message of max size to receive contents from the rpmsg socket
648      * (currently, a copy transport)
649      */
650     msg = MessageQ_alloc(0, MESSAGEQ_RPMSG_MAXSIZE);
651     if (!msg) {
652         status = MessageQ_E_MEMORY;
653         goto exit;
654     }
656     memset(&fromAddr, 0, sizeof (fromAddr));
657     len = sizeof (fromAddr);
659     byteCount = recvfrom(sock, msg, MESSAGEQ_RPMSG_MAXSIZE, 0,
660                          (struct sockaddr *)&fromAddr, &len);
661     if (len != sizeof (fromAddr)) {
662         fprintf(stderr, "recvfrom: got bad addr len (%d)\n", len);
663         status = MessageQ_E_FAIL;
664         goto freeMsg;
665     }
666     if (byteCount < 0) {
667         fprintf(stderr, "recvfrom failed: %s (%d)\n", strerror(errno), errno);
668         if (errno == ENOLINK) {
669             status = MessageQ_E_SHUTDOWN;
670         }
671         else {
672             status = MessageQ_E_FAIL;
673         }
674         goto freeMsg;
675     }
676     else {
677          /*
678           * Update the allocated message size (even though this may waste
679           * space when the actual message is smaller than the maximum rpmsg
680           * size, the message will be freed soon anyway, and it avoids an
681           * extra copy).
682           */
683          msg->msgSize = byteCount;
685          /* set the heapId in the message header to match allocation above */
686          msg->heapId = 0;
687     }
689     PRINTVERBOSE1("transportGet: recvfrom socket: fd: %d\n", sock)
690     PRINTVERBOSE3("\tReceived a msg: byteCount: %d, rpmsg addr: %d, rpmsg "
691             "proc: %d\n", byteCount, fromAddr.addr, fromAddr.vproc_id)
692     PRINTVERBOSE2("\tMessage Id: %d, Message size: %d\n", msg->msgId,
693             msg->msgSize)
695     *retMsg = msg;
697     goto exit;
699 freeMsg:
700     MessageQ_free(msg);
702 exit:
703     return status;
706 /*
707  *  ======== bindFdToQueueIndex ========
708  *
709  *  Precondition: caller must be inside the module gate
710  */
711 Void bindFdToQueueIndex(TransportRpmsg_Object *obj, Int fd, UInt16 queuePort)
713     Int *queues;
714     Int *oldQueues;
715     UInt oldSize;
716     UInt newCount;
717     UInt queueIndex;
718     int i;
720     /* subtract port offset from queue index */
721     queueIndex = queuePort - MessageQ_PORTOFFSET;
723     if (queueIndex >= obj->numQueues) {
724         newCount = queueIndex + TransportRpmsg_GROWSIZE;
725         PRINTVERBOSE1("TransportRpmsg_bind: growing numQueues to %d\n",
726                 newCount);
728         /* allocate larger table */
729         oldSize = obj->numQueues * sizeof(int);
730         queues = calloc(newCount, sizeof(int));
732         /* copy contents from old table int new table */
733         memcpy(queues, obj->qIndexToFd, oldSize);
735         /* initialize remaining entries of new (larger) table */
736         for (i = obj->numQueues; i < newCount; i++) {
737             queues[i] = -1;
738         }
740         /* swap in new table, delete old table */
741         oldQueues = obj->qIndexToFd;
742         obj->qIndexToFd = queues;
743         obj->numQueues = newCount;
744         free(oldQueues);
745     }
747     /* add new entry */
748     obj->qIndexToFd[queueIndex] = fd;
751 /*
752  *  ======== unbindQueueIndex ========
753  *
754  *  Precondition: caller must be inside the module gate
755  */
756 Void unbindQueueIndex(TransportRpmsg_Object *obj, UInt16 queuePort)
758     UInt queueIndex;
760     /* subtract port offset from queue index */
761     queueIndex = queuePort - MessageQ_PORTOFFSET;
763     /* clear table entry */
764     obj->qIndexToFd[queueIndex] = -1;
767 /*
768  *  ======== queueIndexToFd ========
769  *
770  *  Precondition: caller must be inside the module gate
771  */
772 Int queueIndexToFd(TransportRpmsg_Object *obj, UInt16 queuePort)
774     UInt queueIndex;
776     /* subtract port offset from queue index */
777     queueIndex = queuePort - MessageQ_PORTOFFSET;
779     /* return file descriptor */
780     return (obj->qIndexToFd[queueIndex]);
783 /*
784  *  ======== TransportRpmsg_Factory_create ========
785  *  Create the transport instances
786  *
787  *  Attach to all remote processors. For now, must attach to
788  *  at least one to tolerate MessageQ_E_RESOURCE failures.
789  *
790  *  This function implements the IPC Factory interface, so it
791  *  returns Ipc status codes.
792  */
793 Int TransportRpmsg_Factory_create(Void)
795     Int status = Ipc_S_SUCCESS;
796     Int i;
797     UInt16 clusterSize;
798     TransportRpmsg_Handle *inst;
799     int flags;
802     /* needed to enumerate processors in cluster */
803     clusterSize = MultiProc_getNumProcsInCluster();
805     /* allocate the instance array */
806     inst = calloc(clusterSize, sizeof(TransportRpmsg_Handle));
808     if (inst == NULL) {
809         fprintf(stderr,
810                 "Error: TransportRpmsg_Factory_create failed, no memory\n");
811         status = Ipc_E_MEMORY;
812         goto done;
813     }
815     for (i = 0; i < clusterSize; i++) {
816         inst[i] = NULL;
817     }
819     TransportRpmsg_module->inst = inst;
821     /* counter event object for passing commands to dispatch thread */
822     TransportRpmsg_module->unblockEvent = eventfd(0, 0);
824     if (TransportRpmsg_module->unblockEvent == -1) {
825         fprintf(stderr, "create: unblock event failed: %d (%s)\n",
826                 errno, strerror(errno));
827         status = Ipc_E_FAIL;
828         goto done;
829     }
831     PRINTVERBOSE1("create: created unblock event %d\n",
832             TransportRpmsg_module->unblockEvent)
834     /* semaphore event object for acknowledging client thread */
835     TransportRpmsg_module->waitEvent = eventfd(0, EFD_SEMAPHORE);
837     if (TransportRpmsg_module->waitEvent == -1) {
838         fprintf(stderr,
839                 "create: wait event failed: %d (%s)\n", errno, strerror(errno));
840         status = Ipc_E_FAIL;
841         goto done;
842     }
844     PRINTVERBOSE1("create: created wait event %d\n",
845             TransportRpmsg_module->waitEvent)
847     /* make sure eventfds don't exist for 'fork() -> exec*()'ed child */
848     flags = fcntl(TransportRpmsg_module->waitEvent, F_GETFD);
849     if (flags != -1) {
850         fcntl(TransportRpmsg_module->waitEvent, F_SETFD, flags | FD_CLOEXEC);
851     }
852     flags = fcntl(TransportRpmsg_module->unblockEvent, F_GETFD);
853     if (flags != -1) {
854         fcntl(TransportRpmsg_module->unblockEvent, F_SETFD, flags | FD_CLOEXEC);
855     }
857     FD_ZERO(&TransportRpmsg_module->rfds);
858     FD_SET(TransportRpmsg_module->unblockEvent,
859             &TransportRpmsg_module->rfds);
860     TransportRpmsg_module->maxFd = TransportRpmsg_module->unblockEvent;
861     TransportRpmsg_module->nInFds = 0;
863     pthread_mutex_init(&TransportRpmsg_module->gate, NULL);
865     status = pthread_create(&TransportRpmsg_module->threadId, NULL,
866             &rpmsgThreadFxn, NULL);
868     if (status < 0) {
869         status = Ipc_E_FAIL;
870         fprintf(stderr, "create: failed to spawn thread\n");
871         goto done;
872     }
873     TransportRpmsg_module->threadStarted = TRUE;
875 done:
876     if (status < 0) {
877         TransportRpmsg_Factory_delete();
878     }
880     return (status);
883 /*
884  *  ======== TransportRpmsg_Factory_delete ========
885  *  Finalize the transport instances
886  */
887 Void TransportRpmsg_Factory_delete(Void)
889     uint64_t event;
892     /* shutdown the message dispatch thread */
893     if (TransportRpmsg_module->threadStarted) {
894         event = TransportRpmsg_Event_SHUTDOWN;
895         write(TransportRpmsg_module->unblockEvent, &event, sizeof(event));
897         /* wait for dispatch thread to exit */
898         pthread_join(TransportRpmsg_module->threadId, NULL);
899     }
901     /* destroy the mutex object */
902     pthread_mutex_destroy(&TransportRpmsg_module->gate);
904     /* close the client wait event */
905     if (TransportRpmsg_module->waitEvent != -1) {
906         close(TransportRpmsg_module->waitEvent);
907         TransportRpmsg_module->waitEvent = -1;
908     }
910     /* close the dispatch thread unblock event */
911     if (TransportRpmsg_module->unblockEvent != -1) {
912         close(TransportRpmsg_module->unblockEvent);
913         TransportRpmsg_module->unblockEvent = -1;
914     }
916     /* free the instance handle array */
917     if (TransportRpmsg_module->inst != NULL) {
918         free(TransportRpmsg_module->inst);
919         TransportRpmsg_module->inst = NULL;
920     }
922     return;
925 /*
926  *  ======== TransportRpmsg_Factory_attach ========
927  */
928 Int TransportRpmsg_Factory_attach(UInt16 procId)
930     Int status = Ipc_S_SUCCESS;
931     UInt16 clusterId;
932     TransportRpmsg_Params params;
933     TransportRpmsg_Handle transport;
934     IMessageQTransport_Handle iMsgQTrans;
936     /* cannot attach to yourself */
937     if (MultiProc_self() == procId) {
938         status = Ipc_E_INVALIDARG;
939         goto done;
940     }
942     /* processor must be a member of the cluster */
943     clusterId = procId - MultiProc_getBaseIdOfCluster();
945     if (clusterId >= MultiProc_getNumProcsInCluster()) {
946         status = Ipc_E_INVALIDARG;
947         goto done;
948     }
950     /* create transport instance for given processor */
951     params.rprocId = procId;
952     transport = TransportRpmsg_create(&params);
954     if (transport == NULL) {
955         status = Ipc_E_FAIL;
956         goto done;
957     }
959     /* register transport instance with MessageQ */
960     iMsgQTrans = TransportRpmsg_upCast(transport);
961     TransportRpmsg_module->inst[clusterId] = transport;
962     MessageQ_registerTransport(iMsgQTrans, procId, 0);
964 done:
965     return (status);
968 /*
969  *  ======== TransportRpmsg_Factory_detach ========
970  */
971 Int TransportRpmsg_Factory_detach(UInt16 procId)
973     Int status = Ipc_S_SUCCESS;
974     UInt16 clusterId;
976     /* cannot detach from yourself */
977     if (MultiProc_self() == procId) {
978         status = Ipc_E_INVALIDARG;
979         goto done;
980     }
982     /* processor must be a member of the cluster */
983     clusterId = procId - MultiProc_getBaseIdOfCluster();
985     if (clusterId >= MultiProc_getNumProcsInCluster()) {
986         status = Ipc_E_INVALIDARG;
987         goto done;
988     }
990     /* must be attached in order to detach */
991     if (TransportRpmsg_module->inst[clusterId] == NULL) {
992         status = Ipc_E_INVALIDSTATE;
993         goto done;
994     }
996     /* unregister from MessageQ, delete the transport instance */
997     MessageQ_unregisterTransport(procId, 0);
998     TransportRpmsg_delete(&(TransportRpmsg_module->inst[clusterId]));
1000 done:
1001     return (status);