lib/librte_eal/common/include/rte_launch.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2010-2012 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  */
  34
  35 #ifndef _RTE_LAUNCH_H_
  36 #define _RTE_LAUNCH_H_
  37
  38 /**
  39  * @file
  40  *
  41  * Launch tasks on other lcores
  42  */
  43
  44 #ifdef __cplusplus
  45 extern "C" {
  46 #endif
  47
  48 /**
  49  * State of an lcore.
  50  */
  51 enum rte_lcore_state_t {
  52         WAIT,       /**< waiting a new command */
  53         RUNNING,    /**< executing command */
  54         FINISHED,   /**< command executed */
  55 };
  56
  57 /**
  58  * Definition of a remote launch function.
  59  */
  60 typedef int (lcore_function_t)(void *);
  61
  62 /**
  63  * Launch a function on another lcore.
  64  *
  65  * To be executed on the MASTER lcore only.
  66  *
  67  * Sends a message to a slave lcore (identified by the slave_id) that
  68  * is in the WAIT state (this is true after the first call to
  69  * rte_eal_init()). This can be checked by first calling
  70  * rte_eal_wait_lcore(slave_id).
  71  *
  72  * When the remote lcore receives the message, it switches to
  73  * the RUNNING state, then calls the function f with argument arg. Once the
  74  * execution is done, the remote lcore switches to a FINISHED state and
  75  * the return value of f is stored in a local variable to be read using
  76  * rte_eal_wait_lcore().
  77  *
  78  * The MASTER lcore returns as soon as the message is sent and knows
  79  * nothing about the completion of f.
  80  *
  81  * Note: This function is not designed to offer optimum
  82  * performance. It is just a practical way to launch a function on
  83  * another lcore at initialization time.
  84  *
  85  * @param f
  86  *   The function to be called.
  87  * @param arg
  88  *   The argument for the function.
  89  * @param slave_id
  90  *   The identifier of the lcore on which the function should be executed.
  91  * @return
  92  *   - 0: Success. Execution of function f started on the remote lcore.
  93  *   - (-EBUSY): The remote lcore is not in a WAIT state.
  94  */
  95 int rte_eal_remote_launch(lcore_function_t *f, void *arg, unsigned slave_id);
  96
  97 /**
  98  * This enum indicates whether the master core must execute the handler
  99  * launched on all logical cores.
 100  */
 101 enum rte_rmt_call_master_t {
 102         SKIP_MASTER = 0, /**< lcore handler not executed by master core. */
 103         CALL_MASTER,     /**< lcore handler executed by master core. */
 104 };
 105
 106 /**
 107  * Launch a function on all lcores.
 108  *
 109  * Check that each SLAVE lcore is in a WAIT state, then call
 110  * rte_eal_remote_launch() for each lcore.
 111  *
 112  * @param f
 113  *   The function to be called.
 114  * @param arg
 115  *   The argument for the function.
 116  * @param call_master
 117  *   If call_master set to SKIP_MASTER, the MASTER lcore does not call
 118  *   the function. If call_master is set to CALL_MASTER, the function
 119  *   is also called on master before returning. In any case, the master
 120  *   lcore returns as soon as it finished its job and knows nothing
 121  *   about the completion of f on the other lcores.
 122  * @return
 123  *   - 0: Success. Execution of function f started on all remote lcores.
 124  *   - (-EBUSY): At least one remote lcore is not in a WAIT state. In this
 125  *     case, no message is sent to any of the lcores.
 126  */
 127 int rte_eal_mp_remote_launch(lcore_function_t *f, void *arg,
 128                              enum rte_rmt_call_master_t call_master);
 129
 130 /**
 131  * Get the state of the lcore identified by slave_id.
 132  *
 133  * To be executed on the MASTER lcore only.
 134  *
 135  * @param slave_id
 136  *   The identifier of the lcore.
 137  * @return
 138  *   The state of the lcore.
 139  */
 140 enum rte_lcore_state_t rte_eal_get_lcore_state(unsigned slave_id);
 141
 142 /**
 143  * Wait until an lcore finishes its job.
 144  *
 145  * To be executed on the MASTER lcore only.
 146  *
 147  * If the slave lcore identified by the slave_id is in a FINISHED state,
 148  * switch to the WAIT state. If the lcore is in RUNNING state, wait until
 149  * the lcore finishes its job and moves to the FINISHED state.
 150  *
 151  * @param slave_id
 152  *   The identifier of the lcore.
 153  * @return
 154  *   - 0: If the lcore identified by the slave_id is in a WAIT state.
 155  *   - The value that was returned by the previous remote launch
 156  *     function call if the lcore identified by the slave_id was in a
 157  *     FINISHED or RUNNING state. In this case, it changes the state
 158  *     of the lcore to WAIT.
 159  */
 160 int rte_eal_wait_lcore(unsigned slave_id);
 161
 162 /**
 163  * Wait until all lcores finish their jobs.
 164  *
 165  * To be executed on the MASTER lcore only. Issue an
 166  * rte_eal_wait_lcore() for every lcore. The return values are
 167  * ignored.
 168  *
 169  * After a call to rte_eal_mp_wait_lcores(), the caller can assume
 170  * that all slave lcores are in a WAIT state.
 171  */
 172 void rte_eal_mp_wait_lcore(void);
 173
 174 #ifdef __cplusplus
 175 }
 176 #endif
 177
 178 #endif /* _RTE_LAUNCH_H_ */