root/sbin/ifconfig/ifconfig.h
/*-
 * SPDX-License-Identifier: BSD-4-Clause
 *
 * Copyright (c) 1997 Peter Wemm.
 * 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, this list 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.
 * 3. All advertising materials mentioning features or use of this software
 *    must display the following acknowledgement:
 *      This product includes software developed for the FreeBSD Project
 *      by Peter Wemm.
 * 4. The name of the author may not be used to endorse or promote products
 *    derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``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 AUTHOR 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.
 *
 * so there!
 */

#pragma once

#include <libifconfig.h>
#include <stdbool.h>
#include <net/if_types.h>

#define __constructor   __attribute__((constructor))

#ifdef WITHOUT_NETLINK
#define __netlink_used          __unused
#define __netlink_unused
#else
#define __netlink_used
#define __netlink_unused        __unused
#endif

struct afswtch;
struct cmd;
struct snl_state;
struct ifconfig_args;
struct ifconfig_context {
        struct ifconfig_args    *args;
        const struct afswtch    *afp;
        int                     io_s;           /* fd to use for ioctl() */
        struct snl_state        *io_ss;         /* NETLINK_ROUTE socket */
        const char              *ifname;        /* Current interface name */
        char                    _ifname_storage_ioctl[IFNAMSIZ];
};
typedef struct ifconfig_context if_ctx;

typedef void c_func(if_ctx *ctx, const char *cmd, int arg);
typedef void c_func2(if_ctx *ctx, const char *arg1, const char *arg2);
typedef void c_func3(if_ctx *ctx, const char *cmd, const char *arg);
typedef int  c_funcv(if_ctx *ctx, int argc, const char *const *argv);

struct cmd {
        const char *c_name;
        int     c_parameter;
#define NEXTARG         0xffffff        /* has following arg */
#define NEXTARG2        0xfffffe        /* has 2 following args */
#define OPTARG          0xfffffd        /* has optional following arg */
#define SPARAM          0xfffffc        /* parameter is string c_sparameter */
#define ARGVECTOR       0xfffffb        /* takes argument vector */
        const char *c_sparameter;
        union {
                c_func  *c_func;
                c_func2 *c_func2;
                c_func3 *c_func3;
                c_funcv *c_funcv;
        } c_u;
        int     c_iscloneop;
        struct cmd *c_next;
};
void    cmd_register(struct cmd *);

typedef void callback_func(if_ctx *, void *);
void    callback_register(callback_func *, void *);

/*
 * Macros for initializing command handlers.
 */

#define DEF_CMD(name, param, func) {            \
    .c_name = (name),                           \
    .c_parameter = (param),                     \
    .c_u = { .c_func = (func) },                \
    .c_iscloneop = 0,                           \
    .c_next = NULL,                             \
}
#define DEF_CMD_ARG(name, func) {               \
    .c_name = (name),                           \
    .c_parameter = NEXTARG,                     \
    .c_u = { .c_func = (func) },                \
    .c_iscloneop = 0,                           \
    .c_next = NULL,                             \
}
#define DEF_CMD_OPTARG(name, func) {            \
    .c_name = (name),                           \
    .c_parameter = OPTARG,                      \
    .c_u = { .c_func = (func) },                \
    .c_iscloneop = 0,                           \
    .c_next = NULL,                             \
}
#define DEF_CMD_ARG2(name, func) {              \
    .c_name = (name),                           \
    .c_parameter = NEXTARG2,                    \
    .c_u = { .c_func2 = (func) },               \
    .c_iscloneop = 0,                           \
    .c_next = NULL,                             \
}
#define DEF_CMD_VARG(name, func) {              \
    .c_name = (name),                           \
    .c_parameter = ARGVECTOR,                   \
    .c_u = { .c_funcv = (func) },               \
    .c_iscloneop = 0,                           \
    .c_next = NULL,                             \
}
#define DEF_CMD_SARG(name, sparam, func) {      \
    .c_name = (name),                           \
    .c_parameter = SPARAM,                      \
    .c_sparameter = (sparam),                   \
    .c_u = { .c_func3 = (func) },               \
    .c_iscloneop = 0,                           \
    .c_next = NULL,                             \
}
#define DEF_CLONE_CMD(name, param, func) {      \
    .c_name = (name),                           \
    .c_parameter = (param),                     \
    .c_u = { .c_func = (func) },                \
    .c_iscloneop = 1,                           \
    .c_next = NULL,                             \
}
#define DEF_CLONE_CMD_ARG(name, func) {         \
    .c_name = (name),                           \
    .c_parameter = NEXTARG,                     \
    .c_u = { .c_func = (func) },                \
    .c_iscloneop = 1,                           \
    .c_next = NULL,                             \
}
#define DEF_CLONE_CMD_ARG2(name, func) {        \
    .c_name = (name),                           \
    .c_parameter = NEXTARG2,                    \
    .c_u = { .c_func2 = (func) },               \
    .c_iscloneop = 1,                           \
    .c_next = NULL,                             \
}

