lib/librte_eal/common/eal_private.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_PRIVATE_H_
  35 #define _EAL_PRIVATE_H_
  36
  37 #include <stdbool.h>
  38 #include <stdint.h>
  39 #include <stdio.h>
  40
  41 /**
  42  * Initialize the memzone subsystem (private to eal).
  43  *
  44  * @return
  45  *   - 0 on success
  46  *   - Negative on error
  47  */
  48 int rte_eal_memzone_init(void);
  49
  50 /**
  51  * Common log initialization function (private to eal).  Determines
  52  * where log data is written when no call to rte_openlog_stream is
  53  * in effect.
  54  *
  55  * @param default_log
  56  *   The default log stream to be used.
  57  * @return
  58  *   - 0 on success
  59  *   - Negative on error
  60  */
  61 void eal_log_set_default(FILE *default_log);
  62
  63 /**
  64  * Fill configuration with number of physical and logical processors
  65  *
  66  * This function is private to EAL.
  67  *
  68  * Parse /proc/cpuinfo to get the number of physical and logical
  69  * processors on the machine.
  70  *
  71  * @return
  72  *   0 on success, negative on error
  73  */
  74 int rte_eal_cpu_init(void);
  75
  76 /**
  77  * Map memory
  78  *
  79  * This function is private to EAL.
  80  *
  81  * Fill configuration structure with these infos, and return 0 on success.
  82  *
  83  * @return
  84  *   0 on success, negative on error
  85  */
  86 int rte_eal_memory_init(void);
  87
  88 /**
  89  * Configure timers
  90  *
  91  * This function is private to EAL.
  92  *
  93  * Mmap memory areas used by HPET (high precision event timer) that will
  94  * provide our time reference, and configure the TSC frequency also for it
  95  * to be used as a reference.
  96  *
  97  * @return
  98  *   0 on success, negative on error
  99  */
 100 int rte_eal_timer_init(void);
 101
 102 /**
 103  * Init the default log stream
 104  *
 105  * This function is private to EAL.
 106  *
 107  * @return
 108  *   0 on success, negative on error
 109  */
 110 int rte_eal_log_init(const char *id, int facility);
 111
 112 /**
 113  * Init tail queues for non-EAL library structures. This is to allow
 114  * the rings, mempools, etc. lists to be shared among multiple processes
 115  *
 116  * This function is private to EAL
 117  *
 118  * @return
 119  *    0 on success, negative on error
 120  */
 121 int rte_eal_tailqs_init(void);
 122
 123 /**
 124  * Init interrupt handling.
 125  *
 126  * This function is private to EAL.
 127  *
 128  * @return
 129  *  0 on success, negative on error
 130  */
 131 int rte_eal_intr_init(void);
 132
 133 /**
 134  * Init alarm mechanism. This is to allow a callback be called after
 135  * specific time.
 136  *
 137  * This function is private to EAL.
 138  *
 139  * @return
 140  *  0 on success, negative on error
 141  */
 142 int rte_eal_alarm_init(void);
 143
 144 /**
 145  * Function is to check if the kernel module(like, vfio, vfio_iommu_type1,
 146  * etc.) loaded.
 147  *
 148  * @param module_name
 149  *      The module's name which need to be checked
 150  *
 151  * @return
 152  *      -1 means some error happens(NULL pointer or open failure)
 153  *      0  means the module not loaded
 154  *      1  means the module loaded
 155  */
 156 int rte_eal_check_module(const char *module_name);
 157
 158 /**
 159  * Get cpu core_id.
 160  *
 161  * This function is private to the EAL.
 162  */
 163 unsigned eal_cpu_core_id(unsigned lcore_id);
 164
 165 /**
 166  * Check if cpu is present.
 167  *
 168  * This function is private to the EAL.
 169  */
 170 int eal_cpu_detected(unsigned lcore_id);
 171
 172 /**
 173  * Set TSC frequency from precise value or estimation
 174  *
 175  * This function is private to the EAL.
 176  */
 177 void set_tsc_freq(void);
 178
 179 /**
 180  * Get precise TSC frequency from system
 181  *
 182  * This function is private to the EAL.
 183  */
 184 uint64_t get_tsc_freq(void);
 185
 186 /**
 187  * Get TSC frequency if the architecture supports.
 188  *
 189  * This function is private to the EAL.
 190  *
 191  * @return
 192  *   The number of TSC cycles in one second.
 193  *   Returns zero if the architecture support is not available.
 194  */
 195 uint64_t get_tsc_freq_arch(void);
 196
 197 /**
 198  * Prepare physical memory mapping
 199  * i.e. hugepages on Linux and
 200  *      contigmem on BSD.
 201  *
 202  * This function is private to the EAL.
 203  */
 204 int rte_eal_hugepage_init(void);
 205
 206 /**
 207  * Creates memory mapping in secondary process
 208  * i.e. hugepages on Linux and
 209  *      contigmem on BSD.
 210  *
 211  * This function is private to the EAL.
 212  */
 213 int rte_eal_hugepage_attach(void);
 214
 215 /**
 216  * Find a bus capable of identifying a device.
 217  *
 218  * @param str
 219  *   A device identifier (PCI address, virtual PMD name, ...).
 220  *
 221  * @return
 222  *   A valid bus handle if found.
 223  *   NULL if no bus is able to parse this device.
 224  */
 225 struct rte_bus *rte_bus_find_by_device_name(const char *str);
 226
 227 #endif /* _EAL_PRIVATE_H_ */