doc: whitespace changes in licenses
[dpdk.git] / lib / librte_eal / common / eal_common_launch.c
1 /*-
2  *   BSD LICENSE
3  * 
4  *   Copyright(c) 2010-2013 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 #include <errno.h>
35 #include <stdint.h>
36 #include <stdio.h>
37 #include <sys/queue.h>
38
39 #include <rte_launch.h>
40 #include <rte_memory.h>
41 #include <rte_memzone.h>
42 #include <rte_tailq.h>
43 #include <rte_eal.h>
44 #include <rte_atomic.h>
45 #include <rte_per_lcore.h>
46 #include <rte_lcore.h>
47
48 /*
49  * Wait until a lcore finished its job.
50  */
51 int
52 rte_eal_wait_lcore(unsigned slave_id)
53 {
54         if (lcore_config[slave_id].state == WAIT)
55                 return 0;
56
57         while (lcore_config[slave_id].state != WAIT &&
58                lcore_config[slave_id].state != FINISHED);
59
60         rte_rmb();
61
62         /* we are in finished state, go to wait state */
63         lcore_config[slave_id].state = WAIT;
64         return lcore_config[slave_id].ret;
65 }
66
67 /*
68  * Check that every SLAVE lcores are in WAIT state, then call
69  * rte_eal_remote_launch() for all of them. If call_master is true
70  * (set to CALL_MASTER), also call the function on the master lcore.
71  */
72 int
73 rte_eal_mp_remote_launch(int (*f)(void *), void *arg,
74                          enum rte_rmt_call_master_t call_master)
75 {
76         int lcore_id;
77         int master = rte_get_master_lcore();
78
79         /* check state of lcores */
80         RTE_LCORE_FOREACH_SLAVE(lcore_id) {
81                 if (lcore_config[lcore_id].state != WAIT)
82                         return -EBUSY;
83         }
84
85         /* send messages to cores */
86         RTE_LCORE_FOREACH_SLAVE(lcore_id) {
87                 rte_eal_remote_launch(f, arg, lcore_id);
88         }
89
90         if (call_master == CALL_MASTER) {
91                 lcore_config[master].ret = f(arg);
92                 lcore_config[master].state = FINISHED;
93         }
94
95         return 0;
96 }
97
98 /*
99  * Return the state of the lcore identified by slave_id.
100  */
101 enum rte_lcore_state_t
102 rte_eal_get_lcore_state(unsigned lcore_id)
103 {
104         return lcore_config[lcore_id].state;
105 }
106
107 /*
108  * Do a rte_eal_wait_lcore() for every lcore. The return values are
109  * ignored.
110  */
111 void
112 rte_eal_mp_wait_lcore(void)
113 {
114         unsigned lcore_id;
115
116         RTE_LCORE_FOREACH_SLAVE(lcore_id) {
117                 rte_eal_wait_lcore(lcore_id);
118         }
119 }
120