X-Git-Url: http://git.droids-corp.org/?a=blobdiff_plain;f=lib%2Flibrte_eal%2Fcommon%2Feal_private.h;h=0b2877000bbb7858461795d2b4593394f65528c4;hb=3d8d90206c4dbe925aff8c5c7950cdfd2484b66f;hp=8505b05b680b778441b6b72dfbe8bc6fc9b6a9f6;hpb=bd8bf7e172abfa765e0365f4e80ed99772309b3b;p=dpdk.git diff --git a/lib/librte_eal/common/eal_private.h b/lib/librte_eal/common/eal_private.h index 8505b05b68..0b2877000b 100644 --- a/lib/librte_eal/common/eal_private.h +++ b/lib/librte_eal/common/eal_private.h @@ -1,41 +1,13 @@ -/*- - * BSD LICENSE - * - * Copyright(c) 2010-2014 Intel Corporation. All rights reserved. - * All rights reserved. - * - * Redistribution and use in source and binary forms, with or without - * modification, are permitted provided that the following conditions - * are met: - * - * * Redistributions of source code must retain the above copyright - * notice, this list of conditions and the following disclaimer. - * * Redistributions in binary form must reproduce the above copyright - * notice, this list of conditions and the following disclaimer in - * the documentation and/or other materials provided with the - * distribution. - * * Neither the name of Intel Corporation nor the names of its - * contributors may be used to endorse or promote products derived - * from this software without specific prior written permission. - * - * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS - * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT - * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR - * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT - * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, - * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT - * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, - * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY - * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT - * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE - * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +/* SPDX-License-Identifier: BSD-3-Clause + * Copyright(c) 2010-2018 Intel Corporation */ #ifndef _EAL_PRIVATE_H_ #define _EAL_PRIVATE_H_ +#include +#include #include -#include /** * Initialize the memzone subsystem (private to eal). @@ -47,10 +19,9 @@ int rte_eal_memzone_init(void); /** - * Common log initialization function (private to eal). - * - * Called by environment-specific log initialization function to initialize - * log history. + * Common log initialization function (private to eal). Determines + * where log data is written when no call to rte_openlog_stream is + * in effect. * * @param default_log * The default log stream to be used. @@ -58,7 +29,7 @@ int rte_eal_memzone_init(void); * - 0 on success * - Negative on error */ -int rte_eal_common_log_init(FILE *default_log); +void eal_log_set_default(FILE *default_log); /** * Fill configuration with number of physical and logical processors @@ -99,16 +70,6 @@ int rte_eal_memory_init(void); */ int rte_eal_timer_init(void); -/** - * Init early logs - * - * This function is private to EAL. - * - * @return - * 0 on success, negative on error - */ -int rte_eal_log_early_init(void); - /** * Init the default log stream * @@ -120,198 +81,128 @@ int rte_eal_log_early_init(void); int rte_eal_log_init(const char *id, int facility); /** - * Init the default log stream + * Init tail queues for non-EAL library structures. This is to allow + * the rings, mempools, etc. lists to be shared among multiple processes * - * This function is private to EAL. + * This function is private to EAL * * @return - * 0 on success, negative on error + * 0 on success, negative on error */ -int rte_eal_pci_init(void); +int rte_eal_tailqs_init(void); -#ifdef RTE_LIBRTE_IVSHMEM /** - * Init the memory from IVSHMEM devices + * Init interrupt handling. * * This function is private to EAL. * * @return * 0 on success, negative on error */ -int rte_eal_ivshmem_init(void); +int rte_eal_intr_init(void); /** - * Init objects in IVSHMEM devices + * Init alarm mechanism. This is to allow a callback be called after + * specific time. * * This function is private to EAL. * * @return * 0 on success, negative on error */ -int rte_eal_ivshmem_obj_init(void); -#endif - -struct rte_pci_driver; -struct rte_pci_device; - -/** - * Unbind kernel driver for this device - * - * This function is private to EAL. - * - * @return - * 0 on success, negative on error - */ -int pci_unbind_kernel_driver(struct rte_pci_device *dev); - -/** - * Map this device - * - * This function is private to EAL. - * - * @return - * 0 on success, negative on error and positive if no driver - * is found for the device. - */ -int pci_map_device(struct rte_pci_device *dev); - -/** - * Unmap this device - * - * This function is private to EAL. - */ -void pci_unmap_device(struct rte_pci_device *dev); +int rte_eal_alarm_init(void); /** - * Map the PCI resource of a PCI device in virtual memory + * Function is to check if the kernel module(like, vfio, vfio_iommu_type1, + * etc.) loaded. * - * This function is private to EAL. + * @param module_name + * The module's name which need to be checked * * @return - * 0 on success, negative on error - */ -int pci_uio_map_resource(struct rte_pci_device *dev); - -/** - * Unmap the PCI resource of a PCI device - * - * This function is private to EAL. + * -1 means some error happens(NULL pointer or open failure) + * 0 means the module not loaded + * 1 means the module loaded */ -void pci_uio_unmap_resource(struct rte_pci_device *dev); +int rte_eal_check_module(const char *module_name); /** - * Allocate uio resource for PCI device - * - * This function is private to EAL. + * Get cpu core_id. * - * @param dev - * PCI device to allocate uio resource - * @param uio_res - * Pointer to uio resource. - * If the function returns 0, the pointer will be filled. - * @return - * 0 on success, negative on error + * This function is private to the EAL. */ -int pci_uio_alloc_resource(struct rte_pci_device *dev, - struct mapped_pci_resource **uio_res); +unsigned eal_cpu_core_id(unsigned lcore_id); /** - * Free uio resource for PCI device - * - * This function is private to EAL. + * Check if cpu is present. * - * @param dev - * PCI device to free uio resource - * @param uio_res - * Pointer to uio resource. + * This function is private to the EAL. */ -void pci_uio_free_resource(struct rte_pci_device *dev, - struct mapped_pci_resource *uio_res); +int eal_cpu_detected(unsigned lcore_id); /** - * Map device memory to uio resource - * - * This function is private to EAL. + * Set TSC frequency from precise value or estimation * - * @param dev - * PCI device that has memory information. - * @param res_idx - * Memory resource index of the PCI device. - * @param uio_res - * uio resource that will keep mapping information. - * @param map_idx - * Mapping information index of the uio resource. - * @return - * 0 on success, negative on error + * This function is private to the EAL. */ -int pci_uio_map_resource_by_index(struct rte_pci_device *dev, int res_idx, - struct mapped_pci_resource *uio_res, int map_idx); +void set_tsc_freq(void); /** - * Init tail queues for non-EAL library structures. This is to allow - * the rings, mempools, etc. lists to be shared among multiple processes - * - * This function is private to EAL + * Get precise TSC frequency from system * - * @return - * 0 on success, negative on error + * This function is private to the EAL. */ -int rte_eal_tailqs_init(void); +uint64_t get_tsc_freq(void); /** - * Init interrupt handling. + * Get TSC frequency if the architecture supports. * - * This function is private to EAL. + * This function is private to the EAL. * * @return - * 0 on success, negative on error + * The number of TSC cycles in one second. + * Returns zero if the architecture support is not available. */ -int rte_eal_intr_init(void); +uint64_t get_tsc_freq_arch(void); /** - * Init alarm mechanism. This is to allow a callback be called after - * specific time. + * Prepare physical memory mapping + * i.e. hugepages on Linux and + * contigmem on BSD. * - * This function is private to EAL. - * - * @return - * 0 on success, negative on error + * This function is private to the EAL. */ -int rte_eal_alarm_init(void); +int rte_eal_hugepage_init(void); /** - * This function initialises any virtual devices + * Creates memory mapping in secondary process + * i.e. hugepages on Linux and + * contigmem on BSD. * * This function is private to the EAL. */ -int rte_eal_dev_init(void); +int rte_eal_hugepage_attach(void); /** - * Function is to check if the kernel module(like, vfio, vfio_iommu_type1, - * etc.) loaded. + * Find a bus capable of identifying a device. * - * @param module_name - * The module's name which need to be checked + * @param str + * A device identifier (PCI address, virtual PMD name, ...). * * @return - * -1 means some error happens(NULL pointer or open failure) - * 0 means the module not loaded - * 1 means the module loaded + * A valid bus handle if found. + * NULL if no bus is able to parse this device. */ -int rte_eal_check_module(const char *module_name); +struct rte_bus *rte_bus_find_by_device_name(const char *str); /** - * Get cpu core_id. + * Create the unix channel for primary/secondary communication. * - * This function is private to the EAL. + * @return + * 0 on success; + * (<0) on failure. */ -unsigned eal_cpu_core_id(unsigned lcore_id); -/** - * Check if cpu is present. - * - * This function is private to the EAL. - */ -int eal_cpu_detected(unsigned lcore_id); +int rte_mp_channel_init(void); #endif /* _EAL_PRIVATE_H_ */