powerpc: Move VMX and VSX asm code to vector.S
[deliverable/linux.git] / net / wimax / op-msg.c
CommitLineData
3e65646b
IPG
1/*
2 * Linux WiMAX
3 * Generic messaging interface between userspace and driver/device
4 *
5 *
6 * Copyright (C) 2007-2008 Intel Corporation <linux-wimax@intel.com>
7 * Inaky Perez-Gonzalez <inaky.perez-gonzalez@intel.com>
8 *
9 * This program is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU General Public License version
11 * 2 as published by the Free Software Foundation.
12 *
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
17 *
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
21 * 02110-1301, USA.
22 *
23 *
24 * This implements a direct communication channel between user space and
25 * the driver/device, by which free form messages can be sent back and
26 * forth.
27 *
28 * This is intended for device-specific features, vendor quirks, etc.
29 *
30 * See include/net/wimax.h
31 *
32 * GENERIC NETLINK ENCODING AND CAPACITY
33 *
34 * A destination "pipe name" is added to each message; it is up to the
35 * drivers to assign or use those names (if using them at all).
36 *
37 * Messages are encoded as a binary netlink attribute using nla_put()
38 * using type NLA_UNSPEC (as some versions of libnl still in
39 * deployment don't yet understand NLA_BINARY).
40 *
41 * The maximum capacity of this transport is PAGESIZE per message (so
42 * the actual payload will be bit smaller depending on the
43 * netlink/generic netlink attributes and headers).
44 *
45 * RECEPTION OF MESSAGES
46 *
47 * When a message is received from user space, it is passed verbatim
48 * to the driver calling wimax_dev->op_msg_from_user(). The return
49 * value from this function is passed back to user space as an ack
50 * over the generic netlink protocol.
51 *
52 * The stack doesn't do any processing or interpretation of these
53 * messages.
54 *
55 * SENDING MESSAGES
56 *
57 * Messages can be sent with wimax_msg().
58 *
59 * If the message delivery needs to happen on a different context to
60 * that of its creation, wimax_msg_alloc() can be used to get a
61 * pointer to the message that can be delivered later on with
62 * wimax_msg_send().
63 *
64 * ROADMAP
65 *
66 * wimax_gnl_doit_msg_from_user() Process a message from user space
67 * wimax_dev_get_by_genl_info()
68 * wimax_dev->op_msg_from_user() Delivery of message to the driver
69 *
70 * wimax_msg() Send a message to user space
71 * wimax_msg_alloc()
72 * wimax_msg_send()
73 */
74#include <linux/device.h>
75#include <net/genetlink.h>
76#include <linux/netdevice.h>
77#include <linux/wimax.h>
78#include <linux/security.h>
79#include "wimax-internal.h"
80
81
82#define D_SUBMODULE op_msg
83#include "debug-levels.h"
84
85
86/**
87 * wimax_msg_alloc - Create a new skb for sending a message to userspace
88 *
89 * @wimax_dev: WiMAX device descriptor
90 * @pipe_name: "named pipe" the message will be sent to
91 * @msg: pointer to the message data to send
92 * @size: size of the message to send (in bytes), including the header.
93 * @gfp_flags: flags for memory allocation.
94 *
95 * Returns: %0 if ok, negative errno code on error
96 *
97 * Description:
98 *
99 * Allocates an skb that will contain the message to send to user
100 * space over the messaging pipe and initializes it, copying the
101 * payload.
102 *
103 * Once this call is done, you can deliver it with
104 * wimax_msg_send().
105 *
106 * IMPORTANT:
107 *
108 * Don't use skb_push()/skb_pull()/skb_reserve() on the skb, as
109 * wimax_msg_send() depends on skb->data being placed at the
110 * beginning of the user message.
111 */
112struct sk_buff *wimax_msg_alloc(struct wimax_dev *wimax_dev,
113 const char *pipe_name,
114 const void *msg, size_t size,
115 gfp_t gfp_flags)
116{
117 int result;
118 struct device *dev = wimax_dev->net_dev->dev.parent;
119 size_t msg_size;
120 void *genl_msg;
121 struct sk_buff *skb;
122
123 msg_size = nla_total_size(size)
124 + nla_total_size(sizeof(u32))
125 + (pipe_name ? nla_total_size(strlen(pipe_name)) : 0);
126 result = -ENOMEM;
127 skb = genlmsg_new(msg_size, gfp_flags);
128 if (skb == NULL)
129 goto error_new;
130 genl_msg = genlmsg_put(skb, 0, 0, &wimax_gnl_family,
131 0, WIMAX_GNL_OP_MSG_TO_USER);
132 if (genl_msg == NULL) {
133 dev_err(dev, "no memory to create generic netlink message\n");
134 goto error_genlmsg_put;
135 }
136 result = nla_put_u32(skb, WIMAX_GNL_MSG_IFIDX,
137 wimax_dev->net_dev->ifindex);
138 if (result < 0) {
139 dev_err(dev, "no memory to add ifindex attribute\n");
140 goto error_nla_put;
141 }
142 if (pipe_name) {
143 result = nla_put_string(skb, WIMAX_GNL_MSG_PIPE_NAME,
144 pipe_name);
145 if (result < 0) {
146 dev_err(dev, "no memory to add pipe_name attribute\n");
147 goto error_nla_put;
148 }
149 }
150 result = nla_put(skb, WIMAX_GNL_MSG_DATA, size, msg);
151 if (result < 0) {
d1a2627a
IPG
152 dev_err(dev, "no memory to add payload (msg %p size %zu) in "
153 "attribute: %d\n", msg, size, result);
3e65646b
IPG
154 goto error_nla_put;
155 }
156 genlmsg_end(skb, genl_msg);
157 return skb;
158
159error_nla_put:
160error_genlmsg_put:
161error_new:
162 nlmsg_free(skb);
163 return ERR_PTR(result);
164
165}
166EXPORT_SYMBOL_GPL(wimax_msg_alloc);
167
168
169/**
170 * wimax_msg_data_len - Return a pointer and size of a message's payload
171 *
172 * @msg: Pointer to a message created with wimax_msg_alloc()
173 * @size: Pointer to where to store the message's size
174 *
175 * Returns the pointer to the message data.
176 */
177const void *wimax_msg_data_len(struct sk_buff *msg, size_t *size)
178{
179 struct nlmsghdr *nlh = (void *) msg->head;
180 struct nlattr *nla;
181
182 nla = nlmsg_find_attr(nlh, sizeof(struct genlmsghdr),
183 WIMAX_GNL_MSG_DATA);
184 if (nla == NULL) {
185 printk(KERN_ERR "Cannot find attribute WIMAX_GNL_MSG_DATA\n");
186 return NULL;
187 }
188 *size = nla_len(nla);
189 return nla_data(nla);
190}
191EXPORT_SYMBOL_GPL(wimax_msg_data_len);
192
193
194/**
195 * wimax_msg_data - Return a pointer to a message's payload
196 *
197 * @msg: Pointer to a message created with wimax_msg_alloc()
198 */
199const void *wimax_msg_data(struct sk_buff *msg)
200{
201 struct nlmsghdr *nlh = (void *) msg->head;
202 struct nlattr *nla;
203
204 nla = nlmsg_find_attr(nlh, sizeof(struct genlmsghdr),
205 WIMAX_GNL_MSG_DATA);
206 if (nla == NULL) {
207 printk(KERN_ERR "Cannot find attribute WIMAX_GNL_MSG_DATA\n");
208 return NULL;
209 }
210 return nla_data(nla);
211}
212EXPORT_SYMBOL_GPL(wimax_msg_data);
213
214
215/**
216 * wimax_msg_len - Return a message's payload length
217 *
218 * @msg: Pointer to a message created with wimax_msg_alloc()
219 */
220ssize_t wimax_msg_len(struct sk_buff *msg)
221{
222 struct nlmsghdr *nlh = (void *) msg->head;
223 struct nlattr *nla;
224
225 nla = nlmsg_find_attr(nlh, sizeof(struct genlmsghdr),
226 WIMAX_GNL_MSG_DATA);
227 if (nla == NULL) {
228 printk(KERN_ERR "Cannot find attribute WIMAX_GNL_MSG_DATA\n");
229 return -EINVAL;
230 }
231 return nla_len(nla);
232}
233EXPORT_SYMBOL_GPL(wimax_msg_len);
234
235
236/**
237 * wimax_msg_send - Send a pre-allocated message to user space
238 *
239 * @wimax_dev: WiMAX device descriptor
240 *
241 * @skb: &struct sk_buff returned by wimax_msg_alloc(). Note the
242 * ownership of @skb is transferred to this function.
243 *
244 * Returns: 0 if ok, < 0 errno code on error
245 *
246 * Description:
247 *
248 * Sends a free-form message that was preallocated with
249 * wimax_msg_alloc() and filled up.
250 *
251 * Assumes that once you pass an skb to this function for sending, it
252 * owns it and will release it when done (on success).
253 *
254 * IMPORTANT:
255 *
256 * Don't use skb_push()/skb_pull()/skb_reserve() on the skb, as
257 * wimax_msg_send() depends on skb->data being placed at the
258 * beginning of the user message.
259 */
260int wimax_msg_send(struct wimax_dev *wimax_dev, struct sk_buff *skb)
261{
3e65646b
IPG
262 struct device *dev = wimax_dev->net_dev->dev.parent;
263 void *msg = skb->data;
264 size_t size = skb->len;
265 might_sleep();
266
267 d_printf(1, dev, "CTX: wimax msg, %zu bytes\n", size);
268 d_dump(2, dev, msg, size);
ff491a73
PNA
269 genlmsg_multicast(skb, 0, wimax_gnl_mcg.id, GFP_KERNEL);
270 d_printf(1, dev, "CTX: genl multicast done\n");
271 return 0;
3e65646b
IPG
272}
273EXPORT_SYMBOL_GPL(wimax_msg_send);
274
275
276/**
277 * wimax_msg - Send a message to user space
278 *
279 * @wimax_dev: WiMAX device descriptor (properly referenced)
280 * @pipe_name: "named pipe" the message will be sent to
281 * @buf: pointer to the message to send.
282 * @size: size of the buffer pointed to by @buf (in bytes).
283 * @gfp_flags: flags for memory allocation.
284 *
285 * Returns: %0 if ok, negative errno code on error.
286 *
287 * Description:
288 *
289 * Sends a free-form message to user space on the device @wimax_dev.
290 *
291 * NOTES:
292 *
293 * Once the @skb is given to this function, who will own it and will
294 * release it when done (unless it returns error).
295 */
296int wimax_msg(struct wimax_dev *wimax_dev, const char *pipe_name,
297 const void *buf, size_t size, gfp_t gfp_flags)
298{
299 int result = -ENOMEM;
300 struct sk_buff *skb;
301
302 skb = wimax_msg_alloc(wimax_dev, pipe_name, buf, size, gfp_flags);
d1a2627a
IPG
303 if (IS_ERR(skb))
304 result = PTR_ERR(skb);
305 else
306 result = wimax_msg_send(wimax_dev, skb);
3e65646b
IPG
307 return result;
308}
309EXPORT_SYMBOL_GPL(wimax_msg);
310
311
312static const
313struct nla_policy wimax_gnl_msg_policy[WIMAX_GNL_ATTR_MAX + 1] = {
314 [WIMAX_GNL_MSG_IFIDX] = {
315 .type = NLA_U32,
316 },
317 [WIMAX_GNL_MSG_DATA] = {
318 .type = NLA_UNSPEC, /* libnl doesn't grok BINARY yet */
319 },
320};
321
322
323/*
324 * Relays a message from user space to the driver
325 *
326 * The skb is passed to the driver-specific function with the netlink
327 * and generic netlink headers already stripped.
328 *
329 * This call will block while handling/relaying the message.
330 */
331static
332int wimax_gnl_doit_msg_from_user(struct sk_buff *skb, struct genl_info *info)
333{
334 int result, ifindex;
335 struct wimax_dev *wimax_dev;
336 struct device *dev;
337 struct nlmsghdr *nlh = info->nlhdr;
338 char *pipe_name;
339 void *msg_buf;
340 size_t msg_len;
341
342 might_sleep();
343 d_fnstart(3, NULL, "(skb %p info %p)\n", skb, info);
344 result = -ENODEV;
345 if (info->attrs[WIMAX_GNL_MSG_IFIDX] == NULL) {
346 printk(KERN_ERR "WIMAX_GNL_MSG_FROM_USER: can't find IFIDX "
347 "attribute\n");
348 goto error_no_wimax_dev;
349 }
350 ifindex = nla_get_u32(info->attrs[WIMAX_GNL_MSG_IFIDX]);
351 wimax_dev = wimax_dev_get_by_genl_info(info, ifindex);
352 if (wimax_dev == NULL)
353 goto error_no_wimax_dev;
354 dev = wimax_dev_to_dev(wimax_dev);
355
356 /* Unpack arguments */
357 result = -EINVAL;
358 if (info->attrs[WIMAX_GNL_MSG_DATA] == NULL) {
359 dev_err(dev, "WIMAX_GNL_MSG_FROM_USER: can't find MSG_DATA "
360 "attribute\n");
361 goto error_no_data;
362 }
363 msg_buf = nla_data(info->attrs[WIMAX_GNL_MSG_DATA]);
364 msg_len = nla_len(info->attrs[WIMAX_GNL_MSG_DATA]);
365
366 if (info->attrs[WIMAX_GNL_MSG_PIPE_NAME] == NULL)
367 pipe_name = NULL;
368 else {
369 struct nlattr *attr = info->attrs[WIMAX_GNL_MSG_PIPE_NAME];
370 size_t attr_len = nla_len(attr);
371 /* libnl-1.1 does not yet support NLA_NUL_STRING */
372 result = -ENOMEM;
373 pipe_name = kstrndup(nla_data(attr), attr_len + 1, GFP_KERNEL);
374 if (pipe_name == NULL)
375 goto error_alloc;
376 pipe_name[attr_len] = 0;
377 }
378 mutex_lock(&wimax_dev->mutex);
379 result = wimax_dev_is_ready(wimax_dev);
380 if (result < 0)
381 goto error_not_ready;
382 result = -ENOSYS;
383 if (wimax_dev->op_msg_from_user == NULL)
384 goto error_noop;
385
386 d_printf(1, dev,
387 "CRX: nlmsghdr len %u type %u flags 0x%04x seq 0x%x pid %u\n",
388 nlh->nlmsg_len, nlh->nlmsg_type, nlh->nlmsg_flags,
389 nlh->nlmsg_seq, nlh->nlmsg_pid);
390 d_printf(1, dev, "CRX: wimax message %zu bytes\n", msg_len);
391 d_dump(2, dev, msg_buf, msg_len);
392
393 result = wimax_dev->op_msg_from_user(wimax_dev, pipe_name,
394 msg_buf, msg_len, info);
395error_noop:
396error_not_ready:
397 mutex_unlock(&wimax_dev->mutex);
398error_alloc:
399 kfree(pipe_name);
400error_no_data:
401 dev_put(wimax_dev->net_dev);
402error_no_wimax_dev:
403 d_fnend(3, NULL, "(skb %p info %p) = %d\n", skb, info, result);
404 return result;
405}
406
407
408/*
409 * Generic Netlink glue
410 */
411
412struct genl_ops wimax_gnl_msg_from_user = {
413 .cmd = WIMAX_GNL_OP_MSG_FROM_USER,
414 .flags = GENL_ADMIN_PERM,
415 .policy = wimax_gnl_msg_policy,
416 .doit = wimax_gnl_doit_msg_from_user,
417 .dumpit = NULL,
418};
419
This page took 0.080762 seconds and 5 git commands to generate.