Spdk/include/spdk/env_dpdk.h
Jim Harris 488570ebd4 Replace most BSD 3-clause license text with SPDX identifier.
Many open source projects have moved to using SPDX identifiers
to specify license information, reducing the amount of
boilerplate code in every source file.  This patch replaces
the bulk of SPDK .c, .cpp and Makefiles with the BSD-3-Clause
identifier.

Almost all of these files share the exact same license text,
and this patch only modifies the files that contain the
most common license text.  There can be slight variations
because the third clause contains company names - most say
"Intel Corporation", but there are instances for Nvidia,
Samsung, Eideticom and even "the copyright holder".

Used a bash script to automate replacement of the license text
with SPDX identifier which is checked into scripts/spdx.sh.

Signed-off-by: Jim Harris <james.r.harris@intel.com>
Change-Id: Iaa88ab5e92ea471691dc298cfe41ebfb5d169780
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/12904
Community-CI: Broadcom CI <spdk-ci.pdl@broadcom.com>
Community-CI: Mellanox Build Bot
Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>
Reviewed-by: Aleksey Marchuk <alexeymar@nvidia.com>
Reviewed-by: Changpeng Liu <changpeng.liu@intel.com>
Reviewed-by: Dong Yi <dongx.yi@intel.com>
Reviewed-by: Konrad Sztyber <konrad.sztyber@intel.com>
Reviewed-by: Paul Luse <paul.e.luse@intel.com>
Reviewed-by: <qun.wan@intel.com>
2022-06-09 07:35:12 +00:00

59 lines
1.4 KiB
C

/* SPDX-License-Identifier: BSD-3-Clause
* Copyright (c) Intel Corporation.
* All rights reserved.
*/
/** \file
* Encapsulated DPDK specific dependencies
*/
#include "spdk/stdinc.h"
#ifndef SPDK_ENV_DPDK_H
#define SPDK_ENV_DPDK_H
#ifdef __cplusplus
extern "C" {
#endif
/**
* Initialize the environment library after DPDK env is already initialized.
* If DPDK's rte_eal_init is already called, this function must be called
* instead of spdk_env_init, prior to using any other functions in SPDK
* env library.
*
* \param legacy_mem Indicates whether DPDK was initialized with --legacy-mem
* eal parameter.
* \return 0 on success, or negative errno on failure.
*/
int spdk_env_dpdk_post_init(bool legacy_mem);
/**
* Release any resources of the environment library that were allocated with
* spdk_env_dpdk_post_init(). After this call, no DPDK function calls may
* be made. It is expected that common usage of this function is to call it
* just before terminating the process.
*/
void spdk_env_dpdk_post_fini(void);
/**
* Check if DPDK was initialized external to the SPDK env_dpdk library.
*
* \return true if DPDK was initialized external to the SPDK env_dpdk library.
* \return false otherwise
*/
bool spdk_env_dpdk_external_init(void);
/**
* Dump the env allocated memory to the given file.
*
* \param file The file object to write to.
*/
void spdk_env_dpdk_dump_mem_stats(FILE *file);
#ifdef __cplusplus
}
#endif
#endif