blob: f15daaa89385294dcd24efdacda02f6c6fb682ee [file] [log] [blame]
Pavel Emelyanovdec827d2008-04-15 00:36:08 -07001/*
2 * generic net pointers
3 */
4
5#ifndef __NET_GENERIC_H__
6#define __NET_GENERIC_H__
7
Paul Gortmaker187f1882011-11-23 20:12:59 -05008#include <linux/bug.h>
Pavel Emelyanovdec827d2008-04-15 00:36:08 -07009#include <linux/rcupdate.h>
10
11/*
12 * Generic net pointers are to be used by modules to put some private
13 * stuff on the struct net without explicit struct net modification
14 *
15 * The rules are simple:
Eric W. Biederman65c0cfa2009-11-29 15:46:17 +000016 * 1. set pernet_operations->id. After register_pernet_device you
17 * will have the id of your private pointer.
Jiri Pirko05fceb42010-04-23 01:40:47 +000018 * 2. set pernet_operations->size to have the code allocate and free
19 * a private structure pointed to from struct net.
Pavel Emelyanovdec827d2008-04-15 00:36:08 -070020 * 3. do not change this pointer while the net is alive;
21 * 4. do not try to have any private reference on the net_generic object.
22 *
23 * After accomplishing all of the above, the private pointer can be
24 * accessed with the net_generic() call.
25 */
26
27struct net_generic {
Alexey Dobriyan6af2d5f2016-12-02 04:21:32 +030028 union {
29 struct {
30 unsigned int len;
31 struct rcu_head rcu;
32 } s;
Pavel Emelyanovdec827d2008-04-15 00:36:08 -070033
Alexey Dobriyan6af2d5f2016-12-02 04:21:32 +030034 void *ptr[0];
35 };
Pavel Emelyanovdec827d2008-04-15 00:36:08 -070036};
37
Alexey Dobriyanc7d03a02016-11-17 04:58:21 +030038static inline void *net_generic(const struct net *net, unsigned int id)
Pavel Emelyanovdec827d2008-04-15 00:36:08 -070039{
40 struct net_generic *ng;
41 void *ptr;
42
43 rcu_read_lock();
44 ng = rcu_dereference(net->gen);
Alexey Dobriyan6af2d5f2016-12-02 04:21:32 +030045 ptr = ng->ptr[id];
Pavel Emelyanovdec827d2008-04-15 00:36:08 -070046 rcu_read_unlock();
47
48 return ptr;
49}
Pavel Emelyanovdec827d2008-04-15 00:36:08 -070050#endif