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 <linux/atomic.h>
   8 #include <linux/workqueue.h>
   9 #include <linux/list.h>
  10 #include <linux/sysctl.h>
  11
  12 #include <net/flow.h>
  13 #include <net/netns/core.h>
  14 #include <net/netns/mib.h>
  15 #include <net/netns/unix.h>
  16 #include <net/netns/packet.h>
  17 #include <net/netns/ipv4.h>
  18 #include <net/netns/ipv6.h>
  19 #include <net/netns/ieee802154_6lowpan.h>
  20 #include <net/netns/sctp.h>
  21 #include <net/netns/dccp.h>
  22 #include <net/netns/netfilter.h>
  23 #include <net/netns/x_tables.h>
  24 #if defined(CONFIG_NF_CONNTRACK) || defined(CONFIG_NF_CONNTRACK_MODULE)
  25 #include <net/netns/conntrack.h>
  26 #endif
  27 #include <net/netns/nftables.h>
  28 #include <net/netns/xfrm.h>
  29 #include <net/netns/mpls.h>
  30 #include <linux/ns_common.h>
  31 #include <linux/idr.h>
  32 #include <linux/skbuff.h>
  33
  34 struct user_namespace;
  35 struct proc_dir_entry;
  36 struct net_device;
  37 struct sock;
  38 struct ctl_table_header;
  39 struct net_generic;
  40 struct sock;
  41 struct netns_ipvs;
  42
  43
  44 #define NETDEV_HASHBITS    8
  45 #define NETDEV_HASHENTRIES (1 << NETDEV_HASHBITS)
  46
  47 struct net {
  48         atomic_t                passive;        /* To decided when the network
  49                                                  * namespace should be freed.
  50                                                  */
  51         atomic_t                count;          /* To decided when the network
  52                                                  *  namespace should be shut down.
  53                                                  */
  54         spinlock_t              rules_mod_lock;
  55
  56         u32                     hash_mix;
  57         atomic64_t              cookie_gen;
  58
  59         struct list_head        list;           /* list of network namespaces */
  60         struct list_head        cleanup_list;   /* namespaces on death row */
  61         struct list_head        exit_list;      /* Use only net_mutex */
  62
  63         struct user_namespace   *user_ns;       /* Owning user namespace */
  64         spinlock_t              nsid_lock;
  65         struct idr              netns_ids;
  66
  67         struct ns_common        ns;
  68
  69         struct proc_dir_entry   *proc_net;
  70         struct proc_dir_entry   *proc_net_stat;
  71
  72 #ifdef CONFIG_SYSCTL
  73         struct ctl_table_set    sysctls;
  74 #endif
  75
  76         struct sock             *rtnl;                  /* rtnetlink socket */
  77         struct sock             *genl_sock;
  78
  79         struct list_head        dev_base_head;
  80         struct hlist_head       *dev_name_head;
  81         struct hlist_head       *dev_index_head;
  82         unsigned int            dev_base_seq;   /* protected by rtnl_mutex */
  83         int                     ifindex;
  84         unsigned int            dev_unreg_count;
  85
  86         /* core fib_rules */
  87         struct list_head        rules_ops;
  88
  89
  90         struct net_device       *loopback_dev;          /* The loopback */
  91         struct netns_core       core;
  92         struct netns_mib        mib;
  93         struct netns_packet     packet;
  94         struct netns_unix       unx;
  95         struct netns_ipv4       ipv4;
  96 #if IS_ENABLED(CONFIG_IPV6)
  97         struct netns_ipv6       ipv6;
  98 #endif
  99 #if IS_ENABLED(CONFIG_IEEE802154_6LOWPAN)
 100         struct netns_ieee802154_lowpan  ieee802154_lowpan;
 101 #endif
 102 #if defined(CONFIG_IP_SCTP) || defined(CONFIG_IP_SCTP_MODULE)
 103         struct netns_sctp       sctp;
 104 #endif
 105 #if defined(CONFIG_IP_DCCP) || defined(CONFIG_IP_DCCP_MODULE)
 106         struct netns_dccp       dccp;
 107 #endif
 108 #ifdef CONFIG_NETFILTER
 109         struct netns_nf         nf;
 110         struct netns_xt         xt;
 111 #if defined(CONFIG_NF_CONNTRACK) || defined(CONFIG_NF_CONNTRACK_MODULE)
 112         struct netns_ct         ct;
 113 #endif
 114 #if defined(CONFIG_NF_TABLES) || defined(CONFIG_NF_TABLES_MODULE)
 115         struct netns_nftables   nft;
 116 #endif
 117 #if IS_ENABLED(CONFIG_NF_DEFRAG_IPV6)
 118         struct netns_nf_frag    nf_frag;
 119         struct ctl_table_header *nf_frag_frags_hdr;
 120 #endif
 121         struct sock             *nfnl;
 122         struct sock             *nfnl_stash;
 123 #if IS_ENABLED(CONFIG_NETFILTER_NETLINK_ACCT)
 124         struct list_head        nfnl_acct_list;
 125 #endif
 126 #endif
 127 #ifdef CONFIG_WEXT_CORE
 128         struct sk_buff_head     wext_nlevents;
 129 #endif
 130         struct net_generic __rcu        *gen;
 131
 132         /* Note : following structs are cache line aligned */
 133 #ifdef CONFIG_XFRM
 134         struct netns_xfrm       xfrm;
 135 #endif
 136 #if IS_ENABLED(CONFIG_IP_VS)
 137         struct netns_ipvs       *ipvs;
 138 #endif
 139 #if IS_ENABLED(CONFIG_MPLS)
 140         struct netns_mpls       mpls;
 141 #endif
 142         struct sock             *diag_nlsk;
 143         atomic_t                fnhe_genid;
 144 };
 145
 146 #include <linux/seq_file_net.h>
 147
 148 /* Init's network namespace */
 149 extern struct net init_net;
 150
 151 #ifdef CONFIG_NET_NS
 152 struct net *copy_net_ns(unsigned long flags, struct user_namespace *user_ns,
 153                         struct net *old_net);
 154
 155 #else /* CONFIG_NET_NS */
 156 #include <linux/sched.h>
 157 #include <linux/nsproxy.h>
 158 static inline struct net *copy_net_ns(unsigned long flags,
 159         struct user_namespace *user_ns, struct net *old_net)
 160 {
 161         if (flags & CLONE_NEWNET)
 162                 return ERR_PTR(-EINVAL);
 163         return old_net;
 164 }
 165 #endif /* CONFIG_NET_NS */
 166
 167
 168 extern struct list_head net_namespace_list;
 169
 170 struct net *get_net_ns_by_pid(pid_t pid);
 171 struct net *get_net_ns_by_fd(int pid);
 172
 173 #ifdef CONFIG_SYSCTL
 174 void ipx_register_sysctl(void);
 175 void ipx_unregister_sysctl(void);
 176 #else
 177 #define ipx_register_sysctl()
 178 #define ipx_unregister_sysctl()
 179 #endif
 180
 181 #ifdef CONFIG_NET_NS
 182 void __put_net(struct net *net);
 183
 184 static inline struct net *get_net(struct net *net)
 185 {
 186         atomic_inc(&net->count);
 187         return net;
 188 }
 189
 190 static inline struct net *maybe_get_net(struct net *net)
 191 {
 192         /* Used when we know struct net exists but we
 193          * aren't guaranteed a previous reference count
 194          * exists.  If the reference count is zero this
 195          * function fails and returns NULL.
 196          */
 197         if (!atomic_inc_not_zero(&net->count))
 198                 net = NULL;
 199         return net;
 200 }
 201
 202 static inline void put_net(struct net *net)
 203 {
 204         if (atomic_dec_and_test(&net->count))
 205                 __put_net(net);
 206 }
 207
 208 static inline
 209 int net_eq(const struct net *net1, const struct net *net2)
 210 {
 211         return net1 == net2;
 212 }
 213
 214 static inline int check_net(const struct net *net)
 215 {
 216         return atomic_read(&net->count) != 0;
 217 }
 218
 219 void net_drop_ns(void *);
 220
 221 #else
 222
 223 static inline struct net *get_net(struct net *net)
 224 {
 225         return net;
 226 }
 227
 228 static inline void put_net(struct net *net)
 229 {
 230 }
 231
 232 static inline struct net *maybe_get_net(struct net *net)
 233 {
 234         return net;
 235 }
 236
 237 static inline
 238 int net_eq(const struct net *net1, const struct net *net2)
 239 {
 240         return 1;
 241 }
 242
 243 static inline int check_net(const struct net *net)
 244 {
 245         return 1;
 246 }
 247
 248 #define net_drop_ns NULL
 249 #endif
 250
 251
 252 typedef struct {
 253 #ifdef CONFIG_NET_NS
 254         struct net *net;
 255 #endif
 256 } possible_net_t;
 257
 258 static inline void write_pnet(possible_net_t *pnet, struct net *net)
 259 {
 260 #ifdef CONFIG_NET_NS
 261         pnet->net = net;
 262 #endif
 263 }
 264
 265 static inline struct net *read_pnet(const possible_net_t *pnet)
 266 {
 267 #ifdef CONFIG_NET_NS
 268         return pnet->net;
 269 #else
 270         return &init_net;
 271 #endif
 272 }
 273
 274 #define for_each_net(VAR)                               \
 275         list_for_each_entry(VAR, &net_namespace_list, list)
 276
 277 #define for_each_net_rcu(VAR)                           \
 278         list_for_each_entry_rcu(VAR, &net_namespace_list, list)
 279
 280 #ifdef CONFIG_NET_NS
 281 #define __net_init
 282 #define __net_exit
 283 #define __net_initdata
 284 #define __net_initconst
 285 #else
 286 #define __net_init      __init
 287 #define __net_exit      __exit_refok
 288 #define __net_initdata  __initdata
 289 #define __net_initconst __initconst
 290 #endif
 291
 292 int peernet2id_alloc(struct net *net, struct net *peer);
 293 int peernet2id(struct net *net, struct net *peer);
 294 bool peernet_has_id(struct net *net, struct net *peer);
 295 struct net *get_net_ns_by_id(struct net *net, int id);
 296
 297 struct pernet_operations {
 298         struct list_head list;
 299         int (*init)(struct net *net);
 300         void (*exit)(struct net *net);
 301         void (*exit_batch)(struct list_head *net_exit_list);
 302         int *id;
 303         size_t size;
 304 };
 305
 306 /*
 307  * Use these carefully.  If you implement a network device and it
 308  * needs per network namespace operations use device pernet operations,
 309  * otherwise use pernet subsys operations.
 310  *
 311  * Network interfaces need to be removed from a dying netns _before_
 312  * subsys notifiers can be called, as most of the network code cleanup
 313  * (which is done from subsys notifiers) runs with the assumption that
 314  * dev_remove_pack has been called so no new packets will arrive during
 315  * and after the cleanup functions have been called.  dev_remove_pack
 316  * is not per namespace so instead the guarantee of no more packets
 317  * arriving in a network namespace is provided by ensuring that all
 318  * network devices and all sockets have left the network namespace
 319  * before the cleanup methods are called.
 320  *
 321  * For the longest time the ipv4 icmp code was registered as a pernet
 322  * device which caused kernel oops, and panics during network
 323  * namespace cleanup.   So please don't get this wrong.
 324  */
 325 int register_pernet_subsys(struct pernet_operations *);
 326 void unregister_pernet_subsys(struct pernet_operations *);
 327 int register_pernet_device(struct pernet_operations *);
 328 void unregister_pernet_device(struct pernet_operations *);
 329
 330 struct ctl_table;
 331 struct ctl_table_header;
 332
 333 #ifdef CONFIG_SYSCTL
 334 int net_sysctl_init(void);
 335 struct ctl_table_header *register_net_sysctl(struct net *net, const char *path,
 336                                              struct ctl_table *table);
 337 void unregister_net_sysctl_table(struct ctl_table_header *header);
 338 #else
 339 static inline int net_sysctl_init(void) { return 0; }
 340 static inline struct ctl_table_header *register_net_sysctl(struct net *net,
 341         const char *path, struct ctl_table *table)
 342 {
 343         return NULL;
 344 }
 345 static inline void unregister_net_sysctl_table(struct ctl_table_header *header)
 346 {
 347 }
 348 #endif
 349
 350 static inline int rt_genid_ipv4(struct net *net)
 351 {
 352         return atomic_read(&net->ipv4.rt_genid);
 353 }
 354
 355 static inline void rt_genid_bump_ipv4(struct net *net)
 356 {
 357         atomic_inc(&net->ipv4.rt_genid);
 358 }
 359
 360 extern void (*__fib6_flush_trees)(struct net *net);
 361 static inline void rt_genid_bump_ipv6(struct net *net)
 362 {
 363         if (__fib6_flush_trees)
 364                 __fib6_flush_trees(net);
 365 }
 366
 367 #if IS_ENABLED(CONFIG_IEEE802154_6LOWPAN)
 368 static inline struct netns_ieee802154_lowpan *
 369 net_ieee802154_lowpan(struct net *net)
 370 {
 371         return &net->ieee802154_lowpan;
 372 }
 373 #endif
 374
 375 /* For callers who don't really care about whether it's IPv4 or IPv6 */
 376 static inline void rt_genid_bump_all(struct net *net)
 377 {
 378         rt_genid_bump_ipv4(net);
 379         rt_genid_bump_ipv6(net);
 380 }
 381
 382 static inline int fnhe_genid(struct net *net)
 383 {
 384         return atomic_read(&net->fnhe_genid);
 385 }
 386
 387 static inline void fnhe_genid_bump(struct net *net)
 388 {
 389         atomic_inc(&net->fnhe_genid);
 390 }
 391
 392 #endif /* __NET_NET_NAMESPACE_H */