examples/multi_process/l2fwd_fork/flib.c

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
   5  *   All rights reserved.
   6  *
   7  *   Redistribution and use in source and binary forms, with or without
   8  *   modification, are permitted provided that the following conditions
   9  *   are met:
  10  *
  11  *     * Redistributions of source code must retain the above copyright
  12  *       notice, this list of conditions and the following disclaimer.
  13  *     * Redistributions in binary form must reproduce the above copyright
  14  *       notice, this list of conditions and the following disclaimer in
  15  *       the documentation and/or other materials provided with the
  16  *       distribution.
  17  *     * Neither the name of Intel Corporation nor the names of its
  18  *       contributors may be used to endorse or promote products derived
  19  *       from this software without specific prior written permission.
  20  *
  21  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  24  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  25  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  26  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  27  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  28  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  29  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  30  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  31  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32  */
  33 #include <unistd.h>
  34 #include <stdio.h>
  35 #include <stdlib.h>
  36 #include <string.h>
  37 #include <stdint.h>
  38 #include <inttypes.h>
  39 #include <sys/types.h>
  40 #include <sys/queue.h>
  41 #include <sys/wait.h>
  42 #include <sys/prctl.h>
  43 #include <netinet/in.h>
  44 #include <setjmp.h>
  45 #include <stdarg.h>
  46 #include <ctype.h>
  47 #include <errno.h>
  48 #include <getopt.h>
  49 #include <dirent.h>
  50 #include <signal.h>
  51
  52 #include <rte_common.h>
  53 #include <rte_log.h>
  54 #include <rte_malloc.h>
  55 #include <rte_memory.h>
  56 #include <rte_memcpy.h>
  57 #include <rte_memzone.h>
  58 #include <rte_eal.h>
  59 #include <rte_launch.h>
  60 #include <rte_atomic.h>
  61 #include <rte_cycles.h>
  62 #include <rte_prefetch.h>
  63 #include <rte_lcore.h>
  64 #include <rte_per_lcore.h>
  65 #include <rte_branch_prediction.h>
  66 #include <rte_interrupts.h>
  67 #include <rte_pci.h>
  68 #include <rte_random.h>
  69 #include <rte_debug.h>
  70 #include <rte_ether.h>
  71 #include <rte_ethdev.h>
  72 #include <rte_mempool.h>
  73 #include <rte_mbuf.h>
  74 #include <rte_string_fns.h>
  75
  76 #include "flib.h"
  77
  78 #define SIG_PARENT_EXIT SIGUSR1
  79
  80 struct lcore_stat {
  81         pid_t pid;           /**< pthread identifier */
  82         lcore_function_t *f; /**< function to call */
  83         void *arg;           /**< argument of function */
  84         slave_exit_notify *cb_fn;
  85 } __rte_cache_aligned;
  86
  87
  88 static struct lcore_stat *core_cfg;
  89 static uint16_t *lcore_cfg = NULL;
  90
  91 /* signal handler to be notified after parent leaves */
  92 static void
  93 sighand_parent_exit(int sig)
  94 {
  95         printf("lcore = %u : Find parent leaves, sig=%d\n", rte_lcore_id(),
  96                         sig);
  97         printf("Child leaving\n");
  98         exit(0);
  99
 100         return;
 101 }
 102
 103 /**
 104  * Real function entrance ran in slave process
 105  **/
 106 static int
 107 slave_proc_func(void)
 108 {
 109         struct rte_config *config;
 110         unsigned slave_id = rte_lcore_id();
 111         struct lcore_stat *cfg = &core_cfg[slave_id];
 112
 113         if (prctl(PR_SET_PDEATHSIG, SIG_PARENT_EXIT, 0, 0, 0, 0) != 0)
 114                 printf("Warning: Slave can't register for being notified in"
 115                "case master process exited\n");
 116         else {
 117                 struct sigaction act;
 118                 memset(&act, 0 , sizeof(act));
 119                 act.sa_handler = sighand_parent_exit;
 120                 if (sigaction(SIG_PARENT_EXIT, &act, NULL) != 0)
 121                         printf("Fail to register signal handler:%d\n", SIG_PARENT_EXIT);
 122         }
 123
 124         /* Set slave process to SECONDARY to avoid operation like dev_start/stop etc */
 125         config = rte_eal_get_configuration();
 126         if (NULL == config)
 127                 printf("Warning:Can't get rte_config\n");
 128         else
 129                 config->process_type = RTE_PROC_SECONDARY;
 130
 131         printf("Core %u is ready (pid=%d)\n", slave_id, (int)cfg->pid);
 132
 133         exit(cfg->f(cfg->arg));
 134 }
 135
 136 /**
 137  * function entrance ran in master thread, which will spawn slave process and wait until
 138  * specific slave exited.
 139  **/
 140 static int
 141 lcore_func(void *arg __attribute__((unused)))
 142 {
 143         unsigned slave_id = rte_lcore_id();
 144         struct lcore_stat *cfg = &core_cfg[slave_id];
 145         int pid, stat;
 146
 147         if (rte_get_master_lcore() == slave_id)
 148                 return cfg->f(cfg->arg);
 149
 150         /* fork a slave process */
 151         pid = fork();
 152
 153         if (pid == -1) {
 154                 printf("Failed to fork\n");
 155                 return -1;
 156         } else if (pid == 0) /* child */
 157                 return slave_proc_func();
 158         else { /* parent */
 159                 cfg->pid = pid;
 160
 161                 waitpid(pid, &stat, 0);
 162
 163                 cfg->pid = 0;
 164                 cfg->f = NULL;
 165                 cfg->arg = NULL;
 166                 /* Notify slave's exit if applicable */
 167                 if(cfg->cb_fn)
 168                         cfg->cb_fn(slave_id, stat);
 169                 return stat;
 170         }
 171 }
 172
 173 static int
 174 lcore_id_init(void)
 175 {
 176         int i;
 177         /* Setup lcore ID allocation map */
 178         lcore_cfg = rte_zmalloc("LCORE_ID_MAP",
 179                                                 sizeof(uint16_t) * RTE_MAX_LCORE,
 180                                                 RTE_CACHE_LINE_SIZE);
 181
 182         if(lcore_cfg == NULL)
 183                 rte_panic("Failed to malloc\n");
 184
 185         for (i = 0; i < RTE_MAX_LCORE; i++) {
 186                 if (rte_lcore_is_enabled(i))
 187                         lcore_cfg[i] = 1;
 188         }
 189         return 0;
 190 }
 191
 192 int
 193 flib_assign_lcore_id(void)
 194 {
 195         unsigned i;
 196         int ret;
 197
 198         /**
 199          * thread assigned a lcore id previously, or a  slave thread. But still have
 200          * a bug here: If the core mask includes core 0, and that core call this
 201          * function, it still can get a new lcore id.
 202          **/
 203         if (rte_lcore_id() != 0)
 204                 return -1;
 205
 206         do {
 207                 /* Find a lcore id not used yet, avoid to use lcore ID 0 */
 208                 for (i = 1; i < RTE_MAX_LCORE; i++) {
 209                         if (lcore_cfg[i] == 0)
 210                                 break;
 211                 }
 212                 if (i == RTE_MAX_LCORE)
 213                         return -1;
 214
 215                 /* Assign new lcore id to this thread */
 216
 217                 ret = rte_atomic16_cmpset(&lcore_cfg[i], 0, 1);
 218         } while (unlikely(ret == 0));
 219
 220         RTE_PER_LCORE(_lcore_id) = i;
 221         return i;
 222 }
 223
 224 void
 225 flib_free_lcore_id(unsigned lcore_id)
 226 {
 227         /* id is not valid or belongs to pinned core id */
 228         if (lcore_id >= RTE_MAX_LCORE || lcore_id == 0 ||
 229                 rte_lcore_is_enabled(lcore_id))
 230                 return;
 231
 232         lcore_cfg[lcore_id] = 0;
 233 }
 234
 235 int
 236 flib_register_slave_exit_notify(unsigned slave_id,
 237         slave_exit_notify *cb)
 238 {
 239         if (cb == NULL)
 240                 return -EFAULT;
 241
 242         if (!rte_lcore_is_enabled(slave_id))
 243                 return -ENOENT;
 244
 245         core_cfg[slave_id].cb_fn = cb;
 246
 247         return 0;
 248 }
 249
 250 enum slave_stat
 251 flib_query_slave_status(unsigned slave_id)
 252 {
 253         if (!rte_lcore_is_enabled(slave_id))
 254                 return ST_FREEZE;
 255         /* pid only be set when slave process spawned */
 256         if (core_cfg[slave_id].pid != 0)
 257                 return ST_RUN;
 258         else
 259                 return ST_IDLE;
 260 }
 261
 262 int
 263 flib_remote_launch(lcore_function_t *f,
 264                                         void *arg, unsigned slave_id)
 265 {
 266         if (f == NULL)
 267                 return -1;
 268
 269         if (!rte_lcore_is_enabled(slave_id))
 270                 return -1;
 271
 272         /* Wait until specific lcore state change to WAIT */
 273         rte_eal_wait_lcore(slave_id);
 274
 275         core_cfg[slave_id].f = f;
 276         core_cfg[slave_id].arg = arg;
 277
 278         return rte_eal_remote_launch(lcore_func, NULL, slave_id);
 279 }
 280
 281 int
 282 flib_mp_remote_launch(lcore_function_t *f, void *arg,
 283                         enum rte_rmt_call_master_t call_master)
 284 {
 285         int i;
 286
 287         RTE_LCORE_FOREACH_SLAVE(i) {
 288                 core_cfg[i].arg = arg;
 289                 core_cfg[i].f = f;
 290         }
 291
 292         return rte_eal_mp_remote_launch(lcore_func, NULL, call_master);
 293 }
 294
 295 int
 296 flib_init(void)
 297 {
 298         if ((core_cfg = rte_zmalloc("core_cfg",
 299                 sizeof(struct lcore_stat) * RTE_MAX_LCORE,
 300                 RTE_CACHE_LINE_SIZE)) == NULL ) {
 301                 printf("rte_zmalloc failed\n");
 302                 return -1;
 303         }
 304
 305         if (lcore_id_init() != 0) {
 306                 printf("lcore_id_init failed\n");
 307                 return -1;
 308         }
 309
 310         return 0;
 311 }