#define ioctl_ctx(ctx, _req, ...)       ioctl((ctx)->io_s, _req, ## __VA_ARGS__)
int ioctl_ctx_ifr(if_ctx *ctx, unsigned long cmd, struct ifreq *ifr);

struct ifaddrs;
struct addrinfo;

enum {
        RIDADDR = 0,
        ADDR = 1,
        MASK = 2,
        DSTADDR = 3,
#ifdef WITHOUT_NETLINK
        BRDADDR = 3,
#else
        BRDADDR = 4,
#endif
};

struct snl_parsed_addr;
struct snl_parsed_link;
typedef struct snl_parsed_link if_link_t;
typedef struct snl_parsed_addr if_addr_t;

typedef void af_setvhid_f(int vhid);
typedef void af_status_nl_f(if_ctx *ctx, if_link_t *link, if_addr_t *ifa);
typedef void af_status_f(if_ctx *ctx, const struct ifaddrs *);
typedef void af_other_status_f(if_ctx *ctx);
typedef void af_postproc_f(if_ctx *ctx, int newaddr, int ifflags);
typedef int af_exec_f(if_ctx *ctx, unsigned long action, void *data);
typedef void af_copyaddr_f(if_ctx *ctx, int to, int from);
typedef void af_status_tunnel_f(if_ctx *ctx);
typedef void af_settunnel_f(if_ctx *ctx, struct addrinfo *srcres, struct addrinfo *dstres);

struct afswtch {
        const char      *af_name;       /* as given on cmd line, e.g. "inet" */
        short           af_af;          /* AF_* */
        /*
         * Status is handled one of two ways; if there is an
         * address associated with the interface then the
         * associated address family af_status method is invoked
         * with the appropriate addressin info.  Otherwise, if
         * all possible info is to be displayed and af_other_status
         * is defined then it is invoked after all address status
         * is presented.
         */
#ifndef WITHOUT_NETLINK
        af_status_nl_f  *af_status;
#else
        af_status_f     *af_status;
#endif
        af_other_status_f       *af_other_status;
        void            (*af_getaddr)(const char *, int);
        af_copyaddr_f   *af_copyaddr;   /* Copy address between <RID|*>ADDR */
                                        /* parse prefix method (IPv6) */
        void            (*af_getprefix)(const char *, int);
        af_postproc_f   *af_postproc;
        af_setvhid_f    *af_setvhid;    /* Set CARP vhid for an address */
        af_exec_f       *af_exec;       /* Handler to interact with kernel */
        u_long          af_difaddr;     /* set dst if address ioctl */
        u_long          af_aifaddr;     /* set if address ioctl */
        void            *af_ridreq;     /* */
        void            *af_addreq;     /* */
        struct afswtch  *af_next;

        /* XXX doesn't fit model */
        af_status_tunnel_f      *af_status_tunnel;
        af_settunnel_f  *af_settunnel;
};
void    af_register(struct afswtch *);
int     af_exec_ioctl(if_ctx *ctx, unsigned long action, void *data);

