drivers/connector/connector.c

   1 /*
   2  *      connector.c
   3  *
   4  * 2004+ Copyright (c) Evgeniy Polyakov <zbr@ioremap.net>
   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 #include <linux/kernel.h>
  23 #include <linux/module.h>
  24 #include <linux/list.h>
  25 #include <linux/skbuff.h>
  26 #include <net/netlink.h>
  27 #include <linux/moduleparam.h>
  28 #include <linux/connector.h>
  29 #include <linux/slab.h>
  30 #include <linux/mutex.h>
  31 #include <linux/proc_fs.h>
  32 #include <linux/spinlock.h>
  33
  34 #include <net/sock.h>
  35
  36 MODULE_LICENSE("GPL");
  37 MODULE_AUTHOR("Evgeniy Polyakov <zbr@ioremap.net>");
  38 MODULE_DESCRIPTION("Generic userspace <-> kernelspace connector.");
  39 MODULE_ALIAS_NET_PF_PROTO(PF_NETLINK, NETLINK_CONNECTOR);
  40
  41 static struct cn_dev cdev;
  42
  43 static int cn_already_initialized;
  44
  45 /*
  46  * msg->seq and msg->ack are used to determine message genealogy.
  47  * When someone sends message it puts there locally unique sequence
  48  * and random acknowledge numbers.  Sequence number may be copied into
  49  * nlmsghdr->nlmsg_seq too.
  50  *
  51  * Sequence number is incremented with each message to be sent.
  52  *
  53  * If we expect reply to our message then the sequence number in
  54  * received message MUST be the same as in original message, and
  55  * acknowledge number MUST be the same + 1.
  56  *
  57  * If we receive a message and its sequence number is not equal to the
  58  * one we are expecting then it is a new message.
  59  *
  60  * If we receive a message and its sequence number is the same as one
  61  * we are expecting but it's acknowledgement number is not equal to
  62  * the acknowledgement number in the original message + 1, then it is
  63  * a new message.
  64  *
  65  */
  66 int cn_netlink_send(struct cn_msg *msg, u32 __group, gfp_t gfp_mask)
  67 {
  68         struct cn_callback_entry *__cbq;
  69         unsigned int size;
  70         struct sk_buff *skb;
  71         struct nlmsghdr *nlh;
  72         struct cn_msg *data;
  73         struct cn_dev *dev = &cdev;
  74         u32 group = 0;
  75         int found = 0;
  76
  77         if (!__group) {
  78                 spin_lock_bh(&dev->cbdev->queue_lock);
  79                 list_for_each_entry(__cbq, &dev->cbdev->queue_list,
  80                                     callback_entry) {
  81                         if (cn_cb_equal(&__cbq->id.id, &msg->id)) {
  82                                 found = 1;
  83                                 group = __cbq->group;
  84                                 break;
  85                         }
  86                 }
  87                 spin_unlock_bh(&dev->cbdev->queue_lock);
  88
  89                 if (!found)
  90                         return -ENODEV;
  91         } else {
  92                 group = __group;
  93         }
  94
  95         if (!netlink_has_listeners(dev->nls, group))
  96                 return -ESRCH;
  97
  98         size = sizeof(*msg) + msg->len;
  99
 100         skb = nlmsg_new(size, gfp_mask);
 101         if (!skb)
 102                 return -ENOMEM;
 103
 104         nlh = nlmsg_put(skb, 0, msg->seq, NLMSG_DONE, size, 0);
 105         if (!nlh) {
 106                 kfree_skb(skb);
 107                 return -EMSGSIZE;
 108         }
 109
 110         data = nlmsg_data(nlh);
 111
 112         memcpy(data, msg, size);
 113
 114         NETLINK_CB(skb).dst_group = group;
 115
 116         return netlink_broadcast(dev->nls, skb, 0, group, gfp_mask);
 117 }
 118 EXPORT_SYMBOL_GPL(cn_netlink_send);
 119
 120 /*
 121  * Callback helper - queues work and setup destructor for given data.
 122  */
 123 static int cn_call_callback(struct sk_buff *skb)
 124 {
 125         struct nlmsghdr *nlh;
 126         struct cn_callback_entry *i, *cbq = NULL;
 127         struct cn_dev *dev = &cdev;
 128         struct cn_msg *msg = nlmsg_data(nlmsg_hdr(skb));
 129         struct netlink_skb_parms *nsp = &NETLINK_CB(skb);
 130         int err = -ENODEV;
 131
 132         /* verify msg->len is within skb */
 133         nlh = nlmsg_hdr(skb);
 134         if (nlh->nlmsg_len < NLMSG_HDRLEN + sizeof(struct cn_msg) + msg->len)
 135                 return -EINVAL;
 136
 137         spin_lock_bh(&dev->cbdev->queue_lock);
 138         list_for_each_entry(i, &dev->cbdev->queue_list, callback_entry) {
 139                 if (cn_cb_equal(&i->id.id, &msg->id)) {
 140                         atomic_inc(&i->refcnt);
 141                         cbq = i;
 142                         break;
 143                 }
 144         }
 145         spin_unlock_bh(&dev->cbdev->queue_lock);
 146
 147         if (cbq != NULL) {
 148                 err = 0;
 149                 cbq->callback(msg, nsp);
 150                 kfree_skb(skb);
 151                 cn_queue_release_callback(cbq);
 152                 err = 0;
 153         }
 154
 155         return err;
 156 }
 157
 158 /*
 159  * Main netlink receiving function.
 160  *
 161  * It checks skb, netlink header and msg sizes, and calls callback helper.
 162  */
 163 static void cn_rx_skb(struct sk_buff *skb)
 164 {
 165         struct nlmsghdr *nlh;
 166         int len, err;
 167
 168         if (skb->len >= NLMSG_HDRLEN) {
 169                 nlh = nlmsg_hdr(skb);
 170                 len = nlmsg_len(nlh);
 171
 172                 if (len < (int)sizeof(struct cn_msg) ||
 173                     skb->len < nlh->nlmsg_len ||
 174                     len > CONNECTOR_MAX_MSG_SIZE)
 175                         return;
 176
 177                 err = cn_call_callback(skb_get(skb));
 178                 if (err < 0)
 179                         kfree_skb(skb);
 180         }
 181 }
 182
 183 /*
 184  * Callback add routing - adds callback with given ID and name.
 185  * If there is registered callback with the same ID it will not be added.
 186  *
 187  * May sleep.
 188  */
 189 int cn_add_callback(struct cb_id *id, const char *name,
 190                     void (*callback)(struct cn_msg *,
 191                                      struct netlink_skb_parms *))
 192 {
 193         int err;
 194         struct cn_dev *dev = &cdev;
 195
 196         if (!cn_already_initialized)
 197                 return -EAGAIN;
 198
 199         err = cn_queue_add_callback(dev->cbdev, name, id, callback);
 200         if (err)
 201                 return err;
 202
 203         return 0;
 204 }
 205 EXPORT_SYMBOL_GPL(cn_add_callback);
 206
 207 /*
 208  * Callback remove routing - removes callback
 209  * with given ID.
 210  * If there is no registered callback with given
 211  * ID nothing happens.
 212  *
 213  * May sleep while waiting for reference counter to become zero.
 214  */
 215 void cn_del_callback(struct cb_id *id)
 216 {
 217         struct cn_dev *dev = &cdev;
 218
 219         cn_queue_del_callback(dev->cbdev, id);
 220 }
 221 EXPORT_SYMBOL_GPL(cn_del_callback);
 222
 223 static int cn_proc_show(struct seq_file *m, void *v)
 224 {
 225         struct cn_queue_dev *dev = cdev.cbdev;
 226         struct cn_callback_entry *cbq;
 227
 228         seq_printf(m, "Name            ID\n");
 229
 230         spin_lock_bh(&dev->queue_lock);
 231
 232         list_for_each_entry(cbq, &dev->queue_list, callback_entry) {
 233                 seq_printf(m, "%-15s %u:%u\n",
 234                            cbq->id.name,
 235                            cbq->id.id.idx,
 236                            cbq->id.id.val);
 237         }
 238
 239         spin_unlock_bh(&dev->queue_lock);
 240
 241         return 0;
 242 }
 243
 244 static int cn_proc_open(struct inode *inode, struct file *file)
 245 {
 246         return single_open(file, cn_proc_show, NULL);
 247 }
 248
 249 static const struct file_operations cn_file_ops = {
 250         .owner   = THIS_MODULE,
 251         .open    = cn_proc_open,
 252         .read    = seq_read,
 253         .llseek  = seq_lseek,
 254         .release = single_release
 255 };
 256
 257 static struct cn_dev cdev = {
 258         .input   = cn_rx_skb,
 259 };
 260
 261 static int cn_init(void)
 262 {
 263         struct cn_dev *dev = &cdev;
 264         struct netlink_kernel_cfg cfg = {
 265                 .groups = CN_NETLINK_USERS + 0xf,
 266                 .input  = dev->input,
 267         };
 268
 269         dev->nls = netlink_kernel_create(&init_net, NETLINK_CONNECTOR, &cfg);
 270         if (!dev->nls)
 271                 return -EIO;
 272
 273         dev->cbdev = cn_queue_alloc_dev("cqueue", dev->nls);
 274         if (!dev->cbdev) {
 275                 netlink_kernel_release(dev->nls);
 276                 return -EINVAL;
 277         }
 278
 279         cn_already_initialized = 1;
 280
 281         proc_create("connector", S_IRUGO, init_net.proc_net, &cn_file_ops);
 282
 283         return 0;
 284 }
 285
 286 static void cn_fini(void)
 287 {
 288         struct cn_dev *dev = &cdev;
 289
 290         cn_already_initialized = 0;
 291
 292         remove_proc_entry("connector", init_net.proc_net);
 293
 294         cn_queue_free_dev(dev->cbdev);
 295         netlink_kernel_release(dev->nls);
 296 }
 297
 298 subsys_initcall(cn_init);
 299 module_exit(cn_fini);