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 <stdio.h>
  39 #include <rte_pci.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 struct rte_pci_driver;
 113 struct rte_pci_device;
 114
 115 /**
 116  * Add a PCI device to the PCI Bus (append to PCI Device list). This function
 117  * also updates the bus references of the PCI Device (and the generic device
 118  * object embedded within.
 119  *
 120  * @param pci_dev
 121  *      PCI device to add
 122  * @return void
 123  */
 124 void rte_pci_add_device(struct rte_pci_device *pci_dev);
 125
 126 /**
 127  * Insert a PCI device in the PCI Bus at a particular location in the device
 128  * list. It also updates the PCI Bus reference of the new devices to be
 129  * inserted.
 130  *
 131  * @param exist_pci_dev
 132  *      Existing PCI device in PCI Bus
 133  * @param new_pci_dev
 134  *      PCI device to be added before exist_pci_dev
 135  * @return void
 136  */
 137 void rte_pci_insert_device(struct rte_pci_device *exist_pci_dev,
 138                 struct rte_pci_device *new_pci_dev);
 139
 140 /**
 141  * Remove a PCI device from the PCI Bus. This sets to NULL the bus references
 142  * in the PCI device object as well as the generic device object.
 143  *
 144  * @param pci_device
 145  *      PCI device to be removed from PCI Bus
 146  * @return void
 147  */
 148 void rte_pci_remove_device(struct rte_pci_device *pci_device);
 149
 150 /**
 151  * Update a pci device object by asking the kernel for the latest information.
 152  *
 153  * This function is private to EAL.
 154  *
 155  * @param addr
 156  *      The PCI Bus-Device-Function address to look for
 157  * @return
 158  *   - 0 on success.
 159  *   - negative on error.
 160  */
 161 int pci_update_device(const struct rte_pci_addr *addr);
 162
 163 /**
 164  * Unbind kernel driver for this device
 165  *
 166  * This function is private to EAL.
 167  *
 168  * @return
 169  *   0 on success, negative on error
 170  */
 171 int pci_unbind_kernel_driver(struct rte_pci_device *dev);
 172
 173 /**
 174  * Map the PCI resource of a PCI device in virtual memory
 175  *
 176  * This function is private to EAL.
 177  *
 178  * @return
 179  *   0 on success, negative on error
 180  */
 181 int pci_uio_map_resource(struct rte_pci_device *dev);
 182
 183 /**
 184  * Unmap the PCI resource of a PCI device
 185  *
 186  * This function is private to EAL.
 187  */
 188 void pci_uio_unmap_resource(struct rte_pci_device *dev);
 189
 190 /**
 191  * Allocate uio resource for PCI device
 192  *
 193  * This function is private to EAL.
 194  *
 195  * @param dev
 196  *   PCI device to allocate uio resource
 197  * @param uio_res
 198  *   Pointer to uio resource.
 199  *   If the function returns 0, the pointer will be filled.
 200  * @return
 201  *   0 on success, negative on error
 202  */
 203 int pci_uio_alloc_resource(struct rte_pci_device *dev,
 204                 struct mapped_pci_resource **uio_res);
 205
 206 /**
 207  * Free uio resource for PCI device
 208  *
 209  * This function is private to EAL.
 210  *
 211  * @param dev
 212  *   PCI device to free uio resource
 213  * @param uio_res
 214  *   Pointer to uio resource.
 215  */
 216 void pci_uio_free_resource(struct rte_pci_device *dev,
 217                 struct mapped_pci_resource *uio_res);
 218
 219 /**
 220  * Map device memory to uio resource
 221  *
 222  * This function is private to EAL.
 223  *
 224  * @param dev
 225  *   PCI device that has memory information.
 226  * @param res_idx
 227  *   Memory resource index of the PCI device.
 228  * @param uio_res
 229  *  uio resource that will keep mapping information.
 230  * @param map_idx
 231  *   Mapping information index of the uio resource.
 232  * @return
 233  *   0 on success, negative on error
 234  */
 235 int pci_uio_map_resource_by_index(struct rte_pci_device *dev, int res_idx,
 236                 struct mapped_pci_resource *uio_res, int map_idx);
 237
 238 /**
 239  * Init tail queues for non-EAL library structures. This is to allow
 240  * the rings, mempools, etc. lists to be shared among multiple processes
 241  *
 242  * This function is private to EAL
 243  *
 244  * @return
 245  *    0 on success, negative on error
 246  */
 247 int rte_eal_tailqs_init(void);
 248
 249 /**
 250  * Init interrupt handling.
 251  *
 252  * This function is private to EAL.
 253  *
 254  * @return
 255  *  0 on success, negative on error
 256  */
 257 int rte_eal_intr_init(void);
 258
 259 /**
 260  * Init alarm mechanism. This is to allow a callback be called after
 261  * specific time.
 262  *
 263  * This function is private to EAL.
 264  *
 265  * @return
 266  *  0 on success, negative on error
 267  */
 268 int rte_eal_alarm_init(void);
 269
 270 /**
 271  * Function is to check if the kernel module(like, vfio, vfio_iommu_type1,
 272  * etc.) loaded.
 273  *
 274  * @param module_name
 275  *      The module's name which need to be checked
 276  *
 277  * @return
 278  *      -1 means some error happens(NULL pointer or open failure)
 279  *      0  means the module not loaded
 280  *      1  means the module loaded
 281  */
 282 int rte_eal_check_module(const char *module_name);
 283
 284 /**
 285  * Get cpu core_id.
 286  *
 287  * This function is private to the EAL.
 288  */
 289 unsigned eal_cpu_core_id(unsigned lcore_id);
 290
 291 /**
 292  * Check if cpu is present.
 293  *
 294  * This function is private to the EAL.
 295  */
 296 int eal_cpu_detected(unsigned lcore_id);
 297
 298 /**
 299  * Set TSC frequency from precise value or estimation
 300  *
 301  * This function is private to the EAL.
 302  */
 303 void set_tsc_freq(void);
 304
 305 /**
 306  * Get precise TSC frequency from system
 307  *
 308  * This function is private to the EAL.
 309  */
 310 uint64_t get_tsc_freq(void);
 311
 312 /**
 313  * Prepare physical memory mapping
 314  * i.e. hugepages on Linux and
 315  *      contigmem on BSD.
 316  *
 317  * This function is private to the EAL.
 318  */
 319 int rte_eal_hugepage_init(void);
 320
 321 /**
 322  * Creates memory mapping in secondary process
 323  * i.e. hugepages on Linux and
 324  *      contigmem on BSD.
 325  *
 326  * This function is private to the EAL.
 327  */
 328 int rte_eal_hugepage_attach(void);
 329
 330 /**
 331  * Returns true if the system is able to obtain
 332  * physical addresses. Return false if using DMA
 333  * addresses through an IOMMU.
 334  *
 335  * Drivers based on uio will not load unless physical
 336  * addresses are obtainable. It is only possible to get
 337  * physical addresses when running as a privileged user.
 338  */
 339 bool rte_eal_using_phys_addrs(void);
 340
 341 #endif /* _EAL_PRIVATE_H_ */