struct ifconfig_args {
        bool all;               /* Match everything */
        bool downonly;          /* Down-only items */
        bool uponly;            /* Up-only items */
        bool namesonly;         /* Output only names */
        bool noload;            /* Do not load relevant kernel modules */
        bool supmedia;          /* Supported media */
        bool printkeys;         /* Print security keys */
        bool allfamilies;       /* Print all families */
        bool drivername;        /* Print driver name */
        int verbose;            /* verbosity level */
        int argc;
        char **argv;
        const char *ifname;     /* Requested interface name */
        const char *matchgroup;         /* Group name to match */
        const char *nogroup;            /* Group name to exclude */
        const struct afswtch *afp;      /* AF we're operating on */
};

struct option {
        const char *opt;
        const char *opt_usage;
        void    (*cb)(const char *arg);
        struct option *next;
};
void    opt_register(struct option *);

extern  ifconfig_handle_t *lifh;
extern  int allmedia;
extern  int exit_code;
extern  char *f_inet, *f_inet6, *f_ether, *f_addr;

void    clearifcap(if_ctx *ctx, const char *, int value);
void    setifcap(if_ctx *ctx, const char *, int value);
void    setifcapnv(if_ctx *ctx, const char *vname, const char *arg);

void    Perror(const char *cmd);
void    print_bits(const char *btype, uint32_t *v, const int v_count,
                const char **names, const int n_count);
void    printb(const char *s, unsigned value, const char *bits);

void    ifmaybeload(struct ifconfig_args *args, const char *name);

typedef int  clone_match_func(const char *);
typedef void clone_callback_func(if_ctx *, struct ifreq *);
void    clone_setdefcallback_prefix(const char *, clone_callback_func *);
void    clone_setdefcallback_filter(clone_match_func *, clone_callback_func *);

void    sfp_status(if_ctx *ctx);

struct sockaddr_dl;
bool    match_ether(const struct sockaddr_dl *sdl);
bool    match_if_flags(struct ifconfig_args *args, int if_flags);
int     ifconfig_ioctl(if_ctx *ctx, int iscreate, const struct afswtch *uafp);
bool    group_member(const char *ifname, const char *match, const char *nomatch);
void    tunnel_status(if_ctx *ctx);
struct afswtch  *af_getbyfamily(int af);
void    af_other_status(if_ctx *ctx);
void    print_ifstatus(if_ctx *ctx);
void    print_metric(if_ctx *ctx);
ifType  convert_iftype(ifType iftype);

/* Netlink-related functions */
void    list_interfaces_nl(struct ifconfig_args *args);
int     ifconfig_nl(if_ctx *ctx, int iscreate,
                const struct afswtch *uafp);
uint32_t if_nametoindex_nl(struct snl_state *ss, const char *ifname);

/*
 * XXX expose this so modules that need to know of any pending
 * operations on ifmedia can avoid cmd line ordering confusion.
 */
struct ifmediareq *ifmedia_getstate(if_ctx *ctx);

void print_vhid(const struct ifaddrs *);

void ifcreate_ioctl(if_ctx *ctx, struct ifreq *ifr);

/* Helpers */
struct sockaddr_in;
struct sockaddr_in6;
struct sockaddr;

static inline struct sockaddr_in6 *
satosin6(struct sockaddr *sa)
{
        return ((struct sockaddr_in6 *)(void *)sa);
}

static inline struct sockaddr_in *
satosin(struct sockaddr *sa)
{
        return ((struct sockaddr_in *)(void *)sa);
}

static inline struct sockaddr_dl *
satosdl(struct sockaddr *sa)
{
        return ((struct sockaddr_dl *)(void *)sa);
}

static inline const struct sockaddr_dl *
satosdl_c(const struct sockaddr *sa)
{
        return ((const struct sockaddr_dl *)(const void *)sa);
}