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 <stdio.h>
  38 #include <rte_pci.h>
  39
  40 /**
  41  * Initialize the memzone subsystem (private to eal).
  42  *
  43  * @return
  44  *   - 0 on success
  45  *   - Negative on error
  46  */
  47 int rte_eal_memzone_init(void);
  48
  49 /**
  50  * Common log initialization function (private to eal).
  51  *
  52  * @param default_log
  53  *   The default log stream to be used.
  54  * @return
  55  *   - 0 on success
  56  *   - Negative on error
  57  */
  58 int rte_eal_common_log_init(FILE *default_log);
  59
  60 /**
  61  * Fill configuration with number of physical and logical processors
  62  *
  63  * This function is private to EAL.
  64  *
  65  * Parse /proc/cpuinfo to get the number of physical and logical
  66  * processors on the machine.
  67  *
  68  * @return
  69  *   0 on success, negative on error
  70  */
  71 int rte_eal_cpu_init(void);
  72
  73 /**
  74  * Map memory
  75  *
  76  * This function is private to EAL.
  77  *
  78  * Fill configuration structure with these infos, and return 0 on success.
  79  *
  80  * @return
  81  *   0 on success, negative on error
  82  */
  83 int rte_eal_memory_init(void);
  84
  85 /**
  86  * Configure timers
  87  *
  88  * This function is private to EAL.
  89  *
  90  * Mmap memory areas used by HPET (high precision event timer) that will
  91  * provide our time reference, and configure the TSC frequency also for it
  92  * to be used as a reference.
  93  *
  94  * @return
  95  *   0 on success, negative on error
  96  */
  97 int rte_eal_timer_init(void);
  98
  99 /**
 100  * Init early logs
 101  *
 102  * This function is private to EAL.
 103  *
 104  * @return
 105  *   0 on success, negative on error
 106  */
 107 int rte_eal_log_early_init(void);
 108
 109 /**
 110  * Init the default log stream
 111  *
 112  * This function is private to EAL.
 113  *
 114  * @return
 115  *   0 on success, negative on error
 116  */
 117 int rte_eal_log_init(const char *id, int facility);
 118
 119 /**
 120  * Init the PCI infrastructure
 121  *
 122  * This function is private to EAL.
 123  *
 124  * @return
 125  *   0 on success, negative on error
 126  */
 127 int rte_eal_pci_init(void);
 128
 129 struct rte_pci_driver;
 130 struct rte_pci_device;
 131
 132 /**
 133  * Update a pci device object by asking the kernel for the latest information.
 134  *
 135  * This function is private to EAL.
 136  *
 137  * @param addr
 138  *      The PCI Bus-Device-Function address to look for
 139  * @return
 140  *   - 0 on success.
 141  *   - negative on error.
 142  */
 143 int pci_update_device(const struct rte_pci_addr *addr);
 144
 145 /**
 146  * Unbind kernel driver for this device
 147  *
 148  * This function is private to EAL.
 149  *
 150  * @return
 151  *   0 on success, negative on error
 152  */
 153 int pci_unbind_kernel_driver(struct rte_pci_device *dev);
 154
 155 /**
 156  * Map the PCI resource of a PCI device in virtual memory
 157  *
 158  * This function is private to EAL.
 159  *
 160  * @return
 161  *   0 on success, negative on error
 162  */
 163 int pci_uio_map_resource(struct rte_pci_device *dev);
 164
 165 /**
 166  * Unmap the PCI resource of a PCI device
 167  *
 168  * This function is private to EAL.
 169  */
 170 void pci_uio_unmap_resource(struct rte_pci_device *dev);
 171
 172 /**
 173  * Allocate uio resource for PCI device
 174  *
 175  * This function is private to EAL.
 176  *
 177  * @param dev
 178  *   PCI device to allocate uio resource
 179  * @param uio_res
 180  *   Pointer to uio resource.
 181  *   If the function returns 0, the pointer will be filled.
 182  * @return
 183  *   0 on success, negative on error
 184  */
 185 int pci_uio_alloc_resource(struct rte_pci_device *dev,
 186                 struct mapped_pci_resource **uio_res);
 187
 188 /**
 189  * Free uio resource for PCI device
 190  *
 191  * This function is private to EAL.
 192  *
 193  * @param dev
 194  *   PCI device to free uio resource
 195  * @param uio_res
 196  *   Pointer to uio resource.
 197  */
 198 void pci_uio_free_resource(struct rte_pci_device *dev,
 199                 struct mapped_pci_resource *uio_res);
 200
 201 /**
 202  * Map device memory to uio resource
 203  *
 204  * This function is private to EAL.
 205  *
 206  * @param dev
 207  *   PCI device that has memory information.
 208  * @param res_idx
 209  *   Memory resource index of the PCI device.
 210  * @param uio_res
 211  *  uio resource that will keep mapping information.
 212  * @param map_idx
 213  *   Mapping information index of the uio resource.
 214  * @return
 215  *   0 on success, negative on error
 216  */
 217 int pci_uio_map_resource_by_index(struct rte_pci_device *dev, int res_idx,
 218                 struct mapped_pci_resource *uio_res, int map_idx);
 219
 220 /**
 221  * Init tail queues for non-EAL library structures. This is to allow
 222  * the rings, mempools, etc. lists to be shared among multiple processes
 223  *
 224  * This function is private to EAL
 225  *
 226  * @return
 227  *    0 on success, negative on error
 228  */
 229 int rte_eal_tailqs_init(void);
 230
 231 /**
 232  * Init interrupt handling.
 233  *
 234  * This function is private to EAL.
 235  *
 236  * @return
 237  *  0 on success, negative on error
 238  */
 239 int rte_eal_intr_init(void);
 240
 241 /**
 242  * Init alarm mechanism. This is to allow a callback be called after
 243  * specific time.
 244  *
 245  * This function is private to EAL.
 246  *
 247  * @return
 248  *  0 on success, negative on error
 249  */
 250 int rte_eal_alarm_init(void);
 251
 252 /**
 253  * Function is to check if the kernel module(like, vfio, vfio_iommu_type1,
 254  * etc.) loaded.
 255  *
 256  * @param module_name
 257  *      The module's name which need to be checked
 258  *
 259  * @return
 260  *      -1 means some error happens(NULL pointer or open failure)
 261  *      0  means the module not loaded
 262  *      1  means the module loaded
 263  */
 264 int rte_eal_check_module(const char *module_name);
 265
 266 /**
 267  * Get cpu core_id.
 268  *
 269  * This function is private to the EAL.
 270  */
 271 unsigned eal_cpu_core_id(unsigned lcore_id);
 272
 273 /**
 274  * Check if cpu is present.
 275  *
 276  * This function is private to the EAL.
 277  */
 278 int eal_cpu_detected(unsigned lcore_id);
 279
 280 /**
 281  * Set TSC frequency from precise value or estimation
 282  *
 283  * This function is private to the EAL.
 284  */
 285 void set_tsc_freq(void);
 286
 287 /**
 288  * Get precise TSC frequency from system
 289  *
 290  * This function is private to the EAL.
 291  */
 292 uint64_t get_tsc_freq(void);
 293
 294 /**
 295  * Prepare physical memory mapping
 296  * i.e. hugepages on Linux and
 297  *      contigmem on BSD.
 298  *
 299  * This function is private to the EAL.
 300  */
 301 int rte_eal_hugepage_init(void);
 302
 303 /**
 304  * Creates memory mapping in secondary process
 305  * i.e. hugepages on Linux and
 306  *      contigmem on BSD.
 307  *
 308  * This function is private to the EAL.
 309  */
 310 int rte_eal_hugepage_attach(void);
 311
 312 #endif /* _EAL_PRIVATE_H_ */