/*
* CDDL HEADER START
*
* The contents of this file are subject to the terms of the
* Common Development and Distribution License (the "License").
* You may not use this file except in compliance with the License.
*
* You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
* See the License for the specific language governing permissions
* and limitations under the License.
*
* When distributing Covered Code, include this CDDL HEADER in each
* file and include the License file at usr/src/OPENSOLARIS.LICENSE.
* If applicable, add the following below this CDDL HEADER, with the
* fields enclosed by brackets "[]" replaced with your own identifying
* information: Portions Copyright [yyyy] [name of copyright owner]
*
* CDDL HEADER END
*/
/*
*/
#ifndef _LIBIPADM_H
#define _LIBIPADM_H
#ifdef __cplusplus
extern "C" {
#endif
#include <stddef.h>
#include <netdb.h>
#include <ifaddrs.h>
#include <libnvpair.h>
/* special timeout values for dhcp operations */
/*
* Specifies that the string passed to ipadm_str2nvlist() is a string of comma
* separated names and that each name does not have values associated with it.
*/
/* error codes */
typedef enum {
/*
* IPADM_UNDERIF_APP_ADDRS: Underlying interface has addresses managed
* by external applications
*/
/*
* IPADM_UNDERIF_DHCP_MANAGED: Underlying interface has addresses
* managed by dhcpagent(1M)
*/
/*
* IPADM_UNDERIF_NDPD_MANAGED: Underlying interface has addresses
* managed by in.ndpd(1M)
*/
/*
* IPADM_UNDERIF_UP_ADDRS: Underlying interface has addresses marked up
*/
/*
* IPADM_IPMPIF_MISSING_AF: IPMP interface missing address families
* configured on underlying interface
*/
/*
* IPADM_ADDROBJ_NOT_CREATED : For one or more of the migrated data
* addresses in the legacy case, an address object could not be created.
*/
/*
* option flags taken by the libipadm functions
*
* - IPADM_OPT_PERSIST:
* requests to persist the configuration so that it can be
* re-enabled or reapplied on boot.
*
* - IPADM_OPT_ACTIVE:
* Requests to apply configuration without persisting it and
* used by show-* subcommands to retrieve current values.
*
* - IPADM_OPT_DEFAULT:
* retrieves the default value for a given property
*
* - IPADM_OPT_PERM
* retrieves the permission for a given property
*
* - IPADM_OPT_POSSIBLE
* retrieves the range of values for a given property
*
* - IPADM_OPT_APPEND
* for multi-valued properties, appends a new value.
*
* - IPADM_OPT_REMOVE
* for multi-valued properties, removes the specified value
*
* - IPADM_OPT_GENPPA
* Used in ipadm_create_ipmp() to generate a ppa for the given IPMP
* interface.
*
* - IPADM_OPT_ZEROADDR
* return :: or INADDR_ANY
*
* - IPADM_OPT_RELEASE
* Used to release the lease on a dhcp address object
*
* - IPADM_OPT_INFORM
* Used to perform DHCP_INFORM on a specified static address object
*
* - IPADM_OPT_UP
* Used to bring up a static address on creation
*
* - IPADM_OPT_FORCE
* Used in ipadm_delete_ipmp() to forcefully delete an IPMP interface
* even when it has underlying interfaces.
*
* - IPADM_OPT_MODIFY
* Used to modify only the active configuration even when the
* configuration is persistent. Used to update an addrconf interface id.
*
* - IPADM_OPT_PROFILE
* Used to specify that a profile switch is taking place. Global
* properties, like those of congestion control, marked with
* IPADMPROP_GLOBAL do not need to be reset.
*/
/* IPADM property class */
/* protocol property that can be applied on interface too */
/* opaque ipadm handle to libipadm functions */
struct ipadm_handle;
/* ipadm_handle flags */
/*
* Indicates that the operation being invoked is in 'init' context. This is
* a library private flag.
*/
/*
* Interface classes. These constants are committed to disk, as part of storing
* the persistent configuration. These should not be changed without upgrading
* the persistent configuration to match the enum values.
*/
typedef enum {
/* opaque address object structure */
/* ipadm_if_info_t states */
typedef enum {
typedef struct ipadm_iflist_s {
typedef struct ipadm_if_info_s {
/*
* ifi_unders: list of underlying interfaces in the
* running configuration for the IPMP interface,
* each of type `ipadm_ifname_t'.
*/
/*
* ifi_punders: list of underlying interfaces in the
* persistent configuration for the IPMP interface,
* each of type `ipadm_ifname_t'.
*/
/* ipadm_if_info_t flags */
/* ipadm_addr_info_t state */
typedef enum {
/* possible address types */
typedef enum {
/* possible Client ID types */
typedef enum {
typedef struct ipadm_addr_info_s {
char *ia_clientid;
/* ipadm_addr_info_t flags */
const char *);
extern void ipadm_close(ipadm_handle_t);
/* Check authorization for network configuration */
extern boolean_t ipadm_check_auth(void);
/*
* Interface mangement functions
*/
uint32_t);
const char *, uint32_t);
const char *, uint32_t);
uint32_t);
extern void ipadm_free_if_info(list_t *);
/*
* Helper functions
*/
const char *);
ipadm_addr_info_t **);
const char *, ipadm_addr_info_t *);
/*
* Address management functions
*/
uint32_t);
uint32_t);
uint32_t);
uint32_t);
uint32_t);
uint32_t);
uint32_t);
extern void ipadm_free_addr_info(ipadm_addr_info_t *);
ipadm_addrobj_t *);
extern void ipadm_destroy_addrobj(ipadm_addrobj_t);
size_t);
struct sockaddr_in6 *, int *, uint32_t);
/* Functions to set fields in addrobj for static addresses */
uint32_t);
struct sockaddr_storage *);
uint32_t);
/* Functions to set fields in addrobj for IPv6 addrconf */
const char *);
/* Functions to set fields in addrobj for DHCP */
/*
* Property management functions
*/
/* call back function for the property walker */
void *);
ipadm_prop_wfunc_t *, void *);
/* Interface property management - set, reset and get */
/* Address property management - set, reset and get */
const char *, const char *, uint_t);
/* Protoocl property management - set, reset and get */
/*
* miscellaneous helper functions.
*/
extern const char *ipadm_status2str(ipadm_status_t);
extern const char *ipadm_class2str(ipadm_if_class_t);
extern char *ipadm_proto2str(uint_t);
extern uint_t ipadm_str2proto(const char *);
extern ipadm_status_t ipadm_open_arp_on_udp(const char *, int *);
extern int ipadm_legacy2new_propname(const char *, char *,
extern int ipadm_new2legacy_propname(const char *, char *,
extern boolean_t ipadm_is_vni(const char *);
extern boolean_t ipadm_is_loopback(const char *);
extern int ipadm_create_fixed_ncp(const char *);
extern void ipadm_enable_all_ifs(ipadm_handle_t);
extern void ipadm_disable_all_ifs(ipadm_handle_t);
extern void ipadm_reset_all_props(ipadm_handle_t);
/*
* Congestion control
*/
const char *);
extern ipadm_status_t ipadm_cong_persist_propval(const char *, const char *,
const char *, const char *, uint_t);
cong_db_func_t *);
#ifdef __cplusplus
}
#endif
#endif /* _LIBIPADM_H */