lib/librte_eal/common/eal_thread.h

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright(c) 2010-2014 Intel Corporation
   3  */
   4
   5 #ifndef EAL_THREAD_H
   6 #define EAL_THREAD_H
   7
   8 #include <rte_lcore.h>
   9
  10 /**
  11  * basic loop of thread, called for each thread by eal_init().
  12  *
  13  * @param arg
  14  *   opaque pointer
  15  */
  16 __rte_noreturn void *eal_thread_loop(void *arg);
  17
  18 /**
  19  * Init per-lcore info for master thread
  20  *
  21  * @param lcore_id
  22  *   identifier of master lcore
  23  */
  24 void eal_thread_init_master(unsigned lcore_id);
  25
  26 /**
  27  * Get the NUMA socket id from cpu id.
  28  * This function is private to EAL.
  29  *
  30  * @param cpu_id
  31  *   The logical process id.
  32  * @return
  33  *   socket_id or SOCKET_ID_ANY
  34  */
  35 unsigned eal_cpu_socket_id(unsigned cpu_id);
  36
  37 /**
  38  * Default buffer size to use with eal_thread_dump_affinity()
  39  */
  40 #define RTE_CPU_AFFINITY_STR_LEN            256
  41
  42 /**
  43  * Dump the current pthread cpuset.
  44  * This function is private to EAL.
  45  *
  46  * Note:
  47  *   If the dump size is greater than the size of given buffer,
  48  *   the string will be truncated and with '\0' at the end.
  49  *
  50  * @param str
  51  *   The string buffer the cpuset will dump to.
  52  * @param size
  53  *   The string buffer size.
  54  * @return
  55  *   0 for success, -1 if truncation happens.
  56  */
  57 int
  58 eal_thread_dump_affinity(char *str, unsigned size);
  59
  60 #endif /* EAL_THREAD_H */