[PATCH] Process Events Connector
[sfrench/cifs-2.6.git] / include / linux / connector.h
1 /*
2  *      connector.h
3  * 
4  * 2004-2005 Copyright (c) Evgeniy Polyakov <johnpol@2ka.mipt.ru>
5  * All rights reserved.
6  * 
7  * This program is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 2 of the License, or
10  * (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, write to the Free Software
19  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
20  */
21
22 #ifndef __CONNECTOR_H
23 #define __CONNECTOR_H
24
25 #include <asm/types.h>
26
27 #define CN_IDX_CONNECTOR                0xffffffff
28 #define CN_VAL_CONNECTOR                0xffffffff
29
30 /*
31  * Process Events connector unique ids -- used for message routing
32  */
33 #define CN_IDX_PROC                     0x1
34 #define CN_VAL_PROC                     0x1
35
36 #define CN_NETLINK_USERS                1
37
38 /*
39  * Maximum connector's message size.
40  */
41 #define CONNECTOR_MAX_MSG_SIZE  1024
42
43 /*
44  * idx and val are unique identifiers which 
45  * are used for message routing and 
46  * must be registered in connector.h for in-kernel usage.
47  */
48
49 struct cb_id {
50         __u32 idx;
51         __u32 val;
52 };
53
54 struct cn_msg {
55         struct cb_id id;
56
57         __u32 seq;
58         __u32 ack;
59
60         __u16 len;              /* Length of the following data */
61         __u16 flags;
62         __u8 data[0];
63 };
64
65 /*
66  * Notify structure - requests notification about
67  * registering/unregistering idx/val in range [first, first+range].
68  */
69 struct cn_notify_req {
70         __u32 first;
71         __u32 range;
72 };
73
74 /*
75  * Main notification control message
76  * *_notify_num         - number of appropriate cn_notify_req structures after 
77  *                              this struct.
78  * group                - notification receiver's idx.
79  * len                  - total length of the attached data.
80  */
81 struct cn_ctl_msg {
82         __u32 idx_notify_num;
83         __u32 val_notify_num;
84         __u32 group;
85         __u32 len;
86         __u8 data[0];
87 };
88
89 #ifdef __KERNEL__
90
91 #include <asm/atomic.h>
92
93 #include <linux/list.h>
94 #include <linux/workqueue.h>
95
96 #include <net/sock.h>
97
98 #define CN_CBQ_NAMELEN          32
99
100 struct cn_queue_dev {
101         atomic_t refcnt;
102         unsigned char name[CN_CBQ_NAMELEN];
103
104         struct workqueue_struct *cn_queue;
105
106         struct list_head queue_list;
107         spinlock_t queue_lock;
108
109         int netlink_groups;
110         struct sock *nls;
111 };
112
113 struct cn_callback_id {
114         unsigned char name[CN_CBQ_NAMELEN];
115         struct cb_id id;
116 };
117
118 struct cn_callback_data {
119         void (*destruct_data) (void *);
120         void *ddata;
121         
122         void *callback_priv;
123         void (*callback) (void *);
124
125         void *free;
126 };
127
128 struct cn_callback_entry {
129         struct list_head callback_entry;
130         struct cn_callback *cb;
131         struct work_struct work;
132         struct cn_queue_dev *pdev;
133
134         struct cn_callback_id id;
135         struct cn_callback_data data;
136
137         int seq, group;
138         struct sock *nls;
139 };
140
141 struct cn_ctl_entry {
142         struct list_head notify_entry;
143         struct cn_ctl_msg *msg;
144 };
145
146 struct cn_dev {
147         struct cb_id id;
148
149         u32 seq, groups;
150         struct sock *nls;
151         void (*input) (struct sock * sk, int len);
152
153         struct cn_queue_dev *cbdev;
154 };
155
156 int cn_add_callback(struct cb_id *, char *, void (*callback) (void *));
157 void cn_del_callback(struct cb_id *);
158 int cn_netlink_send(struct cn_msg *, u32, gfp_t);
159
160 int cn_queue_add_callback(struct cn_queue_dev *dev, char *name, struct cb_id *id, void (*callback)(void *));
161 void cn_queue_del_callback(struct cn_queue_dev *dev, struct cb_id *id);
162
163 struct cn_queue_dev *cn_queue_alloc_dev(char *name, struct sock *);
164 void cn_queue_free_dev(struct cn_queue_dev *dev);
165
166 int cn_cb_equal(struct cb_id *, struct cb_id *);
167
168 void cn_queue_wrapper(void *data);
169
170 extern int cn_already_initialized;
171
172 #endif                          /* __KERNEL__ */
173 #endif                          /* __CONNECTOR_H */