f1ce0bdaafc7aa070bec619bbfa9c10d3d45ea87
[dpdk.git] / lib / librte_eal / common / eal_thread.h
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
34 #ifndef EAL_THREAD_H
35 #define EAL_THREAD_H
36
37 /**
38  * basic loop of thread, called for each thread by eal_init().
39  *
40  * @param arg
41  *   opaque pointer
42  */
43 __attribute__((noreturn)) void *eal_thread_loop(void *arg);
44
45 /**
46  * Init per-lcore info for master thread
47  *
48  * @param lcore_id
49  *   identifier of master lcore
50  */
51 void eal_thread_init_master(unsigned lcore_id);
52
53 /**
54  * Get the NUMA socket id from cpu id.
55  * This function is private to EAL.
56  *
57  * @param cpu_id
58  *   The logical process id.
59  * @return
60  *   socket_id or SOCKET_ID_ANY
61  */
62 unsigned eal_cpu_socket_id(unsigned cpu_id);
63
64 #endif /* EAL_THREAD_H */