lib/ns.h

   1 /*
   2  * NS related header.
   3  * Copyright (C) 2014 6WIND S.A.
   4  *
   5  * This file is part of GNU Zebra.
   6  *
   7  * GNU Zebra is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published
   9  * by the Free Software Foundation; either version 2, or (at your
  10  * option) any later version.
  11  *
  12  * GNU Zebra is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License along
  18  * with this program; see the file COPYING; if not, write to the Free Software
  19  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  20  */
  21
  22 #ifndef _ZEBRA_NS_H
  23 #define _ZEBRA_NS_H
  24
  25 #include "openbsd-tree.h"
  26 #include "linklist.h"
  27 #include "vty.h"
  28
  29 typedef uint32_t ns_id_t;
  30
  31 /* the default NS ID */
  32 #define NS_UNKNOWN UINT32_MAX
  33
  34 /* Default netns directory (Linux) */
  35 #define NS_RUN_DIR         "/var/run/netns"
  36
  37 #ifdef HAVE_NETNS
  38 #define NS_DEFAULT_NAME    "/proc/self/ns/net"
  39 #else  /* !HAVE_NETNS */
  40 #define NS_DEFAULT_NAME    "Default-logical-router"
  41 #endif /* HAVE_NETNS */
  42
  43 struct ns {
  44         RB_ENTRY(ns) entry;
  45
  46         /* Identifier, same as the vector index */
  47         ns_id_t ns_id;
  48
  49         /* Identifier, mapped on the NSID value */
  50         ns_id_t internal_ns_id;
  51
  52         /* Name */
  53         char *name;
  54
  55         /* File descriptor */
  56         int fd;
  57
  58         /* Master list of interfaces belonging to this NS */
  59         struct list *iflist;
  60
  61         /* Back Pointer to VRF */
  62         void *vrf_ctxt;
  63
  64         /* User data */
  65         void *info;
  66 };
  67 RB_HEAD(ns_head, ns);
  68 RB_PROTOTYPE(ns_head, ns, entry, ns_compare)
  69
  70 extern struct ns_head ns_tree;
  71
  72 /*
  73  * API for managing NETNS. eg from zebra daemon
  74  * one want to manage the list of NETNS, etc...
  75  */
  76
  77 /*
  78  * NS hooks
  79  */
  80
  81 #define NS_NEW_HOOK        0   /* a new logical-router is just created */
  82 #define NS_DELETE_HOOK     1   /* a logical-router is to be deleted */
  83 #define NS_ENABLE_HOOK     2   /* a logical-router is ready to use */
  84 #define NS_DISABLE_HOOK    3   /* a logical-router is to be unusable */
  85
  86 /*
  87  * Add a specific hook ns module.
  88  * @param1: hook type
  89  * @param2: the callback function
  90  *          - param 1: the NS ID
  91  *          - param 2: the address of the user data pointer (the user data
  92  *                     can be stored in or freed from there)
  93  */
  94 extern void ns_add_hook(int type, int (*)(struct ns *));
  95
  96
  97 /*
  98  * NS initializer/destructor
  99  */
 100
 101 extern void ns_terminate(void);
 102
 103 /* API to initialize NETNS managerment
 104  * parameter is the default ns_id
 105  */
 106 extern void ns_init_management(ns_id_t ns_id, ns_id_t internal_ns_idx);
 107
 108
 109 /*
 110  * NS utilities
 111  */
 112
 113 /* Create a socket serving for the given NS
 114  */
 115 int ns_socket(int domain, int type, int protocol, ns_id_t ns_id);
 116
 117 /* return the path of the NETNS */
 118 extern char *ns_netns_pathname(struct vty *vty, const char *name);
 119
 120 /* Parse and execute a function on all the NETNS */
 121 extern void ns_walk_func(int (*func)(struct ns *));
 122
 123 /* API to get the NETNS name, from the ns pointer */
 124 extern const char *ns_get_name(struct ns *ns);
 125
 126 /* only called from vrf ( when removing netns from vrf)
 127  * or at VRF or logical router termination
 128  */
 129 extern void ns_delete(struct ns *ns);
 130
 131 /* return > 0 if netns is available
 132  * called by VRF to check netns backend is available for VRF
 133  */
 134 extern int ns_have_netns(void);
 135
 136 /* API to get context information of a NS */
 137 extern void *ns_info_lookup(ns_id_t ns_id);
 138
 139 /* API to map internal ns id value with
 140  * user friendly ns id external value
 141  */
 142 extern ns_id_t ns_map_nsid_with_external(ns_id_t ns_id, bool map);
 143
 144 /*
 145  * NS init routine
 146  * should be called from backendx
 147  */
 148 extern void ns_init(void);
 149
 150 /* API to retrieve default NS */
 151 extern ns_id_t ns_get_default_id(void);
 152
 153 #define NS_DEFAULT ns_get_default_id()
 154
 155 /* API that can be used to change from NS */
 156 extern int ns_switchback_to_initial(void);
 157 extern int ns_switch_to_netns(const char *netns_name);
 158
 159 /*
 160  * NS handling routines.
 161  * called by modules that use NS backend
 162  */
 163
 164 /* API to search for already present NETNS */
 165 extern struct ns *ns_lookup(ns_id_t ns_id);
 166 extern struct ns *ns_lookup_name(const char *name);
 167
 168 /* API to handle NS : creation, enable, disable
 169  * for enable, a callback function is passed as parameter
 170  * the callback belongs to the module that uses NS as backend
 171  * upon enabling the NETNS, the upper layer is informed
 172  */
 173 extern int ns_enable(struct ns *ns, void (*func)(ns_id_t, void *));
 174 extern struct ns *ns_get_created(struct ns *ns, char *name, ns_id_t ns_id);
 175 extern void ns_disable(struct ns *ns);
 176
 177 #endif /*_ZEBRA_NS_H*/