9a2ff3154b
Also switch from BSD 3-clause to 2-clause license where possible, and consolidate duplicate 3-clause license into one. Submitted by: Marie Helene Kvello-Aune <marieheleneka@gmail.com> Reviewed by: cem, kp Differential Revision: https://reviews.freebsd.org/D7764
106 lines
3.9 KiB
C
106 lines
3.9 KiB
C
/*
|
|
* Copyright (c) 2016, 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
|
|
|
|
typedef enum {
|
|
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 ifconfig_capabilities {
|
|
/** Current capabilities (ifconfig prints this as 'options')*/
|
|
int curcap;
|
|
/** Requested capabilities (ifconfig prints this as 'capabilities')*/
|
|
int reqcap;
|
|
};
|
|
|
|
/** Retrieves a new state object for use in other API calls.
|
|
* Example usage:
|
|
*{@code
|
|
* // Create state object
|
|
* ifconfig_handle_t *lifh = ifconfig_open();
|
|
*
|
|
* // Do stuff with it
|
|
*
|
|
* // 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);
|
|
|
|
/** 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_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_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);
|
|
|
|
/** 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);
|