Yanbo Zhou 635c7f3d20 include/net.h: add comments for public APIs
Change-Id: I7a42e1978402ac552b25db0c4aa6d2b30ba6d7f7
Signed-off-by: Yanbo Zhou <yanbo.zhou@intel.com>
Reviewed-on: https://review.gerrithub.io/406299
Reviewed-by: Shuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com>
Reviewed-by: Daniel Verkamp <daniel.verkamp@intel.com>
Reviewed-by: Jim Harris <james.r.harris@intel.com>
Tested-by: SPDK Automated Test System <sys_sgsw@intel.com>
2018-04-04 13:46:17 -04:00

140 lines
3.7 KiB
C

/*-
* BSD LICENSE
*
* Copyright (c) Intel Corporation.
* 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.
*/
/** \file
* Net framework abstraction layer
*/
#ifndef SPDK_NET_H
#define SPDK_NET_H
#include "spdk/stdinc.h"
#include "spdk/queue.h"
#ifdef __cplusplus
extern "C" {
#endif
struct spdk_sock;
struct spdk_net_framework {
const char *name;
int (*init)(void);
void (*fini)(void);
STAILQ_ENTRY(spdk_net_framework) link;
};
/**
* Register a net framework.
*
* \param frame Net framework to register.
*/
void spdk_net_framework_register(struct spdk_net_framework *frame);
#define SPDK_NET_FRAMEWORK_REGISTER(name, frame) \
static void __attribute__((constructor)) net_framework_register_##name(void) \
{ \
spdk_net_framework_register(frame); \
}
/**
* Initialize the network interfaces by getting information through netlink socket.
*
* \return 0 on success, 1 on failure.
*/
int spdk_interface_init(void);
/**
* Destroy the network interfaces.
*/
void spdk_interface_destroy(void);
/**
* Start all registered frameworks.
*
* \return 0 on success.
*/
int spdk_net_framework_start(void);
/**
* Stop all registered frameworks.
*/
void spdk_net_framework_fini(void);
#define SPDK_IFNAMSIZE 32
#define SPDK_MAX_IP_PER_IFC 32
struct spdk_interface {
char name[SPDK_IFNAMSIZE];
uint32_t index;
uint32_t num_ip_addresses; /* number of IP addresses defined */
uint32_t ip_address[SPDK_MAX_IP_PER_IFC];
TAILQ_ENTRY(spdk_interface) tailq;
};
/**
* Add an ip address to the network interface.
*
* \param ifc_index Index of the network interface.
* \param ip_addr Ip address to add.
*
* \return 0 on success, -1 on failure.
*/
int spdk_interface_add_ip_address(int ifc_index, char *ip_addr);
/**
* Delete an ip address from the network interface.
*
* \param ifc_index Index of the network interface.
* \param ip_addr Ip address to delete.
*
* \return 0 on success, -1 on failure.
*/
int spdk_interface_delete_ip_address(int ifc_index, char *ip_addr);
/**
* Get the list of all the network interfaces.
*
* \return a pointer to the head of the linked list of all the network interfaces.
*/
void *spdk_interface_get_list(void);
#ifdef __cplusplus
}
#endif
#endif /* SPDK_NET_H */