ipadm_ipmgmt.h revision 6e91bba0d6c6bdabbba62cefae583715a4a58e2a
9e86db79b7d1bbc5f2f04e99954cbd5eae0e22bbHyon Kim * CDDL HEADER START
9e86db79b7d1bbc5f2f04e99954cbd5eae0e22bbHyon Kim * The contents of this file are subject to the terms of the
9e86db79b7d1bbc5f2f04e99954cbd5eae0e22bbHyon Kim * Common Development and Distribution License (the "License").
9e86db79b7d1bbc5f2f04e99954cbd5eae0e22bbHyon Kim * You may not use this file except in compliance with the License.
9e86db79b7d1bbc5f2f04e99954cbd5eae0e22bbHyon Kim * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9e86db79b7d1bbc5f2f04e99954cbd5eae0e22bbHyon Kim * See the License for the specific language governing permissions
9e86db79b7d1bbc5f2f04e99954cbd5eae0e22bbHyon Kim * and limitations under the License.
9e86db79b7d1bbc5f2f04e99954cbd5eae0e22bbHyon Kim * When distributing Covered Code, include this CDDL HEADER in each
9e86db79b7d1bbc5f2f04e99954cbd5eae0e22bbHyon Kim * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
9e86db79b7d1bbc5f2f04e99954cbd5eae0e22bbHyon Kim * If applicable, add the following below this CDDL HEADER, with the
9e86db79b7d1bbc5f2f04e99954cbd5eae0e22bbHyon Kim * fields enclosed by brackets "[]" replaced with your own identifying
9e86db79b7d1bbc5f2f04e99954cbd5eae0e22bbHyon Kim * information: Portions Copyright [yyyy] [name of copyright owner]
9e86db79b7d1bbc5f2f04e99954cbd5eae0e22bbHyon Kim * CDDL HEADER END
9e86db79b7d1bbc5f2f04e99954cbd5eae0e22bbHyon Kim * Copyright 2010 Sun Microsystems, Inc. All rights reserved.
9e86db79b7d1bbc5f2f04e99954cbd5eae0e22bbHyon Kim * Use is subject to license terms.
9e86db79b7d1bbc5f2f04e99954cbd5eae0e22bbHyon Kimextern "C" {
9e86db79b7d1bbc5f2f04e99954cbd5eae0e22bbHyon Kim * Function declarations and data structures shared by libipadm.so and
9e86db79b7d1bbc5f2f04e99954cbd5eae0e22bbHyon Kim * the IP management daemon.
9e86db79b7d1bbc5f2f04e99954cbd5eae0e22bbHyon Kim/* Authorization required to configure network interfaces */
9e86db79b7d1bbc5f2f04e99954cbd5eae0e22bbHyon Kim#define NETWORK_INTERFACE_CONFIG_AUTH "solaris.network.interface.config"
9e86db79b7d1bbc5f2f04e99954cbd5eae0e22bbHyon Kim * Data store read/write utilities related declarations.
9e86db79b7d1bbc5f2f04e99954cbd5eae0e22bbHyon Kim/* Permanent data store for ipadm */
9e86db79b7d1bbc5f2f04e99954cbd5eae0e22bbHyon Kim#define IPADM_FILE_MODE (S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)
9e86db79b7d1bbc5f2f04e99954cbd5eae0e22bbHyon Kim * For more information on these definitions please refer to the top of
9e86db79b7d1bbc5f2f04e99954cbd5eae0e22bbHyon Kim * ipadm_persist.c. These are the name of the nvpairs which hold the
9e86db79b7d1bbc5f2f04e99954cbd5eae0e22bbHyon Kim * respective values. All nvpairs private to ipadm have names that begin
9e86db79b7d1bbc5f2f04e99954cbd5eae0e22bbHyon Kim * with "_". Note below that 'prefixlen' is an address property and therefore
9e86db79b7d1bbc5f2f04e99954cbd5eae0e22bbHyon Kim * not a private nvpair name.
9e86db79b7d1bbc5f2f04e99954cbd5eae0e22bbHyon Kim#define IPADM_NVP_PROTONAME "_protocol" /* protocol name */
9e86db79b7d1bbc5f2f04e99954cbd5eae0e22bbHyon Kim#define IPADM_NVP_IFNAME "_ifname" /* interface name */
9e86db79b7d1bbc5f2f04e99954cbd5eae0e22bbHyon Kim#define IPADM_NVP_AOBJNAME "_aobjname" /* addrobj name */
9e86db79b7d1bbc5f2f04e99954cbd5eae0e22bbHyon Kim#define IPADM_NVP_FAMILY "_family" /* address family */
9e86db79b7d1bbc5f2f04e99954cbd5eae0e22bbHyon Kim#define IPADM_NVP_IPV4ADDR "_ipv4addr" /* name of IPv4 addr nvlist */
9e86db79b7d1bbc5f2f04e99954cbd5eae0e22bbHyon Kim#define IPADM_NVP_IPNUMADDR "_addr" /* local address */
9e86db79b7d1bbc5f2f04e99954cbd5eae0e22bbHyon Kim#define IPADM_NVP_IPADDRHNAME "_aname" /* local hostname */
9e86db79b7d1bbc5f2f04e99954cbd5eae0e22bbHyon Kim#define IPADM_NVP_IPDADDRHNAME "_dname" /* remote hostname */
9e86db79b7d1bbc5f2f04e99954cbd5eae0e22bbHyon Kim#define IPADM_NVP_PREFIXLEN "prefixlen" /* prefixlen */
9e86db79b7d1bbc5f2f04e99954cbd5eae0e22bbHyon Kim#define IPADM_NVP_IPV6ADDR "_ipv6addr" /* name of IPv6 addr nvlist */
9e86db79b7d1bbc5f2f04e99954cbd5eae0e22bbHyon Kim#define IPADM_NVP_DHCP "_dhcp" /* name of DHCP nvlist */
9e86db79b7d1bbc5f2f04e99954cbd5eae0e22bbHyon Kim#define IPADM_NVP_WAIT "_wait" /* DHCP timeout value */
9e86db79b7d1bbc5f2f04e99954cbd5eae0e22bbHyon Kim#define IPADM_NVP_PRIMARY "_primary" /* DHCP primary interface */
9e86db79b7d1bbc5f2f04e99954cbd5eae0e22bbHyon Kim#define IPADM_NVP_LIFNUM "_lifnum" /* logical interface number */
9e86db79b7d1bbc5f2f04e99954cbd5eae0e22bbHyon Kim#define IPADM_NVP_INTFID "_intfid" /* name of IPv6 intfid nvlist */
9e86db79b7d1bbc5f2f04e99954cbd5eae0e22bbHyon Kim#define IPADM_NVP_STATELESS "_stateless" /* IPv6 autoconf stateless */
9e86db79b7d1bbc5f2f04e99954cbd5eae0e22bbHyon Kim#define IPADM_NVP_STATEFUL "_stateful" /* IPv6 autoconf dhcpv6 */
9e86db79b7d1bbc5f2f04e99954cbd5eae0e22bbHyon Kim/* data-store operations */
9e86db79b7d1bbc5f2f04e99954cbd5eae0e22bbHyon Kimtypedef enum {
9e86db79b7d1bbc5f2f04e99954cbd5eae0e22bbHyon Kim * callback arg used by db_wfunc_t that writes to DB. The contents to be
9e86db79b7d1bbc5f2f04e99954cbd5eae0e22bbHyon Kim * written to DB are captured in `dbw_nvl'.
9e86db79b7d1bbc5f2f04e99954cbd5eae0e22bbHyon Kim * door related function declarations and data structures.
9e86db79b7d1bbc5f2f04e99954cbd5eae0e22bbHyon Kim/* The door file for the ipmgmt (ip-interface management) daemon */
9e86db79b7d1bbc5f2f04e99954cbd5eae0e22bbHyon Kim#define IPMGMT_DOOR "/etc/svc/volatile/ipadm/ipmgmt_door"
9e86db79b7d1bbc5f2f04e99954cbd5eae0e22bbHyon Kim/* door call command type */
9e86db79b7d1bbc5f2f04e99954cbd5eae0e22bbHyon Kimtypedef enum {
9e86db79b7d1bbc5f2f04e99954cbd5eae0e22bbHyon Kim IPMGMT_CMD_GETPROP, /* retrieve persisted property value */
9e86db79b7d1bbc5f2f04e99954cbd5eae0e22bbHyon Kim IPMGMT_CMD_GETIF, /* retrieve persisted interface conf. */
9e86db79b7d1bbc5f2f04e99954cbd5eae0e22bbHyon Kim IPMGMT_CMD_GETADDR, /* retrieve persisted addresses */
9e86db79b7d1bbc5f2f04e99954cbd5eae0e22bbHyon Kim IPMGMT_CMD_RESETIF, /* purge interface configuration */
9e86db79b7d1bbc5f2f04e99954cbd5eae0e22bbHyon Kim IPMGMT_CMD_RESETADDR, /* purge address configuration */
9e86db79b7d1bbc5f2f04e99954cbd5eae0e22bbHyon Kim IPMGMT_CMD_RESETPROP, /* purge property configuration */
9e86db79b7d1bbc5f2f04e99954cbd5eae0e22bbHyon Kim IPMGMT_CMD_INITIF, /* retrieve interfaces to initialize */
9e86db79b7d1bbc5f2f04e99954cbd5eae0e22bbHyon Kim IPMGMT_CMD_ADDROBJ_LOOKUPADD, /* addr. object lookup & add */
9e86db79b7d1bbc5f2f04e99954cbd5eae0e22bbHyon Kim IPMGMT_CMD_ADDROBJ_ADD, /* add addr. object to addrobj map */
9e86db79b7d1bbc5f2f04e99954cbd5eae0e22bbHyon Kim IPMGMT_CMD_LIF2ADDROBJ, /* lifname to addrobj mapping */
9e86db79b7d1bbc5f2f04e99954cbd5eae0e22bbHyon Kim IPMGMT_CMD_AOBJNAME2ADDROBJ /* aobjname to addrobj mapping */
9e86db79b7d1bbc5f2f04e99954cbd5eae0e22bbHyon Kim * Note: We need to keep the size of the structure the same on amd64 and i386
9e86db79b7d1bbc5f2f04e99954cbd5eae0e22bbHyon Kim * for all door_call arguments and door_return structures.
9e86db79b7d1bbc5f2f04e99954cbd5eae0e22bbHyon Kim/* door_call argument */
9e86db79b7d1bbc5f2f04e99954cbd5eae0e22bbHyon Kimtypedef struct ipmgmt_arg {
9e86db79b7d1bbc5f2f04e99954cbd5eae0e22bbHyon Kim/* IPMGMT_CMD_{SETPROP|GETPROP|RESETPROP} door_call argument */
9e86db79b7d1bbc5f2f04e99954cbd5eae0e22bbHyon Kimtypedef struct ipmgmt_prop_arg_s {
9e86db79b7d1bbc5f2f04e99954cbd5eae0e22bbHyon Kim * ia_flags used in ipmgmt_prop_arg_t.
9e86db79b7d1bbc5f2f04e99954cbd5eae0e22bbHyon Kim * - APPEND updates the multi-valued property entry with a new value
9e86db79b7d1bbc5f2f04e99954cbd5eae0e22bbHyon Kim * - REDUCE updates the multi-valued property entry by removing a value
9e86db79b7d1bbc5f2f04e99954cbd5eae0e22bbHyon Kim/* IPMGMT_CMD_GETIF door_call argument structure */
9e86db79b7d1bbc5f2f04e99954cbd5eae0e22bbHyon Kimtypedef struct ipmgmt_getif_arg_s {
typedef struct ipmgmt_if_arg_s {
typedef struct ipmgmt_initif_arg_s {
typedef struct ipmgmt_setaddr_arg_s {
typedef struct ipmgmt_getaddr_arg_s {
typedef struct ipmgmt_addr_arg_s {
typedef struct ipmgmt_aobjop_arg_s {
typedef struct ipmgmt_retval_s {
typedef struct ipmgmt_get_rval_s {
typedef struct ipmgmt_getprop_rval_s {
typedef struct ipmgmt_getif_rval_s {
typedef struct ipmgmt_aobjop_rval_s {
#ifdef __cplusplus