libifconfig_sfp.h provides an API in libifconfig for querying SFP module properties, operational status, and vendor strings, as well as descriptions of the various fields, string conversions, and other useful helpers for implementing user interfaces. SFP module status is obtained by reading registers via an I2C interface. Descriptions of these registers and the values therein have been collected in a Lua table which is used to generate all the boilerplace C headers and source files for accessing these values, their names, and descriptions. The generated code is fully commented and readable. This is the first use of libifconfig in ifconfig itself. For now, the scope remains very limited. Over time, more of ifconfig will be replaced with libifconfig. Some minor changes to the formatting of ifconfig output have been made: - Module memory hex dumps are indented one extra space as a result of using hexdump(3) instead of a bespoke hex dump function. - Media descriptions have an added two-character short-name in parenthesis. - QSFP modules were incorrectly displaying TX bias current as power. Now TX channels display bias current, and this change has been made for both SFP and QSFP modules for consistency. A Lua binding for libifconfig including this functionality is implemented but has not been included in this commit. The plan is for it to be committed after dynamic module loading has been enabled in flua. Reviewed by: kp, melifaro Relnotes: yes Differential Revision: https://reviews.freebsd.org/D25494
282 lines
10 KiB
C
282 lines
10 KiB
C
/*
|
|
* Copyright (c) 2016-2017, Marie Helene Kvello-Aune
|
|
* All rights reserved.
|
|
*
|
|
* Redistribution and use in source and binary forms, with or without modification,
|
|
* are permitted provided that the following conditions are met:
|
|
*
|
|
* 1. Redistributions of source code must retain the above copyright notice,
|
|
* thislist of conditions and the following disclaimer.
|
|
*
|
|
* 2. 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.
|
|
*
|
|
* 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 HOLDER 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.
|
|
*
|
|
* $FreeBSD$
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#include <sys/types.h>
|
|
|
|
#include <net/if.h>
|
|
|
|
#include <netinet/in.h>
|
|
#include <netinet6/in6_var.h>
|
|
|
|
#define ND6_IFF_DEFAULTIF 0x8000
|
|
|
|
typedef enum {
|
|
OK = 0,
|
|
OTHER,
|
|
IOCTL,
|
|
SOCKET
|
|
} ifconfig_errtype;
|
|
|
|
/*
|
|
* Opaque definition so calling application can just pass a
|
|
* pointer to it for library use.
|
|
*/
|
|
struct ifconfig_handle;
|
|
typedef struct ifconfig_handle ifconfig_handle_t;
|
|
|
|
struct carpreq;
|
|
struct ifaddrs;
|
|
struct ifbropreq;
|
|
struct ifbreq;
|
|
struct in6_ndireq;
|
|
struct lagg_reqall;
|
|
struct lagg_reqflags;
|
|
struct lagg_reqopts;
|
|
struct lagg_reqport;
|
|
|
|
/** Stores extra info associated with a bridge(4) interface */
|
|
struct ifconfig_bridge_status {
|
|
struct ifbropreq *params; /**< current operational parameters */
|
|
struct ifbreq *members; /**< list of bridge members */
|
|
size_t members_count; /**< how many member interfaces */
|
|
uint32_t cache_size; /**< size of address cache */
|
|
uint32_t cache_lifetime; /**< address cache entry lifetime */
|
|
};
|
|
|
|
struct ifconfig_capabilities {
|
|
/** Current capabilities (ifconfig prints this as 'options')*/
|
|
int curcap;
|
|
/** Requested capabilities (ifconfig prints this as 'capabilities')*/
|
|
int reqcap;
|
|
};
|
|
|
|
/** Stores extra info associated with an inet address */
|
|
struct ifconfig_inet_addr {
|
|
const struct sockaddr_in *sin;
|
|
const struct sockaddr_in *netmask;
|
|
const struct sockaddr_in *dst;
|
|
const struct sockaddr_in *broadcast;
|
|
int prefixlen;
|
|
uint8_t vhid;
|
|
};
|
|
|
|
/** Stores extra info associated with an inet6 address */
|
|
struct ifconfig_inet6_addr {
|
|
struct sockaddr_in6 *sin6;
|
|
struct sockaddr_in6 *dstin6;
|
|
struct in6_addrlifetime lifetime;
|
|
int prefixlen;
|
|
uint32_t flags;
|
|
uint8_t vhid;
|
|
};
|
|
|
|
/** Stores extra info associated with a lagg(4) interface */
|
|
struct ifconfig_lagg_status {
|
|
struct lagg_reqall *ra;
|
|
struct lagg_reqopts *ro;
|
|
struct lagg_reqflags *rf;
|
|
};
|
|
|
|
/** Retrieves a new state object for use in other API calls.
|
|
* Example usage:
|
|
*{@code
|
|
* // Create state object
|
|
* ifconfig_handle_t *lifh;
|
|
* lifh = ifconfig_open();
|
|
* if (lifh == NULL) {
|
|
* // Handle error
|
|
* }
|
|
*
|
|
* // Do stuff with the handle
|
|
*
|
|
* // Dispose of the state object
|
|
* ifconfig_close(lifh);
|
|
* lifh = NULL;
|
|
*}
|
|
*/
|
|
ifconfig_handle_t *ifconfig_open(void);
|
|
|
|
/** Frees resources held in the provided state object.
|
|
* @param h The state object to close.
|
|
* @see #ifconfig_open(void)
|
|
*/
|
|
void ifconfig_close(ifconfig_handle_t *h);
|
|
|
|
/** Identifies what kind of error occured. */
|
|
ifconfig_errtype ifconfig_err_errtype(ifconfig_handle_t *h);
|
|
|
|
/** Retrieves the errno associated with the error, if any. */
|
|
int ifconfig_err_errno(ifconfig_handle_t *h);
|
|
|
|
typedef void (*ifconfig_foreach_func_t)(ifconfig_handle_t *h,
|
|
struct ifaddrs *ifa, void *udata);
|
|
|
|
/** Iterate over every network interface
|
|
* @param h An open ifconfig state object
|
|
* @param cb A callback function to call with a pointer to each interface
|
|
* @param udata An opaque value that will be passed to the callback.
|
|
* @return 0 on success, nonzero if the list could not be iterated
|
|
*/
|
|
int ifconfig_foreach_iface(ifconfig_handle_t *h, ifconfig_foreach_func_t cb,
|
|
void *udata);
|
|
|
|
/** Iterate over every address on a single network interface
|
|
* @param h An open ifconfig state object
|
|
* @param ifa A pointer that was supplied by a previous call to
|
|
* ifconfig_foreach_iface
|
|
* @param udata An opaque value that will be passed to the callback.
|
|
* @param cb A callback function to call with a pointer to each ifaddr
|
|
*/
|
|
void ifconfig_foreach_ifaddr(ifconfig_handle_t *h, struct ifaddrs *ifa,
|
|
ifconfig_foreach_func_t cb, void *udata);
|
|
|
|
/** If error type was IOCTL, this identifies which request failed. */
|
|
unsigned long ifconfig_err_ioctlreq(ifconfig_handle_t *h);
|
|
int ifconfig_get_description(ifconfig_handle_t *h, const char *name,
|
|
char **description);
|
|
int ifconfig_set_description(ifconfig_handle_t *h, const char *name,
|
|
const char *newdescription);
|
|
int ifconfig_unset_description(ifconfig_handle_t *h, const char *name);
|
|
int ifconfig_set_name(ifconfig_handle_t *h, const char *name,
|
|
const char *newname);
|
|
int ifconfig_get_orig_name(ifconfig_handle_t *h, const char *ifname,
|
|
char **orig_name);
|
|
int ifconfig_set_fib(ifconfig_handle_t *h, const char *name, int fib);
|
|
int ifconfig_get_fib(ifconfig_handle_t *h, const char *name, int *fib);
|
|
int ifconfig_set_mtu(ifconfig_handle_t *h, const char *name, const int mtu);
|
|
int ifconfig_get_mtu(ifconfig_handle_t *h, const char *name, int *mtu);
|
|
int ifconfig_get_nd6(ifconfig_handle_t *h, const char *name,
|
|
struct in6_ndireq *nd);
|
|
int ifconfig_set_metric(ifconfig_handle_t *h, const char *name,
|
|
const int metric);
|
|
int ifconfig_get_metric(ifconfig_handle_t *h, const char *name, int *metric);
|
|
int ifconfig_set_capability(ifconfig_handle_t *h, const char *name,
|
|
const int capability);
|
|
int ifconfig_get_capability(ifconfig_handle_t *h, const char *name,
|
|
struct ifconfig_capabilities *capability);
|
|
|
|
/** Retrieve the list of groups to which this interface belongs
|
|
* @param h An open ifconfig state object
|
|
* @param name The interface name
|
|
* @param ifgr return argument. The caller is responsible for freeing
|
|
* ifgr->ifgr_groups
|
|
* @return 0 on success, nonzero on failure
|
|
*/
|
|
int ifconfig_get_groups(ifconfig_handle_t *h, const char *name,
|
|
struct ifgroupreq *ifgr);
|
|
int ifconfig_get_ifstatus(ifconfig_handle_t *h, const char *name,
|
|
struct ifstat *stat);
|
|
|
|
/** Retrieve the interface media information
|
|
* @param h An open ifconfig state object
|
|
* @param name The interface name
|
|
* @param ifmr Return argument. The caller is responsible for freeing it
|
|
* @return 0 on success, nonzero on failure
|
|
*/
|
|
int ifconfig_media_get_mediareq(ifconfig_handle_t *h, const char *name,
|
|
struct ifmediareq **ifmr);
|
|
const char *ifconfig_media_get_type(int ifmw);
|
|
const char *ifconfig_media_get_subtype(int ifmw);
|
|
const char *ifconfig_media_get_status(const struct ifmediareq *ifmr);
|
|
void ifconfig_media_get_options_string(int ifmw, char *buf, size_t buflen);
|
|
|
|
int ifconfig_carp_get_info(ifconfig_handle_t *h, const char *name,
|
|
struct carpreq *carpr, int ncarpr);
|
|
|
|
/** Retrieve additional information about an inet address
|
|
* @param h An open ifconfig state object
|
|
* @param name The interface name
|
|
* @param ifa Pointer to the the address structure of interest
|
|
* @param addr Return argument. It will be filled with additional information
|
|
* about the address.
|
|
* @return 0 on success, nonzero on failure.
|
|
*/
|
|
int ifconfig_inet_get_addrinfo(ifconfig_handle_t *h,
|
|
const char *name, struct ifaddrs *ifa, struct ifconfig_inet_addr *addr);
|
|
|
|
/** Retrieve additional information about an inet6 address
|
|
* @param h An open ifconfig state object
|
|
* @param name The interface name
|
|
* @param ifa Pointer to the the address structure of interest
|
|
* @param addr Return argument. It will be filled with additional information
|
|
* about the address.
|
|
* @return 0 on success, nonzero on failure.
|
|
*/
|
|
int ifconfig_inet6_get_addrinfo(ifconfig_handle_t *h,
|
|
const char *name, struct ifaddrs *ifa, struct ifconfig_inet6_addr *addr);
|
|
|
|
/** Retrieve additional information about a bridge(4) interface */
|
|
int ifconfig_bridge_get_bridge_status(ifconfig_handle_t *h,
|
|
const char *name, struct ifconfig_bridge_status **bridge);
|
|
|
|
/** Frees the structure returned by ifconfig_bridge_get_bridge_status. Does
|
|
* nothing if the argument is NULL
|
|
* @param bridge Pointer to the structure to free
|
|
*/
|
|
void ifconfig_bridge_free_bridge_status(struct ifconfig_bridge_status *bridge);
|
|
|
|
/** Retrieve additional information about a lagg(4) interface */
|
|
int ifconfig_lagg_get_lagg_status(ifconfig_handle_t *h,
|
|
const char *name, struct ifconfig_lagg_status **lagg_status);
|
|
|
|
/** Retrieve additional information about a member of a lagg(4) interface */
|
|
int ifconfig_lagg_get_laggport_status(ifconfig_handle_t *h,
|
|
const char *name, struct lagg_reqport *rp);
|
|
|
|
/** Frees the structure returned by ifconfig_lagg_get_lagg_status. Does
|
|
* nothing if the argument is NULL
|
|
* @param laggstat Pointer to the structure to free
|
|
*/
|
|
void ifconfig_lagg_free_lagg_status(struct ifconfig_lagg_status *laggstat);
|
|
|
|
/** Destroy a virtual interface
|
|
* @param name Interface to destroy
|
|
*/
|
|
int ifconfig_destroy_interface(ifconfig_handle_t *h, const char *name);
|
|
|
|
/** Creates a (virtual) interface
|
|
* @param name Name of interface to create. Example: bridge or bridge42
|
|
* @param name ifname Is set to actual name of created interface
|
|
*/
|
|
int ifconfig_create_interface(ifconfig_handle_t *h, const char *name,
|
|
char **ifname);
|
|
|
|
/** Creates a (virtual) interface
|
|
* @param name Name of interface to create. Example: vlan0 or ix0.50
|
|
* @param name ifname Is set to actual name of created interface
|
|
* @param vlandev Name of interface to attach to
|
|
* @param vlanid VLAN ID/Tag. Must not be 0.
|
|
*/
|
|
int ifconfig_create_interface_vlan(ifconfig_handle_t *h, const char *name,
|
|
char **ifname, const char *vlandev, const unsigned short vlantag);
|
|
|
|
int ifconfig_set_vlantag(ifconfig_handle_t *h, const char *name,
|
|
const char *vlandev, const unsigned short vlantag);
|