include/net/net_namespace.h

   1 /*
   2  * Operations on the network namespace
   3  */
   4 #ifndef __NET_NET_NAMESPACE_H
   5 #define __NET_NET_NAMESPACE_H
   6
   7 #include <asm/atomic.h>
   8 #include <linux/workqueue.h>
   9 #include <linux/list.h>
  10
  11 #include <net/netns/core.h>
  12 #include <net/netns/mib.h>
  13 #include <net/netns/unix.h>
  14 #include <net/netns/packet.h>
  15 #include <net/netns/ipv4.h>
  16 #include <net/netns/ipv6.h>
  17 #include <net/netns/dccp.h>
  18 #include <net/netns/x_tables.h>
  19 #if defined(CONFIG_NF_CONNTRACK) || defined(CONFIG_NF_CONNTRACK_MODULE)
  20 #include <net/netns/conntrack.h>
  21 #endif
  22 #include <net/netns/xfrm.h>
  23
  24 struct proc_dir_entry;
  25 struct net_device;
  26 struct sock;
  27 struct ctl_table_header;
  28 struct net_generic;
  29 struct sock;
  30
  31 struct net {
  32         atomic_t                count;          /* To decided when the network
  33                                                  *  namespace should be freed.
  34                                                  */
  35 #ifdef NETNS_REFCNT_DEBUG
  36         atomic_t                use_count;      /* To track references we
  37                                                  * destroy on demand
  38                                                  */
  39 #endif
  40         struct list_head        list;           /* list of network namespaces */
  41         struct work_struct      work;           /* work struct for freeing */
  42
  43         struct proc_dir_entry   *proc_net;
  44         struct proc_dir_entry   *proc_net_stat;
  45
  46 #ifdef CONFIG_SYSCTL
  47         struct ctl_table_set    sysctls;
  48 #endif
  49
  50         struct net_device       *loopback_dev;          /* The loopback */
  51
  52         struct list_head        dev_base_head;
  53         struct hlist_head       *dev_name_head;
  54         struct hlist_head       *dev_index_head;
  55
  56         /* core fib_rules */
  57         struct list_head        rules_ops;
  58         spinlock_t              rules_mod_lock;
  59
  60         struct sock             *rtnl;                  /* rtnetlink socket */
  61         struct sock             *genl_sock;
  62
  63         struct netns_core       core;
  64         struct netns_mib        mib;
  65         struct netns_packet     packet;
  66         struct netns_unix       unx;
  67         struct netns_ipv4       ipv4;
  68 #if defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE)
  69         struct netns_ipv6       ipv6;
  70 #endif
  71 #if defined(CONFIG_IP_DCCP) || defined(CONFIG_IP_DCCP_MODULE)
  72         struct netns_dccp       dccp;
  73 #endif
  74 #ifdef CONFIG_NETFILTER
  75         struct netns_xt         xt;
  76 #if defined(CONFIG_NF_CONNTRACK) || defined(CONFIG_NF_CONNTRACK_MODULE)
  77         struct netns_ct         ct;
  78 #endif
  79 #endif
  80 #ifdef CONFIG_XFRM
  81         struct netns_xfrm       xfrm;
  82 #endif
  83         struct net_generic      *gen;
  84 };
  85
  86
  87 #include <linux/seq_file_net.h>
  88
  89 /* Init's network namespace */
  90 extern struct net init_net;
  91
  92 #ifdef CONFIG_NET
  93 #define INIT_NET_NS(net_ns) .net_ns = &init_net,
  94
  95 extern struct net *copy_net_ns(unsigned long flags, struct net *net_ns);
  96
  97 #else /* CONFIG_NET */
  98
  99 #define INIT_NET_NS(net_ns)
 100
 101 static inline struct net *copy_net_ns(unsigned long flags, struct net *net_ns)
 102 {
 103         /* There is nothing to copy so this is a noop */
 104         return net_ns;
 105 }
 106 #endif /* CONFIG_NET */
 107
 108
 109 extern struct list_head net_namespace_list;
 110
 111 extern struct net *get_net_ns_by_pid(pid_t pid);
 112
 113 #ifdef CONFIG_NET_NS
 114 extern void __put_net(struct net *net);
 115
 116 static inline struct net *get_net(struct net *net)
 117 {
 118         atomic_inc(&net->count);
 119         return net;
 120 }
 121
 122 static inline struct net *maybe_get_net(struct net *net)
 123 {
 124         /* Used when we know struct net exists but we
 125          * aren't guaranteed a previous reference count
 126          * exists.  If the reference count is zero this
 127          * function fails and returns NULL.
 128          */
 129         if (!atomic_inc_not_zero(&net->count))
 130                 net = NULL;
 131         return net;
 132 }
 133
 134 static inline void put_net(struct net *net)
 135 {
 136         if (atomic_dec_and_test(&net->count))
 137                 __put_net(net);
 138 }
 139
 140 static inline
 141 int net_eq(const struct net *net1, const struct net *net2)
 142 {
 143         return net1 == net2;
 144 }
 145 #else
 146
 147 static inline struct net *get_net(struct net *net)
 148 {
 149         return net;
 150 }
 151
 152 static inline void put_net(struct net *net)
 153 {
 154 }
 155
 156 static inline struct net *maybe_get_net(struct net *net)
 157 {
 158         return net;
 159 }
 160
 161 static inline
 162 int net_eq(const struct net *net1, const struct net *net2)
 163 {
 164         return 1;
 165 }
 166 #endif
 167
 168
 169 #ifdef NETNS_REFCNT_DEBUG
 170 static inline struct net *hold_net(struct net *net)
 171 {
 172         if (net)
 173                 atomic_inc(&net->use_count);
 174         return net;
 175 }
 176
 177 static inline void release_net(struct net *net)
 178 {
 179         if (net)
 180                 atomic_dec(&net->use_count);
 181 }
 182 #else
 183 static inline struct net *hold_net(struct net *net)
 184 {
 185         return net;
 186 }
 187
 188 static inline void release_net(struct net *net)
 189 {
 190 }
 191 #endif
 192
 193 #ifdef CONFIG_NET_NS
 194
 195 static inline void write_pnet(struct net **pnet, struct net *net)
 196 {
 197         *pnet = net;
 198 }
 199
 200 static inline struct net *read_pnet(struct net * const *pnet)
 201 {
 202         return *pnet;
 203 }
 204
 205 #else
 206
 207 #define write_pnet(pnet, net)   do { (void)(net);} while (0)
 208 #define read_pnet(pnet)         (&init_net)
 209
 210 #endif
 211
 212 #define for_each_net(VAR)                               \
 213         list_for_each_entry(VAR, &net_namespace_list, list)
 214
 215 #define for_each_net_rcu(VAR)                           \
 216         list_for_each_entry_rcu(VAR, &net_namespace_list, list)
 217
 218 #ifdef CONFIG_NET_NS
 219 #define __net_init
 220 #define __net_exit
 221 #define __net_initdata
 222 #else
 223 #define __net_init      __init
 224 #define __net_exit      __exit_refok
 225 #define __net_initdata  __initdata
 226 #endif
 227
 228 struct pernet_operations {
 229         struct list_head list;
 230         int (*init)(struct net *net);
 231         void (*exit)(struct net *net);
 232 };
 233
 234 /*
 235  * Use these carefully.  If you implement a network device and it
 236  * needs per network namespace operations use device pernet operations,
 237  * otherwise use pernet subsys operations.
 238  *
 239  * This is critically important.  Most of the network code cleanup
 240  * runs with the assumption that dev_remove_pack has been called so no
 241  * new packets will arrive during and after the cleanup functions have
 242  * been called.  dev_remove_pack is not per namespace so instead the
 243  * guarantee of no more packets arriving in a network namespace is
 244  * provided by ensuring that all network devices and all sockets have
 245  * left the network namespace before the cleanup methods are called.
 246  *
 247  * For the longest time the ipv4 icmp code was registered as a pernet
 248  * device which caused kernel oops, and panics during network
 249  * namespace cleanup.   So please don't get this wrong.
 250  */
 251 extern int register_pernet_subsys(struct pernet_operations *);
 252 extern void unregister_pernet_subsys(struct pernet_operations *);
 253 extern int register_pernet_gen_subsys(int *id, struct pernet_operations *);
 254 extern void unregister_pernet_gen_subsys(int id, struct pernet_operations *);
 255 extern int register_pernet_device(struct pernet_operations *);
 256 extern void unregister_pernet_device(struct pernet_operations *);
 257 extern int register_pernet_gen_device(int *id, struct pernet_operations *);
 258 extern void unregister_pernet_gen_device(int id, struct pernet_operations *);
 259
 260 struct ctl_path;
 261 struct ctl_table;
 262 struct ctl_table_header;
 263
 264 extern struct ctl_table_header *register_net_sysctl_table(struct net *net,
 265         const struct ctl_path *path, struct ctl_table *table);
 266 extern struct ctl_table_header *register_net_sysctl_rotable(
 267         const struct ctl_path *path, struct ctl_table *table);
 268 extern void unregister_net_sysctl_table(struct ctl_table_header *header);
 269
 270 #endif /* __NET_NET_NAMESPACE_H */