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  * Called by environment-specific log initialization function to initialize
  53  * log history.
  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 int rte_eal_common_log_init(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 early logs
 104  *
 105  * This function is private to EAL.
 106  *
 107  * @return
 108  *   0 on success, negative on error
 109  */
 110 int rte_eal_log_early_init(void);
 111
 112 /**
 113  * Init the default log stream
 114  *
 115  * This function is private to EAL.
 116  *
 117  * @return
 118  *   0 on success, negative on error
 119  */
 120 int rte_eal_log_init(const char *id, int facility);
 121
 122 /**
 123  * Init the default log stream
 124  *
 125  * This function is private to EAL.
 126  *
 127  * @return
 128  *   0 on success, negative on error
 129  */
 130 int rte_eal_pci_init(void);
 131
 132 #ifdef RTE_LIBRTE_IVSHMEM
 133 /**
 134  * Init the memory from IVSHMEM devices
 135  *
 136  * This function is private to EAL.
 137  *
 138  * @return
 139  *  0 on success, negative on error
 140  */
 141 int rte_eal_ivshmem_init(void);
 142
 143 /**
 144  * Init objects in IVSHMEM devices
 145  *
 146  * This function is private to EAL.
 147  *
 148  * @return
 149  *  0 on success, negative on error
 150  */
 151 int rte_eal_ivshmem_obj_init(void);
 152 #endif
 153
 154 struct rte_pci_driver;
 155 struct rte_pci_device;
 156
 157 /**
 158  * Unbind kernel driver for this device
 159  *
 160  * This function is private to EAL.
 161  *
 162  * @return
 163  *   0 on success, negative on error
 164  */
 165 int pci_unbind_kernel_driver(struct rte_pci_device *dev);
 166
 167 /**
 168  * Map the PCI resource of a PCI device in virtual memory
 169  *
 170  * This function is private to EAL.
 171  *
 172  * @return
 173  *   0 on success, negative on error
 174  */
 175 int pci_uio_map_resource(struct rte_pci_device *dev);
 176
 177 /**
 178  * Unmap the PCI resource of a PCI device
 179  *
 180  * This function is private to EAL.
 181  */
 182 void pci_uio_unmap_resource(struct rte_pci_device *dev);
 183
 184 /**
 185  * Allocate uio resource for PCI device
 186  *
 187  * This function is private to EAL.
 188  *
 189  * @param dev
 190  *   PCI device to allocate uio resource
 191  * @param uio_res
 192  *   Pointer to uio resource.
 193  *   If the function returns 0, the pointer will be filled.
 194  * @return
 195  *   0 on success, negative on error
 196  */
 197 int pci_uio_alloc_resource(struct rte_pci_device *dev,
 198                 struct mapped_pci_resource **uio_res);
 199
 200 /**
 201  * Free uio resource for PCI device
 202  *
 203  * This function is private to EAL.
 204  *
 205  * @param dev
 206  *   PCI device to free uio resource
 207  * @param uio_res
 208  *   Pointer to uio resource.
 209  */
 210 void pci_uio_free_resource(struct rte_pci_device *dev,
 211                 struct mapped_pci_resource *uio_res);
 212
 213 /**
 214  * Map device memory to uio resource
 215  *
 216  * This function is private to EAL.
 217  *
 218  * @param dev
 219  *   PCI device that has memory information.
 220  * @param res_idx
 221  *   Memory resource index of the PCI device.
 222  * @param uio_res
 223  *  uio resource that will keep mapping information.
 224  * @param map_idx
 225  *   Mapping information index of the uio resource.
 226  * @return
 227  *   0 on success, negative on error
 228  */
 229 int pci_uio_map_resource_by_index(struct rte_pci_device *dev, int res_idx,
 230                 struct mapped_pci_resource *uio_res, int map_idx);
 231
 232 /**
 233  * Init tail queues for non-EAL library structures. This is to allow
 234  * the rings, mempools, etc. lists to be shared among multiple processes
 235  *
 236  * This function is private to EAL
 237  *
 238  * @return
 239  *    0 on success, negative on error
 240  */
 241 int rte_eal_tailqs_init(void);
 242
 243 /**
 244  * Init interrupt handling.
 245  *
 246  * This function is private to EAL.
 247  *
 248  * @return
 249  *  0 on success, negative on error
 250  */
 251 int rte_eal_intr_init(void);
 252
 253 /**
 254  * Init alarm mechanism. This is to allow a callback be called after
 255  * specific time.
 256  *
 257  * This function is private to EAL.
 258  *
 259  * @return
 260  *  0 on success, negative on error
 261  */
 262 int rte_eal_alarm_init(void);
 263
 264 /**
 265  * This function initialises any virtual devices
 266  *
 267  * This function is private to the EAL.
 268  */
 269 int rte_eal_dev_init(void);
 270
 271 /**
 272  * Function is to check if the kernel module(like, vfio, vfio_iommu_type1,
 273  * etc.) loaded.
 274  *
 275  * @param module_name
 276  *      The module's name which need to be checked
 277  *
 278  * @return
 279  *      -1 means some error happens(NULL pointer or open failure)
 280  *      0  means the module not loaded
 281  *      1  means the module loaded
 282  */
 283 int rte_eal_check_module(const char *module_name);
 284
 285 /**
 286  * Get cpu core_id.
 287  *
 288  * This function is private to the EAL.
 289  */
 290 unsigned eal_cpu_core_id(unsigned lcore_id);
 291
 292 /**
 293  * Check if cpu is present.
 294  *
 295  * This function is private to the EAL.
 296  */
 297 int eal_cpu_detected(unsigned lcore_id);
 298
 299 /**
 300  * Set TSC frequency from precise value or estimation
 301  *
 302  * This function is private to the EAL.
 303  */
 304 void set_tsc_freq(void);
 305
 306 /**
 307  * Get precise TSC frequency from system
 308  *
 309  * This function is private to the EAL.
 310  */
 311 uint64_t get_tsc_freq(void);
 312
 313 /**
 314  * Prepare physical memory mapping
 315  * i.e. hugepages on Linux and
 316  *      contigmem on BSD.
 317  *
 318  * This function is private to the EAL.
 319  */
 320 int rte_eal_hugepage_init(void);
 321
 322 /**
 323  * Creates memory mapping in secondary process
 324  * i.e. hugepages on Linux and
 325  *      contigmem on BSD.
 326  *
 327  * This function is private to the EAL.
 328  */
 329 int rte_eal_hugepage_attach(void);
 330
 331 #endif /* _EAL_PRIVATE_H_ */