4 * 2004-2005 Copyright (c) Evgeniy Polyakov <johnpol@2ka.mipt.ru>
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.
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.
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
22 #include <linux/kernel.h>
23 #include <linux/module.h>
24 #include <linux/list.h>
25 #include <linux/skbuff.h>
26 #include <linux/netlink.h>
27 #include <linux/moduleparam.h>
28 #include <linux/connector.h>
29 #include <linux/mutex.h>
30 #include <linux/proc_fs.h>
31 #include <linux/spinlock.h>
35 MODULE_LICENSE("GPL");
36 MODULE_AUTHOR("Evgeniy Polyakov <johnpol@2ka.mipt.ru>");
37 MODULE_DESCRIPTION("Generic userspace <-> kernelspace connector.");
39 static u32 cn_idx
= CN_IDX_CONNECTOR
;
40 static u32 cn_val
= CN_VAL_CONNECTOR
;
42 module_param(cn_idx
, uint
, 0);
43 module_param(cn_val
, uint
, 0);
44 MODULE_PARM_DESC(cn_idx
, "Connector's main device idx.");
45 MODULE_PARM_DESC(cn_val
, "Connector's main device val.");
47 static DEFINE_MUTEX(notify_lock
);
48 static LIST_HEAD(notify_list
);
50 static struct cn_dev cdev
;
52 static int cn_already_initialized
;
55 * msg->seq and msg->ack are used to determine message genealogy.
56 * When someone sends message it puts there locally unique sequence
57 * and random acknowledge numbers. Sequence number may be copied into
58 * nlmsghdr->nlmsg_seq too.
60 * Sequence number is incremented with each message to be sent.
62 * If we expect reply to our message then the sequence number in
63 * received message MUST be the same as in original message, and
64 * acknowledge number MUST be the same + 1.
66 * If we receive a message and its sequence number is not equal to the
67 * one we are expecting then it is a new message.
69 * If we receive a message and its sequence number is the same as one
70 * we are expecting but it's acknowledgement number is not equal to
71 * the acknowledgement number in the original message + 1, then it is
75 int cn_netlink_send(struct cn_msg
*msg
, u32 __group
, gfp_t gfp_mask
)
77 struct cn_callback_entry
*__cbq
;
82 struct cn_dev
*dev
= &cdev
;
87 spin_lock_bh(&dev
->cbdev
->queue_lock
);
88 list_for_each_entry(__cbq
, &dev
->cbdev
->queue_list
,
90 if (cn_cb_equal(&__cbq
->id
.id
, &msg
->id
)) {
96 spin_unlock_bh(&dev
->cbdev
->queue_lock
);
104 if (!netlink_has_listeners(dev
->nls
, group
))
107 size
= NLMSG_SPACE(sizeof(*msg
) + msg
->len
);
109 skb
= alloc_skb(size
, gfp_mask
);
113 nlh
= NLMSG_PUT(skb
, 0, msg
->seq
, NLMSG_DONE
, size
- sizeof(*nlh
));
115 data
= NLMSG_DATA(nlh
);
117 memcpy(data
, msg
, sizeof(*data
) + msg
->len
);
119 NETLINK_CB(skb
).dst_group
= group
;
121 return netlink_broadcast(dev
->nls
, skb
, 0, group
, gfp_mask
);
127 EXPORT_SYMBOL_GPL(cn_netlink_send
);
130 * Callback helper - queues work and setup destructor for given data.
132 static int cn_call_callback(struct cn_msg
*msg
, void (*destruct_data
)(void *), void *data
)
134 struct cn_callback_entry
*__cbq
, *__new_cbq
;
135 struct cn_dev
*dev
= &cdev
;
138 spin_lock_bh(&dev
->cbdev
->queue_lock
);
139 list_for_each_entry(__cbq
, &dev
->cbdev
->queue_list
, callback_entry
) {
140 if (cn_cb_equal(&__cbq
->id
.id
, &msg
->id
)) {
141 if (likely(!work_pending(&__cbq
->work
) &&
142 __cbq
->data
.ddata
== NULL
)) {
143 __cbq
->data
.callback_priv
= msg
;
145 __cbq
->data
.ddata
= data
;
146 __cbq
->data
.destruct_data
= destruct_data
;
148 if (queue_cn_work(__cbq
, &__cbq
->work
))
153 struct cn_callback_data
*d
;
156 __new_cbq
= kzalloc(sizeof(struct cn_callback_entry
), GFP_ATOMIC
);
158 d
= &__new_cbq
->data
;
159 d
->callback_priv
= msg
;
160 d
->callback
= __cbq
->data
.callback
;
162 d
->destruct_data
= destruct_data
;
165 __new_cbq
->pdev
= __cbq
->pdev
;
167 INIT_WORK(&__new_cbq
->work
,
170 if (queue_cn_work(__new_cbq
,
182 spin_unlock_bh(&dev
->cbdev
->queue_lock
);
188 * Main netlink receiving function.
190 * It checks skb, netlink header and msg sizes, and calls callback helper.
192 static void cn_rx_skb(struct sk_buff
*__skb
)
195 struct nlmsghdr
*nlh
;
199 skb
= skb_get(__skb
);
201 if (skb
->len
>= NLMSG_SPACE(0)) {
202 nlh
= nlmsg_hdr(skb
);
204 if (nlh
->nlmsg_len
< sizeof(struct cn_msg
) ||
205 skb
->len
< nlh
->nlmsg_len
||
206 nlh
->nlmsg_len
> CONNECTOR_MAX_MSG_SIZE
) {
211 msg
= NLMSG_DATA(nlh
);
212 err
= cn_call_callback(msg
, (void (*)(void *))kfree_skb
, skb
);
219 * Notification routing.
221 * Gets id and checks if there are notification request for it's idx
222 * and val. If there are such requests notify the listeners with the
223 * given notify event.
226 static void cn_notify(struct cb_id
*id
, u32 notify_event
)
228 struct cn_ctl_entry
*ent
;
230 mutex_lock(¬ify_lock
);
231 list_for_each_entry(ent
, ¬ify_list
, notify_entry
) {
233 struct cn_notify_req
*req
;
234 struct cn_ctl_msg
*ctl
= ent
->msg
;
235 int idx_found
, val_found
;
237 idx_found
= val_found
= 0;
239 req
= (struct cn_notify_req
*)ctl
->data
;
240 for (i
= 0; i
< ctl
->idx_notify_num
; ++i
, ++req
) {
241 if (id
->idx
>= req
->first
&&
242 id
->idx
< req
->first
+ req
->range
) {
248 for (i
= 0; i
< ctl
->val_notify_num
; ++i
, ++req
) {
249 if (id
->val
>= req
->first
&&
250 id
->val
< req
->first
+ req
->range
) {
256 if (idx_found
&& val_found
) {
257 struct cn_msg m
= { .ack
= notify_event
, };
259 memcpy(&m
.id
, id
, sizeof(m
.id
));
260 cn_netlink_send(&m
, ctl
->group
, GFP_KERNEL
);
263 mutex_unlock(¬ify_lock
);
267 * Callback add routing - adds callback with given ID and name.
268 * If there is registered callback with the same ID it will not be added.
272 int cn_add_callback(struct cb_id
*id
, char *name
, void (*callback
)(void *))
275 struct cn_dev
*dev
= &cdev
;
277 if (!cn_already_initialized
)
280 err
= cn_queue_add_callback(dev
->cbdev
, name
, id
, callback
);
288 EXPORT_SYMBOL_GPL(cn_add_callback
);
291 * Callback remove routing - removes callback
293 * If there is no registered callback with given
294 * ID nothing happens.
296 * May sleep while waiting for reference counter to become zero.
298 void cn_del_callback(struct cb_id
*id
)
300 struct cn_dev
*dev
= &cdev
;
302 cn_queue_del_callback(dev
->cbdev
, id
);
305 EXPORT_SYMBOL_GPL(cn_del_callback
);
308 * Checks two connector's control messages to be the same.
309 * Returns 1 if they are the same or if the first one is corrupted.
311 static int cn_ctl_msg_equals(struct cn_ctl_msg
*m1
, struct cn_ctl_msg
*m2
)
314 struct cn_notify_req
*req1
, *req2
;
316 if (m1
->idx_notify_num
!= m2
->idx_notify_num
)
319 if (m1
->val_notify_num
!= m2
->val_notify_num
)
322 if (m1
->len
!= m2
->len
)
325 if ((m1
->idx_notify_num
+ m1
->val_notify_num
) * sizeof(*req1
) !=
329 req1
= (struct cn_notify_req
*)m1
->data
;
330 req2
= (struct cn_notify_req
*)m2
->data
;
332 for (i
= 0; i
< m1
->idx_notify_num
; ++i
) {
333 if (req1
->first
!= req2
->first
|| req1
->range
!= req2
->range
)
339 for (i
= 0; i
< m1
->val_notify_num
; ++i
) {
340 if (req1
->first
!= req2
->first
|| req1
->range
!= req2
->range
)
350 * Main connector device's callback.
352 * Used for notification of a request's processing.
354 static void cn_callback(void *data
)
356 struct cn_msg
*msg
= data
;
357 struct cn_ctl_msg
*ctl
;
358 struct cn_ctl_entry
*ent
;
361 if (msg
->len
< sizeof(*ctl
))
364 ctl
= (struct cn_ctl_msg
*)msg
->data
;
366 size
= (sizeof(*ctl
) + ((ctl
->idx_notify_num
+
367 ctl
->val_notify_num
) *
368 sizeof(struct cn_notify_req
)));
370 if (msg
->len
!= size
)
373 if (ctl
->len
+ sizeof(*ctl
) != msg
->len
)
377 * Remove notification.
379 if (ctl
->group
== 0) {
380 struct cn_ctl_entry
*n
;
382 mutex_lock(¬ify_lock
);
383 list_for_each_entry_safe(ent
, n
, ¬ify_list
, notify_entry
) {
384 if (cn_ctl_msg_equals(ent
->msg
, ctl
)) {
385 list_del(&ent
->notify_entry
);
389 mutex_unlock(¬ify_lock
);
394 size
+= sizeof(*ent
);
396 ent
= kzalloc(size
, GFP_KERNEL
);
400 ent
->msg
= (struct cn_ctl_msg
*)(ent
+ 1);
402 memcpy(ent
->msg
, ctl
, size
- sizeof(*ent
));
404 mutex_lock(¬ify_lock
);
405 list_add(&ent
->notify_entry
, ¬ify_list
);
406 mutex_unlock(¬ify_lock
);
409 static int cn_proc_show(struct seq_file
*m
, void *v
)
411 struct cn_queue_dev
*dev
= cdev
.cbdev
;
412 struct cn_callback_entry
*cbq
;
414 seq_printf(m
, "Name ID\n");
416 spin_lock_bh(&dev
->queue_lock
);
418 list_for_each_entry(cbq
, &dev
->queue_list
, callback_entry
) {
419 seq_printf(m
, "%-15s %u:%u\n",
425 spin_unlock_bh(&dev
->queue_lock
);
430 static int cn_proc_open(struct inode
*inode
, struct file
*file
)
432 return single_open(file
, cn_proc_show
, NULL
);
435 static const struct file_operations cn_file_ops
= {
436 .owner
= THIS_MODULE
,
437 .open
= cn_proc_open
,
440 .release
= single_release
443 static int __devinit
cn_init(void)
445 struct cn_dev
*dev
= &cdev
;
448 dev
->input
= cn_rx_skb
;
449 dev
->id
.idx
= cn_idx
;
450 dev
->id
.val
= cn_val
;
452 dev
->nls
= netlink_kernel_create(&init_net
, NETLINK_CONNECTOR
,
453 CN_NETLINK_USERS
+ 0xf,
454 dev
->input
, NULL
, THIS_MODULE
);
458 dev
->cbdev
= cn_queue_alloc_dev("cqueue", dev
->nls
);
460 netlink_kernel_release(dev
->nls
);
464 cn_already_initialized
= 1;
466 err
= cn_add_callback(&dev
->id
, "connector", &cn_callback
);
468 cn_already_initialized
= 0;
469 cn_queue_free_dev(dev
->cbdev
);
470 netlink_kernel_release(dev
->nls
);
474 proc_net_fops_create(&init_net
, "connector", S_IRUGO
, &cn_file_ops
);
479 static void __devexit
cn_fini(void)
481 struct cn_dev
*dev
= &cdev
;
483 cn_already_initialized
= 0;
485 proc_net_remove(&init_net
, "connector");
487 cn_del_callback(&dev
->id
);
488 cn_queue_free_dev(dev
->cbdev
);
489 netlink_kernel_release(dev
->nls
);
492 subsys_initcall(cn_init
);
493 module_exit(cn_fini
);