blob: 0931618c0f7ff6d41f72db1103b2aa0dc474e21f [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 {
28 unsigned int len;
29 struct rcu_head rcu;
30
31 void *ptr[0];
32};
33
Jan Engelhardt20a95a22010-11-20 18:07:21 +000034static inline void *net_generic(const struct net *net, int id)
Pavel Emelyanovdec827d2008-04-15 00:36:08 -070035{
36 struct net_generic *ng;
37 void *ptr;
38
39 rcu_read_lock();
40 ng = rcu_dereference(net->gen);
41 BUG_ON(id == 0 || id > ng->len);
42 ptr = ng->ptr[id - 1];
43 rcu_read_unlock();
44
Eric W. Biederman5ee44332012-01-26 14:02:55 +000045 BUG_ON(!ptr);
Pavel Emelyanovdec827d2008-04-15 00:36:08 -070046 return ptr;
47}
Pavel Emelyanovdec827d2008-04-15 00:36:08 -070048#endif