xref: /linux-6.15/include/linux/connector.h (revision 87c2ce3b)
1 /*
2  * 	connector.h
3  *
4  * 2004-2005 Copyright (c) Evgeniy Polyakov <[email protected]>
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 #define CN_IDX_CIFS			0x2
36 #define CN_VAL_CIFS                     0x1
37 
38 #define CN_NETLINK_USERS		1
39 
40 /*
41  * Maximum connector's message size.
42  */
43 #define CONNECTOR_MAX_MSG_SIZE 	1024
44 
45 /*
46  * idx and val are unique identifiers which
47  * are used for message routing and
48  * must be registered in connector.h for in-kernel usage.
49  */
50 
51 struct cb_id {
52 	__u32 idx;
53 	__u32 val;
54 };
55 
56 struct cn_msg {
57 	struct cb_id id;
58 
59 	__u32 seq;
60 	__u32 ack;
61 
62 	__u16 len;		/* Length of the following data */
63 	__u16 flags;
64 	__u8 data[0];
65 };
66 
67 /*
68  * Notify structure - requests notification about
69  * registering/unregistering idx/val in range [first, first+range].
70  */
71 struct cn_notify_req {
72 	__u32 first;
73 	__u32 range;
74 };
75 
76 /*
77  * Main notification control message
78  * *_notify_num 	- number of appropriate cn_notify_req structures after
79  *				this struct.
80  * group 		- notification receiver's idx.
81  * len 			- total length of the attached data.
82  */
83 struct cn_ctl_msg {
84 	__u32 idx_notify_num;
85 	__u32 val_notify_num;
86 	__u32 group;
87 	__u32 len;
88 	__u8 data[0];
89 };
90 
91 #ifdef __KERNEL__
92 
93 #include <asm/atomic.h>
94 
95 #include <linux/list.h>
96 #include <linux/workqueue.h>
97 
98 #include <net/sock.h>
99 
100 #define CN_CBQ_NAMELEN		32
101 
102 struct cn_queue_dev {
103 	atomic_t refcnt;
104 	unsigned char name[CN_CBQ_NAMELEN];
105 
106 	struct workqueue_struct *cn_queue;
107 
108 	struct list_head queue_list;
109 	spinlock_t queue_lock;
110 
111 	int netlink_groups;
112 	struct sock *nls;
113 };
114 
115 struct cn_callback_id {
116 	unsigned char name[CN_CBQ_NAMELEN];
117 	struct cb_id id;
118 };
119 
120 struct cn_callback_data {
121 	void (*destruct_data) (void *);
122 	void *ddata;
123 
124 	void *callback_priv;
125 	void (*callback) (void *);
126 
127 	void *free;
128 };
129 
130 struct cn_callback_entry {
131 	struct list_head callback_entry;
132 	struct cn_callback *cb;
133 	struct work_struct work;
134 	struct cn_queue_dev *pdev;
135 
136 	struct cn_callback_id id;
137 	struct cn_callback_data data;
138 
139 	int seq, group;
140 	struct sock *nls;
141 };
142 
143 struct cn_ctl_entry {
144 	struct list_head notify_entry;
145 	struct cn_ctl_msg *msg;
146 };
147 
148 struct cn_dev {
149 	struct cb_id id;
150 
151 	u32 seq, groups;
152 	struct sock *nls;
153 	void (*input) (struct sock * sk, int len);
154 
155 	struct cn_queue_dev *cbdev;
156 };
157 
158 int cn_add_callback(struct cb_id *, char *, void (*callback) (void *));
159 void cn_del_callback(struct cb_id *);
160 int cn_netlink_send(struct cn_msg *, u32, gfp_t);
161 
162 int cn_queue_add_callback(struct cn_queue_dev *dev, char *name, struct cb_id *id, void (*callback)(void *));
163 void cn_queue_del_callback(struct cn_queue_dev *dev, struct cb_id *id);
164 
165 struct cn_queue_dev *cn_queue_alloc_dev(char *name, struct sock *);
166 void cn_queue_free_dev(struct cn_queue_dev *dev);
167 
168 int cn_cb_equal(struct cb_id *, struct cb_id *);
169 
170 void cn_queue_wrapper(void *data);
171 
172 extern int cn_already_initialized;
173 
174 #endif				/* __KERNEL__ */
175 #endif				/* __CONNECTOR_H */
176