ipc: handle unsupported IPC in init
[dpdk.git] / lib / librte_eal / common / eal_common_proc.c
1 /* SPDX-License-Identifier: BSD-3-Clause
2  * Copyright(c) 2016-2018 Intel Corporation
3  */
4
5 #include <dirent.h>
6 #include <errno.h>
7 #include <fcntl.h>
8 #include <fnmatch.h>
9 #include <inttypes.h>
10 #include <libgen.h>
11 #include <limits.h>
12 #include <pthread.h>
13 #include <stdio.h>
14 #include <stdlib.h>
15 #include <string.h>
16 #include <sys/file.h>
17 #include <sys/time.h>
18 #include <sys/types.h>
19 #include <sys/socket.h>
20 #include <sys/un.h>
21 #include <unistd.h>
22
23 #include <rte_alarm.h>
24 #include <rte_common.h>
25 #include <rte_cycles.h>
26 #include <rte_eal.h>
27 #include <rte_errno.h>
28 #include <rte_lcore.h>
29 #include <rte_log.h>
30 #include <rte_tailq.h>
31
32 #include "eal_private.h"
33 #include "eal_filesystem.h"
34 #include "eal_internal_cfg.h"
35
36 static int mp_fd = -1;
37 static char mp_filter[PATH_MAX];   /* Filter for secondary process sockets */
38 static char mp_dir_path[PATH_MAX]; /* The directory path for all mp sockets */
39 static pthread_mutex_t mp_mutex_action = PTHREAD_MUTEX_INITIALIZER;
40 static char peer_name[PATH_MAX];
41
42 struct action_entry {
43         TAILQ_ENTRY(action_entry) next;
44         char action_name[RTE_MP_MAX_NAME_LEN];
45         rte_mp_t action;
46 };
47
48 /** Double linked list of actions. */
49 TAILQ_HEAD(action_entry_list, action_entry);
50
51 static struct action_entry_list action_entry_list =
52         TAILQ_HEAD_INITIALIZER(action_entry_list);
53
54 enum mp_type {
55         MP_MSG, /* Share message with peers, will not block */
56         MP_REQ, /* Request for information, Will block for a reply */
57         MP_REP, /* Response to previously-received request */
58         MP_IGN, /* Response telling requester to ignore this response */
59 };
60
61 struct mp_msg_internal {
62         int type;
63         struct rte_mp_msg msg;
64 };
65
66 struct async_request_param {
67         rte_mp_async_reply_t clb;
68         struct rte_mp_reply user_reply;
69         struct timespec end;
70         int n_responses_processed;
71 };
72
73 struct pending_request {
74         TAILQ_ENTRY(pending_request) next;
75         enum {
76                 REQUEST_TYPE_SYNC,
77                 REQUEST_TYPE_ASYNC
78         } type;
79         char dst[PATH_MAX];
80         struct rte_mp_msg *request;
81         struct rte_mp_msg *reply;
82         int reply_received;
83         RTE_STD_C11
84         union {
85                 struct {
86                         struct async_request_param *param;
87                 } async;
88                 struct {
89                         pthread_cond_t cond;
90                 } sync;
91         };
92 };
93
94 TAILQ_HEAD(pending_request_list, pending_request);
95
96 static struct {
97         struct pending_request_list requests;
98         pthread_mutex_t lock;
99 } pending_requests = {
100         .requests = TAILQ_HEAD_INITIALIZER(pending_requests.requests),
101         .lock = PTHREAD_MUTEX_INITIALIZER,
102         /**< used in async requests only */
103 };
104
105 /* forward declarations */
106 static int
107 mp_send(struct rte_mp_msg *msg, const char *peer, int type);
108
109 /* for use with alarm callback */
110 static void
111 async_reply_handle(void *arg);
112
113 /* for use with process_msg */
114 static struct pending_request *
115 async_reply_handle_thread_unsafe(void *arg);
116
117 static void
118 trigger_async_action(struct pending_request *req);
119
120 static struct pending_request *
121 find_pending_request(const char *dst, const char *act_name)
122 {
123         struct pending_request *r;
124
125         TAILQ_FOREACH(r, &pending_requests.requests, next) {
126                 if (!strcmp(r->dst, dst) &&
127                     !strcmp(r->request->name, act_name))
128                         break;
129         }
130
131         return r;
132 }
133
134 static void
135 create_socket_path(const char *name, char *buf, int len)
136 {
137         const char *prefix = eal_mp_socket_path();
138
139         if (strlen(name) > 0)
140                 snprintf(buf, len, "%s_%s", prefix, name);
141         else
142                 strlcpy(buf, prefix, len);
143 }
144
145 int
146 rte_eal_primary_proc_alive(const char *config_file_path)
147 {
148         int config_fd;
149
150         if (config_file_path)
151                 config_fd = open(config_file_path, O_RDONLY);
152         else {
153                 const char *path;
154
155                 path = eal_runtime_config_path();
156                 config_fd = open(path, O_RDONLY);
157         }
158         if (config_fd < 0)
159                 return 0;
160
161         int ret = lockf(config_fd, F_TEST, 0);
162         close(config_fd);
163
164         return !!ret;
165 }
166
167 static struct action_entry *
168 find_action_entry_by_name(const char *name)
169 {
170         struct action_entry *entry;
171
172         TAILQ_FOREACH(entry, &action_entry_list, next) {
173                 if (strncmp(entry->action_name, name, RTE_MP_MAX_NAME_LEN) == 0)
174                         break;
175         }
176
177         return entry;
178 }
179
180 static int
181 validate_action_name(const char *name)
182 {
183         if (name == NULL) {
184                 RTE_LOG(ERR, EAL, "Action name cannot be NULL\n");
185                 rte_errno = EINVAL;
186                 return -1;
187         }
188         if (strnlen(name, RTE_MP_MAX_NAME_LEN) == 0) {
189                 RTE_LOG(ERR, EAL, "Length of action name is zero\n");
190                 rte_errno = EINVAL;
191                 return -1;
192         }
193         if (strnlen(name, RTE_MP_MAX_NAME_LEN) == RTE_MP_MAX_NAME_LEN) {
194                 rte_errno = E2BIG;
195                 return -1;
196         }
197         return 0;
198 }
199
200 int __rte_experimental
201 rte_mp_action_register(const char *name, rte_mp_t action)
202 {
203         struct action_entry *entry;
204
205         if (validate_action_name(name) != 0)
206                 return -1;
207
208         entry = malloc(sizeof(struct action_entry));
209         if (entry == NULL) {
210                 rte_errno = ENOMEM;
211                 return -1;
212         }
213         strlcpy(entry->action_name, name, sizeof(entry->action_name));
214         entry->action = action;
215
216         pthread_mutex_lock(&mp_mutex_action);
217         if (find_action_entry_by_name(name) != NULL) {
218                 pthread_mutex_unlock(&mp_mutex_action);
219                 rte_errno = EEXIST;
220                 free(entry);
221                 return -1;
222         }
223         TAILQ_INSERT_TAIL(&action_entry_list, entry, next);
224         pthread_mutex_unlock(&mp_mutex_action);
225         return 0;
226 }
227
228 void __rte_experimental
229 rte_mp_action_unregister(const char *name)
230 {
231         struct action_entry *entry;
232
233         if (validate_action_name(name) != 0)
234                 return;
235
236         pthread_mutex_lock(&mp_mutex_action);
237         entry = find_action_entry_by_name(name);
238         if (entry == NULL) {
239                 pthread_mutex_unlock(&mp_mutex_action);
240                 return;
241         }
242         TAILQ_REMOVE(&action_entry_list, entry, next);
243         pthread_mutex_unlock(&mp_mutex_action);
244         free(entry);
245 }
246
247 static int
248 read_msg(struct mp_msg_internal *m, struct sockaddr_un *s)
249 {
250         int msglen;
251         struct iovec iov;
252         struct msghdr msgh;
253         char control[CMSG_SPACE(sizeof(m->msg.fds))];
254         struct cmsghdr *cmsg;
255         int buflen = sizeof(*m) - sizeof(m->msg.fds);
256
257         memset(&msgh, 0, sizeof(msgh));
258         iov.iov_base = m;
259         iov.iov_len  = buflen;
260
261         msgh.msg_name = s;
262         msgh.msg_namelen = sizeof(*s);
263         msgh.msg_iov = &iov;
264         msgh.msg_iovlen = 1;
265         msgh.msg_control = control;
266         msgh.msg_controllen = sizeof(control);
267
268         msglen = recvmsg(mp_fd, &msgh, 0);
269         if (msglen < 0) {
270                 RTE_LOG(ERR, EAL, "recvmsg failed, %s\n", strerror(errno));
271                 return -1;
272         }
273
274         if (msglen != buflen || (msgh.msg_flags & (MSG_TRUNC | MSG_CTRUNC))) {
275                 RTE_LOG(ERR, EAL, "truncted msg\n");
276                 return -1;
277         }
278
279         /* read auxiliary FDs if any */
280         for (cmsg = CMSG_FIRSTHDR(&msgh); cmsg != NULL;
281                 cmsg = CMSG_NXTHDR(&msgh, cmsg)) {
282                 if ((cmsg->cmsg_level == SOL_SOCKET) &&
283                         (cmsg->cmsg_type == SCM_RIGHTS)) {
284                         memcpy(m->msg.fds, CMSG_DATA(cmsg), sizeof(m->msg.fds));
285                         break;
286                 }
287         }
288         /* sanity-check the response */
289         if (m->msg.num_fds < 0 || m->msg.num_fds > RTE_MP_MAX_FD_NUM) {
290                 RTE_LOG(ERR, EAL, "invalid number of fd's received\n");
291                 return -1;
292         }
293         if (m->msg.len_param < 0 || m->msg.len_param > RTE_MP_MAX_PARAM_LEN) {
294                 RTE_LOG(ERR, EAL, "invalid received data length\n");
295                 return -1;
296         }
297         return 0;
298 }
299
300 static void
301 process_msg(struct mp_msg_internal *m, struct sockaddr_un *s)
302 {
303         struct pending_request *pending_req;
304         struct action_entry *entry;
305         struct rte_mp_msg *msg = &m->msg;
306         rte_mp_t action = NULL;
307
308         RTE_LOG(DEBUG, EAL, "msg: %s\n", msg->name);
309
310         if (m->type == MP_REP || m->type == MP_IGN) {
311                 struct pending_request *req = NULL;
312
313                 pthread_mutex_lock(&pending_requests.lock);
314                 pending_req = find_pending_request(s->sun_path, msg->name);
315                 if (pending_req) {
316                         memcpy(pending_req->reply, msg, sizeof(*msg));
317                         /* -1 indicates that we've been asked to ignore */
318                         pending_req->reply_received =
319                                 m->type == MP_REP ? 1 : -1;
320
321                         if (pending_req->type == REQUEST_TYPE_SYNC)
322                                 pthread_cond_signal(&pending_req->sync.cond);
323                         else if (pending_req->type == REQUEST_TYPE_ASYNC)
324                                 req = async_reply_handle_thread_unsafe(
325                                                 pending_req);
326                 } else
327                         RTE_LOG(ERR, EAL, "Drop mp reply: %s\n", msg->name);
328                 pthread_mutex_unlock(&pending_requests.lock);
329
330                 if (req != NULL)
331                         trigger_async_action(req);
332                 return;
333         }
334
335         pthread_mutex_lock(&mp_mutex_action);
336         entry = find_action_entry_by_name(msg->name);
337         if (entry != NULL)
338                 action = entry->action;
339         pthread_mutex_unlock(&mp_mutex_action);
340
341         if (!action) {
342                 if (m->type == MP_REQ && !internal_config.init_complete) {
343                         /* if this is a request, and init is not yet complete,
344                          * and callback wasn't registered, we should tell the
345                          * requester to ignore our existence because we're not
346                          * yet ready to process this request.
347                          */
348                         struct rte_mp_msg dummy;
349
350                         memset(&dummy, 0, sizeof(dummy));
351                         strlcpy(dummy.name, msg->name, sizeof(dummy.name));
352                         mp_send(&dummy, s->sun_path, MP_IGN);
353                 } else {
354                         RTE_LOG(ERR, EAL, "Cannot find action: %s\n",
355                                 msg->name);
356                 }
357         } else if (action(msg, s->sun_path) < 0) {
358                 RTE_LOG(ERR, EAL, "Fail to handle message: %s\n", msg->name);
359         }
360 }
361
362 static void *
363 mp_handle(void *arg __rte_unused)
364 {
365         struct mp_msg_internal msg;
366         struct sockaddr_un sa;
367
368         while (1) {
369                 if (read_msg(&msg, &sa) == 0)
370                         process_msg(&msg, &sa);
371         }
372
373         return NULL;
374 }
375
376 static int
377 timespec_cmp(const struct timespec *a, const struct timespec *b)
378 {
379         if (a->tv_sec < b->tv_sec)
380                 return -1;
381         if (a->tv_sec > b->tv_sec)
382                 return 1;
383         if (a->tv_nsec < b->tv_nsec)
384                 return -1;
385         if (a->tv_nsec > b->tv_nsec)
386                 return 1;
387         return 0;
388 }
389
390 enum async_action {
391         ACTION_FREE, /**< free the action entry, but don't trigger callback */
392         ACTION_TRIGGER /**< trigger callback, then free action entry */
393 };
394
395 static enum async_action
396 process_async_request(struct pending_request *sr, const struct timespec *now)
397 {
398         struct async_request_param *param;
399         struct rte_mp_reply *reply;
400         bool timeout, last_msg;
401
402         param = sr->async.param;
403         reply = &param->user_reply;
404
405         /* did we timeout? */
406         timeout = timespec_cmp(&param->end, now) <= 0;
407
408         /* if we received a response, adjust relevant data and copy mesasge. */
409         if (sr->reply_received == 1 && sr->reply) {
410                 struct rte_mp_msg *msg, *user_msgs, *tmp;
411
412                 msg = sr->reply;
413                 user_msgs = reply->msgs;
414
415                 tmp = realloc(user_msgs, sizeof(*msg) *
416                                 (reply->nb_received + 1));
417                 if (!tmp) {
418                         RTE_LOG(ERR, EAL, "Fail to alloc reply for request %s:%s\n",
419                                 sr->dst, sr->request->name);
420                         /* this entry is going to be removed and its message
421                          * dropped, but we don't want to leak memory, so
422                          * continue.
423                          */
424                 } else {
425                         user_msgs = tmp;
426                         reply->msgs = user_msgs;
427                         memcpy(&user_msgs[reply->nb_received],
428                                         msg, sizeof(*msg));
429                         reply->nb_received++;
430                 }
431
432                 /* mark this request as processed */
433                 param->n_responses_processed++;
434         } else if (sr->reply_received == -1) {
435                 /* we were asked to ignore this process */
436                 reply->nb_sent--;
437         } else if (timeout) {
438                 /* count it as processed response, but don't increment
439                  * nb_received.
440                  */
441                 param->n_responses_processed++;
442         }
443
444         free(sr->reply);
445
446         last_msg = param->n_responses_processed == reply->nb_sent;
447
448         return last_msg ? ACTION_TRIGGER : ACTION_FREE;
449 }
450
451 static void
452 trigger_async_action(struct pending_request *sr)
453 {
454         struct async_request_param *param;
455         struct rte_mp_reply *reply;
456
457         param = sr->async.param;
458         reply = &param->user_reply;
459
460         param->clb(sr->request, reply);
461
462         /* clean up */
463         free(sr->async.param->user_reply.msgs);
464         free(sr->async.param);
465         free(sr->request);
466         free(sr);
467 }
468
469 static struct pending_request *
470 async_reply_handle_thread_unsafe(void *arg)
471 {
472         struct pending_request *req = (struct pending_request *)arg;
473         enum async_action action;
474         struct timespec ts_now;
475         struct timeval now;
476
477         if (gettimeofday(&now, NULL) < 0) {
478                 RTE_LOG(ERR, EAL, "Cannot get current time\n");
479                 goto no_trigger;
480         }
481         ts_now.tv_nsec = now.tv_usec * 1000;
482         ts_now.tv_sec = now.tv_sec;
483
484         action = process_async_request(req, &ts_now);
485
486         TAILQ_REMOVE(&pending_requests.requests, req, next);
487
488         if (rte_eal_alarm_cancel(async_reply_handle, req) < 0) {
489                 /* if we failed to cancel the alarm because it's already in
490                  * progress, don't proceed because otherwise we will end up
491                  * handling the same message twice.
492                  */
493                 if (rte_errno == EINPROGRESS) {
494                         RTE_LOG(DEBUG, EAL, "Request handling is already in progress\n");
495                         goto no_trigger;
496                 }
497                 RTE_LOG(ERR, EAL, "Failed to cancel alarm\n");
498         }
499
500         if (action == ACTION_TRIGGER)
501                 return req;
502 no_trigger:
503         free(req);
504         return NULL;
505 }
506
507 static void
508 async_reply_handle(void *arg)
509 {
510         struct pending_request *req;
511
512         pthread_mutex_lock(&pending_requests.lock);
513         req = async_reply_handle_thread_unsafe(arg);
514         pthread_mutex_unlock(&pending_requests.lock);
515
516         if (req != NULL)
517                 trigger_async_action(req);
518 }
519
520 static int
521 open_socket_fd(void)
522 {
523         struct sockaddr_un un;
524
525         peer_name[0] = '\0';
526         if (rte_eal_process_type() == RTE_PROC_SECONDARY)
527                 snprintf(peer_name, sizeof(peer_name),
528                                 "%d_%"PRIx64, getpid(), rte_rdtsc());
529
530         mp_fd = socket(AF_UNIX, SOCK_DGRAM, 0);
531         if (mp_fd < 0) {
532                 RTE_LOG(ERR, EAL, "failed to create unix socket\n");
533                 return -1;
534         }
535
536         memset(&un, 0, sizeof(un));
537         un.sun_family = AF_UNIX;
538
539         create_socket_path(peer_name, un.sun_path, sizeof(un.sun_path));
540
541         unlink(un.sun_path); /* May still exist since last run */
542
543         if (bind(mp_fd, (struct sockaddr *)&un, sizeof(un)) < 0) {
544                 RTE_LOG(ERR, EAL, "failed to bind %s: %s\n",
545                         un.sun_path, strerror(errno));
546                 close(mp_fd);
547                 return -1;
548         }
549
550         RTE_LOG(INFO, EAL, "Multi-process socket %s\n", un.sun_path);
551         return mp_fd;
552 }
553
554 static void
555 close_socket_fd(void)
556 {
557         char path[PATH_MAX];
558
559         if (mp_fd < 0)
560                 return;
561
562         close(mp_fd);
563         create_socket_path(peer_name, path, sizeof(path));
564         unlink(path);
565 }
566
567 int
568 rte_mp_channel_init(void)
569 {
570         char path[PATH_MAX];
571         int dir_fd;
572         pthread_t mp_handle_tid;
573
574         /* in no shared files mode, we do not have secondary processes support,
575          * so no need to initialize IPC.
576          */
577         if (internal_config.no_shconf) {
578                 RTE_LOG(DEBUG, EAL, "No shared files mode enabled, IPC will be disabled\n");
579                 rte_errno = ENOTSUP;
580                 return -1;
581         }
582
583         /* create filter path */
584         create_socket_path("*", path, sizeof(path));
585         strlcpy(mp_filter, basename(path), sizeof(mp_filter));
586
587         /* path may have been modified, so recreate it */
588         create_socket_path("*", path, sizeof(path));
589         strlcpy(mp_dir_path, dirname(path), sizeof(mp_dir_path));
590
591         /* lock the directory */
592         dir_fd = open(mp_dir_path, O_RDONLY);
593         if (dir_fd < 0) {
594                 RTE_LOG(ERR, EAL, "failed to open %s: %s\n",
595                         mp_dir_path, strerror(errno));
596                 return -1;
597         }
598
599         if (flock(dir_fd, LOCK_EX)) {
600                 RTE_LOG(ERR, EAL, "failed to lock %s: %s\n",
601                         mp_dir_path, strerror(errno));
602                 close(dir_fd);
603                 return -1;
604         }
605
606         if (open_socket_fd() < 0) {
607                 close(dir_fd);
608                 return -1;
609         }
610
611         if (rte_ctrl_thread_create(&mp_handle_tid, "rte_mp_handle",
612                         NULL, mp_handle, NULL) < 0) {
613                 RTE_LOG(ERR, EAL, "failed to create mp thead: %s\n",
614                         strerror(errno));
615                 close(mp_fd);
616                 close(dir_fd);
617                 mp_fd = -1;
618                 return -1;
619         }
620
621         /* unlock the directory */
622         flock(dir_fd, LOCK_UN);
623         close(dir_fd);
624
625         return 0;
626 }
627
628 void
629 rte_mp_channel_cleanup(void)
630 {
631         close_socket_fd();
632 }
633
634 /**
635  * Return -1, as fail to send message and it's caused by the local side.
636  * Return 0, as fail to send message and it's caused by the remote side.
637  * Return 1, as succeed to send message.
638  *
639  */
640 static int
641 send_msg(const char *dst_path, struct rte_mp_msg *msg, int type)
642 {
643         int snd;
644         struct iovec iov;
645         struct msghdr msgh;
646         struct cmsghdr *cmsg;
647         struct sockaddr_un dst;
648         struct mp_msg_internal m;
649         int fd_size = msg->num_fds * sizeof(int);
650         char control[CMSG_SPACE(fd_size)];
651
652         m.type = type;
653         memcpy(&m.msg, msg, sizeof(*msg));
654
655         memset(&dst, 0, sizeof(dst));
656         dst.sun_family = AF_UNIX;
657         strlcpy(dst.sun_path, dst_path, sizeof(dst.sun_path));
658
659         memset(&msgh, 0, sizeof(msgh));
660         memset(control, 0, sizeof(control));
661
662         iov.iov_base = &m;
663         iov.iov_len = sizeof(m) - sizeof(msg->fds);
664
665         msgh.msg_name = &dst;
666         msgh.msg_namelen = sizeof(dst);
667         msgh.msg_iov = &iov;
668         msgh.msg_iovlen = 1;
669         msgh.msg_control = control;
670         msgh.msg_controllen = sizeof(control);
671
672         cmsg = CMSG_FIRSTHDR(&msgh);
673         cmsg->cmsg_len = CMSG_LEN(fd_size);
674         cmsg->cmsg_level = SOL_SOCKET;
675         cmsg->cmsg_type = SCM_RIGHTS;
676         memcpy(CMSG_DATA(cmsg), msg->fds, fd_size);
677
678         do {
679                 snd = sendmsg(mp_fd, &msgh, 0);
680         } while (snd < 0 && errno == EINTR);
681
682         if (snd < 0) {
683                 rte_errno = errno;
684                 /* Check if it caused by peer process exits */
685                 if (errno == ECONNREFUSED &&
686                                 rte_eal_process_type() == RTE_PROC_PRIMARY) {
687                         unlink(dst_path);
688                         return 0;
689                 }
690                 RTE_LOG(ERR, EAL, "failed to send to (%s) due to %s\n",
691                         dst_path, strerror(errno));
692                 return -1;
693         }
694
695         return 1;
696 }
697
698 static int
699 mp_send(struct rte_mp_msg *msg, const char *peer, int type)
700 {
701         int dir_fd, ret = 0;
702         DIR *mp_dir;
703         struct dirent *ent;
704
705         if (!peer && (rte_eal_process_type() == RTE_PROC_SECONDARY))
706                 peer = eal_mp_socket_path();
707
708         if (peer) {
709                 if (send_msg(peer, msg, type) < 0)
710                         return -1;
711                 else
712                         return 0;
713         }
714
715         /* broadcast to all secondary processes */
716         mp_dir = opendir(mp_dir_path);
717         if (!mp_dir) {
718                 RTE_LOG(ERR, EAL, "Unable to open directory %s\n",
719                                 mp_dir_path);
720                 rte_errno = errno;
721                 return -1;
722         }
723
724         dir_fd = dirfd(mp_dir);
725         /* lock the directory to prevent processes spinning up while we send */
726         if (flock(dir_fd, LOCK_SH)) {
727                 RTE_LOG(ERR, EAL, "Unable to lock directory %s\n",
728                         mp_dir_path);
729                 rte_errno = errno;
730                 closedir(mp_dir);
731                 return -1;
732         }
733
734         while ((ent = readdir(mp_dir))) {
735                 char path[PATH_MAX];
736
737                 if (fnmatch(mp_filter, ent->d_name, 0) != 0)
738                         continue;
739
740                 snprintf(path, sizeof(path), "%s/%s", mp_dir_path,
741                          ent->d_name);
742                 if (send_msg(path, msg, type) < 0)
743                         ret = -1;
744         }
745         /* unlock the dir */
746         flock(dir_fd, LOCK_UN);
747
748         /* dir_fd automatically closed on closedir */
749         closedir(mp_dir);
750         return ret;
751 }
752
753 static int
754 check_input(const struct rte_mp_msg *msg)
755 {
756         if (msg == NULL) {
757                 RTE_LOG(ERR, EAL, "Msg cannot be NULL\n");
758                 rte_errno = EINVAL;
759                 return -1;
760         }
761
762         if (validate_action_name(msg->name) != 0)
763                 return -1;
764
765         if (msg->len_param < 0) {
766                 RTE_LOG(ERR, EAL, "Message data length is negative\n");
767                 rte_errno = EINVAL;
768                 return -1;
769         }
770
771         if (msg->num_fds < 0) {
772                 RTE_LOG(ERR, EAL, "Number of fd's is negative\n");
773                 rte_errno = EINVAL;
774                 return -1;
775         }
776
777         if (msg->len_param > RTE_MP_MAX_PARAM_LEN) {
778                 RTE_LOG(ERR, EAL, "Message data is too long\n");
779                 rte_errno = E2BIG;
780                 return -1;
781         }
782
783         if (msg->num_fds > RTE_MP_MAX_FD_NUM) {
784                 RTE_LOG(ERR, EAL, "Cannot send more than %d FDs\n",
785                         RTE_MP_MAX_FD_NUM);
786                 rte_errno = E2BIG;
787                 return -1;
788         }
789
790         return 0;
791 }
792
793 int __rte_experimental
794 rte_mp_sendmsg(struct rte_mp_msg *msg)
795 {
796         if (check_input(msg) != 0)
797                 return -1;
798
799         RTE_LOG(DEBUG, EAL, "sendmsg: %s\n", msg->name);
800         return mp_send(msg, NULL, MP_MSG);
801 }
802
803 static int
804 mp_request_async(const char *dst, struct rte_mp_msg *req,
805                 struct async_request_param *param, const struct timespec *ts)
806 {
807         struct rte_mp_msg *reply_msg;
808         struct pending_request *pending_req, *exist;
809         int ret = -1;
810
811         pending_req = calloc(1, sizeof(*pending_req));
812         reply_msg = calloc(1, sizeof(*reply_msg));
813         if (pending_req == NULL || reply_msg == NULL) {
814                 RTE_LOG(ERR, EAL, "Could not allocate space for sync request\n");
815                 rte_errno = ENOMEM;
816                 ret = -1;
817                 goto fail;
818         }
819
820         pending_req->type = REQUEST_TYPE_ASYNC;
821         strlcpy(pending_req->dst, dst, sizeof(pending_req->dst));
822         pending_req->request = req;
823         pending_req->reply = reply_msg;
824         pending_req->async.param = param;
825
826         /* queue already locked by caller */
827
828         exist = find_pending_request(dst, req->name);
829         if (exist) {
830                 RTE_LOG(ERR, EAL, "A pending request %s:%s\n", dst, req->name);
831                 rte_errno = EEXIST;
832                 ret = -1;
833                 goto fail;
834         }
835
836         ret = send_msg(dst, req, MP_REQ);
837         if (ret < 0) {
838                 RTE_LOG(ERR, EAL, "Fail to send request %s:%s\n",
839                         dst, req->name);
840                 ret = -1;
841                 goto fail;
842         } else if (ret == 0) {
843                 ret = 0;
844                 goto fail;
845         }
846         param->user_reply.nb_sent++;
847
848         /* if alarm set fails, we simply ignore the reply */
849         if (rte_eal_alarm_set(ts->tv_sec * 1000000 + ts->tv_nsec / 1000,
850                               async_reply_handle, pending_req) < 0) {
851                 RTE_LOG(ERR, EAL, "Fail to set alarm for request %s:%s\n",
852                         dst, req->name);
853                 ret = -1;
854                 goto fail;
855         }
856         TAILQ_INSERT_TAIL(&pending_requests.requests, pending_req, next);
857
858         return 0;
859 fail:
860         free(pending_req);
861         free(reply_msg);
862         return ret;
863 }
864
865 static int
866 mp_request_sync(const char *dst, struct rte_mp_msg *req,
867                struct rte_mp_reply *reply, const struct timespec *ts)
868 {
869         int ret;
870         struct rte_mp_msg msg, *tmp;
871         struct pending_request pending_req, *exist;
872
873         pending_req.type = REQUEST_TYPE_SYNC;
874         pending_req.reply_received = 0;
875         strlcpy(pending_req.dst, dst, sizeof(pending_req.dst));
876         pending_req.request = req;
877         pending_req.reply = &msg;
878         pthread_cond_init(&pending_req.sync.cond, NULL);
879
880         exist = find_pending_request(dst, req->name);
881         if (exist) {
882                 RTE_LOG(ERR, EAL, "A pending request %s:%s\n", dst, req->name);
883                 rte_errno = EEXIST;
884                 return -1;
885         }
886
887         ret = send_msg(dst, req, MP_REQ);
888         if (ret < 0) {
889                 RTE_LOG(ERR, EAL, "Fail to send request %s:%s\n",
890                         dst, req->name);
891                 return -1;
892         } else if (ret == 0)
893                 return 0;
894
895         TAILQ_INSERT_TAIL(&pending_requests.requests, &pending_req, next);
896
897         reply->nb_sent++;
898
899         do {
900                 ret = pthread_cond_timedwait(&pending_req.sync.cond,
901                                 &pending_requests.lock, ts);
902         } while (ret != 0 && ret != ETIMEDOUT);
903
904         TAILQ_REMOVE(&pending_requests.requests, &pending_req, next);
905
906         if (pending_req.reply_received == 0) {
907                 RTE_LOG(ERR, EAL, "Fail to recv reply for request %s:%s\n",
908                         dst, req->name);
909                 rte_errno = ETIMEDOUT;
910                 return -1;
911         }
912         if (pending_req.reply_received == -1) {
913                 RTE_LOG(DEBUG, EAL, "Asked to ignore response\n");
914                 /* not receiving this message is not an error, so decrement
915                  * number of sent messages
916                  */
917                 reply->nb_sent--;
918                 return 0;
919         }
920
921         tmp = realloc(reply->msgs, sizeof(msg) * (reply->nb_received + 1));
922         if (!tmp) {
923                 RTE_LOG(ERR, EAL, "Fail to alloc reply for request %s:%s\n",
924                         dst, req->name);
925                 rte_errno = ENOMEM;
926                 return -1;
927         }
928         memcpy(&tmp[reply->nb_received], &msg, sizeof(msg));
929         reply->msgs = tmp;
930         reply->nb_received++;
931         return 0;
932 }
933
934 int __rte_experimental
935 rte_mp_request_sync(struct rte_mp_msg *req, struct rte_mp_reply *reply,
936                 const struct timespec *ts)
937 {
938         int dir_fd, ret = -1;
939         DIR *mp_dir;
940         struct dirent *ent;
941         struct timeval now;
942         struct timespec end;
943
944         RTE_LOG(DEBUG, EAL, "request: %s\n", req->name);
945
946         reply->nb_sent = 0;
947         reply->nb_received = 0;
948         reply->msgs = NULL;
949
950         if (check_input(req) != 0)
951                 goto end;
952
953         if (internal_config.no_shconf) {
954                 RTE_LOG(DEBUG, EAL, "No shared files mode enabled, IPC is disabled\n");
955                 return 0;
956         }
957
958         if (gettimeofday(&now, NULL) < 0) {
959                 RTE_LOG(ERR, EAL, "Failed to get current time\n");
960                 rte_errno = errno;
961                 goto end;
962         }
963
964         end.tv_nsec = (now.tv_usec * 1000 + ts->tv_nsec) % 1000000000;
965         end.tv_sec = now.tv_sec + ts->tv_sec +
966                         (now.tv_usec * 1000 + ts->tv_nsec) / 1000000000;
967
968         /* for secondary process, send request to the primary process only */
969         if (rte_eal_process_type() == RTE_PROC_SECONDARY) {
970                 pthread_mutex_lock(&pending_requests.lock);
971                 ret = mp_request_sync(eal_mp_socket_path(), req, reply, &end);
972                 pthread_mutex_unlock(&pending_requests.lock);
973                 goto end;
974         }
975
976         /* for primary process, broadcast request, and collect reply 1 by 1 */
977         mp_dir = opendir(mp_dir_path);
978         if (!mp_dir) {
979                 RTE_LOG(ERR, EAL, "Unable to open directory %s\n", mp_dir_path);
980                 rte_errno = errno;
981                 goto end;
982         }
983
984         dir_fd = dirfd(mp_dir);
985         /* lock the directory to prevent processes spinning up while we send */
986         if (flock(dir_fd, LOCK_SH)) {
987                 RTE_LOG(ERR, EAL, "Unable to lock directory %s\n",
988                         mp_dir_path);
989                 rte_errno = errno;
990                 goto close_end;
991         }
992
993         pthread_mutex_lock(&pending_requests.lock);
994         while ((ent = readdir(mp_dir))) {
995                 char path[PATH_MAX];
996
997                 if (fnmatch(mp_filter, ent->d_name, 0) != 0)
998                         continue;
999
1000                 snprintf(path, sizeof(path), "%s/%s", mp_dir_path,
1001                          ent->d_name);
1002
1003                 /* unlocks the mutex while waiting for response,
1004                  * locks on receive
1005                  */
1006                 if (mp_request_sync(path, req, reply, &end))
1007                         goto unlock_end;
1008         }
1009         ret = 0;
1010
1011 unlock_end:
1012         pthread_mutex_unlock(&pending_requests.lock);
1013         /* unlock the directory */
1014         flock(dir_fd, LOCK_UN);
1015
1016 close_end:
1017         /* dir_fd automatically closed on closedir */
1018         closedir(mp_dir);
1019
1020 end:
1021         if (ret) {
1022                 free(reply->msgs);
1023                 reply->nb_received = 0;
1024                 reply->msgs = NULL;
1025         }
1026         return ret;
1027 }
1028
1029 int __rte_experimental
1030 rte_mp_request_async(struct rte_mp_msg *req, const struct timespec *ts,
1031                 rte_mp_async_reply_t clb)
1032 {
1033         struct rte_mp_msg *copy;
1034         struct pending_request *dummy;
1035         struct async_request_param *param;
1036         struct rte_mp_reply *reply;
1037         int dir_fd, ret = 0;
1038         DIR *mp_dir;
1039         struct dirent *ent;
1040         struct timeval now;
1041         struct timespec *end;
1042         bool dummy_used = false;
1043
1044         RTE_LOG(DEBUG, EAL, "request: %s\n", req->name);
1045
1046         if (check_input(req) != 0)
1047                 return -1;
1048
1049         if (internal_config.no_shconf) {
1050                 RTE_LOG(DEBUG, EAL, "No shared files mode enabled, IPC is disabled\n");
1051                 return 0;
1052         }
1053
1054         if (gettimeofday(&now, NULL) < 0) {
1055                 RTE_LOG(ERR, EAL, "Faile to get current time\n");
1056                 rte_errno = errno;
1057                 return -1;
1058         }
1059         copy = calloc(1, sizeof(*copy));
1060         dummy = calloc(1, sizeof(*dummy));
1061         param = calloc(1, sizeof(*param));
1062         if (copy == NULL || dummy == NULL || param == NULL) {
1063                 RTE_LOG(ERR, EAL, "Failed to allocate memory for async reply\n");
1064                 rte_errno = ENOMEM;
1065                 goto fail;
1066         }
1067
1068         /* copy message */
1069         memcpy(copy, req, sizeof(*copy));
1070
1071         param->n_responses_processed = 0;
1072         param->clb = clb;
1073         end = &param->end;
1074         reply = &param->user_reply;
1075
1076         end->tv_nsec = (now.tv_usec * 1000 + ts->tv_nsec) % 1000000000;
1077         end->tv_sec = now.tv_sec + ts->tv_sec +
1078                         (now.tv_usec * 1000 + ts->tv_nsec) / 1000000000;
1079         reply->nb_sent = 0;
1080         reply->nb_received = 0;
1081         reply->msgs = NULL;
1082
1083         /* we have to lock the request queue here, as we will be adding a bunch
1084          * of requests to the queue at once, and some of the replies may arrive
1085          * before we add all of the requests to the queue.
1086          */
1087         pthread_mutex_lock(&pending_requests.lock);
1088
1089         /* we have to ensure that callback gets triggered even if we don't send
1090          * anything, therefore earlier we have allocated a dummy request. fill
1091          * it, and put it on the queue if we don't send any requests.
1092          */
1093         dummy->type = REQUEST_TYPE_ASYNC;
1094         dummy->request = copy;
1095         dummy->reply = NULL;
1096         dummy->async.param = param;
1097         dummy->reply_received = 1; /* short-circuit the timeout */
1098
1099         /* for secondary process, send request to the primary process only */
1100         if (rte_eal_process_type() == RTE_PROC_SECONDARY) {
1101                 ret = mp_request_async(eal_mp_socket_path(), copy, param, ts);
1102
1103                 /* if we didn't send anything, put dummy request on the queue */
1104                 if (ret == 0 && reply->nb_sent == 0) {
1105                         TAILQ_INSERT_TAIL(&pending_requests.requests, dummy,
1106                                         next);
1107                         dummy_used = true;
1108                 }
1109
1110                 pthread_mutex_unlock(&pending_requests.lock);
1111
1112                 /* if we couldn't send anything, clean up */
1113                 if (ret != 0)
1114                         goto fail;
1115                 return 0;
1116         }
1117
1118         /* for primary process, broadcast request */
1119         mp_dir = opendir(mp_dir_path);
1120         if (!mp_dir) {
1121                 RTE_LOG(ERR, EAL, "Unable to open directory %s\n", mp_dir_path);
1122                 rte_errno = errno;
1123                 goto unlock_fail;
1124         }
1125         dir_fd = dirfd(mp_dir);
1126
1127         /* lock the directory to prevent processes spinning up while we send */
1128         if (flock(dir_fd, LOCK_SH)) {
1129                 RTE_LOG(ERR, EAL, "Unable to lock directory %s\n",
1130                         mp_dir_path);
1131                 rte_errno = errno;
1132                 goto closedir_fail;
1133         }
1134
1135         while ((ent = readdir(mp_dir))) {
1136                 char path[PATH_MAX];
1137
1138                 if (fnmatch(mp_filter, ent->d_name, 0) != 0)
1139                         continue;
1140
1141                 snprintf(path, sizeof(path), "%s/%s", mp_dir_path,
1142                          ent->d_name);
1143
1144                 if (mp_request_async(path, copy, param, ts))
1145                         ret = -1;
1146         }
1147         /* if we didn't send anything, put dummy request on the queue */
1148         if (ret == 0 && reply->nb_sent == 0) {
1149                 TAILQ_INSERT_HEAD(&pending_requests.requests, dummy, next);
1150                 dummy_used = true;
1151         }
1152
1153         /* finally, unlock the queue */
1154         pthread_mutex_unlock(&pending_requests.lock);
1155
1156         /* unlock the directory */
1157         flock(dir_fd, LOCK_UN);
1158
1159         /* dir_fd automatically closed on closedir */
1160         closedir(mp_dir);
1161
1162         /* if dummy was unused, free it */
1163         if (!dummy_used)
1164                 free(dummy);
1165
1166         return ret;
1167 closedir_fail:
1168         closedir(mp_dir);
1169 unlock_fail:
1170         pthread_mutex_unlock(&pending_requests.lock);
1171 fail:
1172         free(dummy);
1173         free(param);
1174         free(copy);
1175         return -1;
1176 }
1177
1178 int __rte_experimental
1179 rte_mp_reply(struct rte_mp_msg *msg, const char *peer)
1180 {
1181         RTE_LOG(DEBUG, EAL, "reply: %s\n", msg->name);
1182
1183         if (check_input(msg) != 0)
1184                 return -1;
1185
1186         if (peer == NULL) {
1187                 RTE_LOG(ERR, EAL, "peer is not specified\n");
1188                 rte_errno = EINVAL;
1189                 return -1;
1190         }
1191
1192         if (internal_config.no_shconf) {
1193                 RTE_LOG(DEBUG, EAL, "No shared files mode enabled, IPC is disabled\n");
1194                 return 0;
1195         }
1196
1197         return mp_send(msg, peer, MP_REP);
1198 }