?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
close_port, kpacket_gen kmalloc oom, formard.c wake_sender/skb receive oom handling...
[cor_2_6_31.git] / drivers / infiniband / core / ucm.c
blob51bd9669cb1f7697c0be4e1b4b0c38dc4ee05499
1 /*
2 * Copyright (c) 2005 Topspin Communications. All rights reserved.
3 * Copyright (c) 2005 Intel Corporation. All rights reserved.
4 *
5 * This software is available to you under a choice of one of two
6 * licenses. You may choose to be licensed under the terms of the GNU
7 * General Public License (GPL) Version 2, available from the file
8 * COPYING in the main directory of this source tree, or the
9 * OpenIB.org BSD license below:
10 *
11 * Redistribution and use in source and binary forms, with or
12 * without modification, are permitted provided that the following
13 * conditions are met:
14 *
15 * - Redistributions of source code must retain the above
16 * copyright notice, this list of conditions and the following
17 * disclaimer.
18 *
19 * - Redistributions in binary form must reproduce the above
20 * copyright notice, this list of conditions and the following
21 * disclaimer in the documentation and/or other materials
22 * provided with the distribution.
23 *
24 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
25 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
26 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
27 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
28 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
29 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
30 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
31 * SOFTWARE.
32 */
33
34 #include <linux/completion.h>
35 #include <linux/init.h>
36 #include <linux/fs.h>
37 #include <linux/module.h>
38 #include <linux/device.h>
39 #include <linux/err.h>
40 #include <linux/poll.h>
41 #include <linux/file.h>
42 #include <linux/mount.h>
43 #include <linux/cdev.h>
44 #include <linux/idr.h>
45 #include <linux/mutex.h>
46
47 #include <asm/uaccess.h>
48
49 #include <rdma/ib_cm.h>
50 #include <rdma/ib_user_cm.h>
51 #include <rdma/ib_marshall.h>
52
53 MODULE_AUTHOR("Libor Michalek");
54 MODULE_DESCRIPTION("InfiniBand userspace Connection Manager access");
55 MODULE_LICENSE("Dual BSD/GPL");
56
57 struct ib_ucm_device {
58 int devnum;
59 struct cdev cdev;
60 struct device dev;
61 struct ib_device *ib_dev;
62 };
63
64 struct ib_ucm_file {
65 struct mutex file_mutex;
66 struct file *filp;
67 struct ib_ucm_device *device;
68
69 struct list_head ctxs;
70 struct list_head events;
71 wait_queue_head_t poll_wait;
72 };
73
74 struct ib_ucm_context {
75 int id;
76 struct completion comp;
77 atomic_t ref;
78 int events_reported;
79
80 struct ib_ucm_file *file;
81 struct ib_cm_id *cm_id;
82 __u64 uid;
83
84 struct list_head events; /* list of pending events. */
85 struct list_head file_list; /* member in file ctx list */
86 };
87
88 struct ib_ucm_event {
89 struct ib_ucm_context *ctx;
90 struct list_head file_list; /* member in file event list */
91 struct list_head ctx_list; /* member in ctx event list */
92
93 struct ib_cm_id *cm_id;
94 struct ib_ucm_event_resp resp;
95 void *data;
96 void *info;
97 int data_len;
98 int info_len;
99 };
100
101 enum {
102 IB_UCM_MAJOR = 231,
103 IB_UCM_BASE_MINOR = 224,
104 IB_UCM_MAX_DEVICES = 32
105 };
106
107 /* ib_cm and ib_user_cm modules share /sys/class/infiniband_cm */
108 extern struct class cm_class;
109
110 #define IB_UCM_BASE_DEV MKDEV(IB_UCM_MAJOR, IB_UCM_BASE_MINOR)
111
112 static void ib_ucm_add_one(struct ib_device *device);
113 static void ib_ucm_remove_one(struct ib_device *device);
114
115 static struct ib_client ucm_client = {
116 .name = "ucm",
117 .add = ib_ucm_add_one,
118 .remove = ib_ucm_remove_one
119 };
120
121 static DEFINE_MUTEX(ctx_id_mutex);
122 static DEFINE_IDR(ctx_id_table);
123 static DECLARE_BITMAP(dev_map, IB_UCM_MAX_DEVICES);
124
125 static struct ib_ucm_context *ib_ucm_ctx_get(struct ib_ucm_file *file, int id)
126 {
127 struct ib_ucm_context *ctx;
128
129 mutex_lock(&ctx_id_mutex);
130 ctx = idr_find(&ctx_id_table, id);
131 if (!ctx)
132 ctx = ERR_PTR(-ENOENT);
133 else if (ctx->file != file)
134 ctx = ERR_PTR(-EINVAL);
135 else
136 atomic_inc(&ctx->ref);
137 mutex_unlock(&ctx_id_mutex);
138
139 return ctx;
140 }
141
142 static void ib_ucm_ctx_put(struct ib_ucm_context *ctx)
143 {
144 if (atomic_dec_and_test(&ctx->ref))
145 complete(&ctx->comp);
146 }
147
148 static inline int ib_ucm_new_cm_id(int event)
149 {
150 return event == IB_CM_REQ_RECEIVED || event == IB_CM_SIDR_REQ_RECEIVED;
151 }
152
153 static void ib_ucm_cleanup_events(struct ib_ucm_context *ctx)
154 {
155 struct ib_ucm_event *uevent;
156
157 mutex_lock(&ctx->file->file_mutex);
158 list_del(&ctx->file_list);
159 while (!list_empty(&ctx->events)) {
160
161 uevent = list_entry(ctx->events.next,
162 struct ib_ucm_event, ctx_list);
163 list_del(&uevent->file_list);
164 list_del(&uevent->ctx_list);
165 mutex_unlock(&ctx->file->file_mutex);
166
167 /* clear incoming connections. */
168 if (ib_ucm_new_cm_id(uevent->resp.event))
169 ib_destroy_cm_id(uevent->cm_id);
170
171 kfree(uevent);
172 mutex_lock(&ctx->file->file_mutex);
173 }
174 mutex_unlock(&ctx->file->file_mutex);
175 }
176
177 static struct ib_ucm_context *ib_ucm_ctx_alloc(struct ib_ucm_file *file)
178 {
179 struct ib_ucm_context *ctx;
180 int result;
181
182 ctx = kzalloc(sizeof *ctx, GFP_KERNEL);
183 if (!ctx)
184 return NULL;
185
186 atomic_set(&ctx->ref, 1);
187 init_completion(&ctx->comp);
188 ctx->file = file;
189 INIT_LIST_HEAD(&ctx->events);
190
191 do {
192 result = idr_pre_get(&ctx_id_table, GFP_KERNEL);
193 if (!result)
194 goto error;
195
196 mutex_lock(&ctx_id_mutex);
197 result = idr_get_new(&ctx_id_table, ctx, &ctx->id);
198 mutex_unlock(&ctx_id_mutex);
199 } while (result == -EAGAIN);
200
201 if (result)
202 goto error;
203
204 list_add_tail(&ctx->file_list, &file->ctxs);
205 return ctx;
206
207 error:
208 kfree(ctx);
209 return NULL;
210 }
211
212 static void ib_ucm_event_req_get(struct ib_ucm_req_event_resp *ureq,
213 struct ib_cm_req_event_param *kreq)
214 {
215 ureq->remote_ca_guid = kreq->remote_ca_guid;
216 ureq->remote_qkey = kreq->remote_qkey;
217 ureq->remote_qpn = kreq->remote_qpn;
218 ureq->qp_type = kreq->qp_type;
219 ureq->starting_psn = kreq->starting_psn;
220 ureq->responder_resources = kreq->responder_resources;
221 ureq->initiator_depth = kreq->initiator_depth;
222 ureq->local_cm_response_timeout = kreq->local_cm_response_timeout;
223 ureq->flow_control = kreq->flow_control;
224 ureq->remote_cm_response_timeout = kreq->remote_cm_response_timeout;
225 ureq->retry_count = kreq->retry_count;
226 ureq->rnr_retry_count = kreq->rnr_retry_count;
227 ureq->srq = kreq->srq;
228 ureq->port = kreq->port;
229
230 ib_copy_path_rec_to_user(&ureq->primary_path, kreq->primary_path);
231 if (kreq->alternate_path)
232 ib_copy_path_rec_to_user(&ureq->alternate_path,
233 kreq->alternate_path);
234 }
235
236 static void ib_ucm_event_rep_get(struct ib_ucm_rep_event_resp *urep,
237 struct ib_cm_rep_event_param *krep)
238 {
239 urep->remote_ca_guid = krep->remote_ca_guid;
240 urep->remote_qkey = krep->remote_qkey;
241 urep->remote_qpn = krep->remote_qpn;
242 urep->starting_psn = krep->starting_psn;
243 urep->responder_resources = krep->responder_resources;
244 urep->initiator_depth = krep->initiator_depth;
245 urep->target_ack_delay = krep->target_ack_delay;
246 urep->failover_accepted = krep->failover_accepted;
247 urep->flow_control = krep->flow_control;
248 urep->rnr_retry_count = krep->rnr_retry_count;
249 urep->srq = krep->srq;
250 }
251
252 static void ib_ucm_event_sidr_rep_get(struct ib_ucm_sidr_rep_event_resp *urep,
253 struct ib_cm_sidr_rep_event_param *krep)
254 {
255 urep->status = krep->status;
256 urep->qkey = krep->qkey;
257 urep->qpn = krep->qpn;
258 };
259
260 static int ib_ucm_event_process(struct ib_cm_event *evt,
261 struct ib_ucm_event *uvt)
262 {
263 void *info = NULL;
264
265 switch (evt->event) {
266 case IB_CM_REQ_RECEIVED:
267 ib_ucm_event_req_get(&uvt->resp.u.req_resp,
268 &evt->param.req_rcvd);
269 uvt->data_len = IB_CM_REQ_PRIVATE_DATA_SIZE;
270 uvt->resp.present = IB_UCM_PRES_PRIMARY;
271 uvt->resp.present |= (evt->param.req_rcvd.alternate_path ?
272 IB_UCM_PRES_ALTERNATE : 0);
273 break;
274 case IB_CM_REP_RECEIVED:
275 ib_ucm_event_rep_get(&uvt->resp.u.rep_resp,
276 &evt->param.rep_rcvd);
277 uvt->data_len = IB_CM_REP_PRIVATE_DATA_SIZE;
278 break;
279 case IB_CM_RTU_RECEIVED:
280 uvt->data_len = IB_CM_RTU_PRIVATE_DATA_SIZE;
281 uvt->resp.u.send_status = evt->param.send_status;
282 break;
283 case IB_CM_DREQ_RECEIVED:
284 uvt->data_len = IB_CM_DREQ_PRIVATE_DATA_SIZE;
285 uvt->resp.u.send_status = evt->param.send_status;
286 break;
287 case IB_CM_DREP_RECEIVED:
288 uvt->data_len = IB_CM_DREP_PRIVATE_DATA_SIZE;
289 uvt->resp.u.send_status = evt->param.send_status;
290 break;
291 case IB_CM_MRA_RECEIVED:
292 uvt->resp.u.mra_resp.timeout =
293 evt->param.mra_rcvd.service_timeout;
294 uvt->data_len = IB_CM_MRA_PRIVATE_DATA_SIZE;
295 break;
296 case IB_CM_REJ_RECEIVED:
297 uvt->resp.u.rej_resp.reason = evt->param.rej_rcvd.reason;
298 uvt->data_len = IB_CM_REJ_PRIVATE_DATA_SIZE;
299 uvt->info_len = evt->param.rej_rcvd.ari_length;
300 info = evt->param.rej_rcvd.ari;
301 break;
302 case IB_CM_LAP_RECEIVED:
303 ib_copy_path_rec_to_user(&uvt->resp.u.lap_resp.path,
304 evt->param.lap_rcvd.alternate_path);
305 uvt->data_len = IB_CM_LAP_PRIVATE_DATA_SIZE;
306 uvt->resp.present = IB_UCM_PRES_ALTERNATE;
307 break;
308 case IB_CM_APR_RECEIVED:
309 uvt->resp.u.apr_resp.status = evt->param.apr_rcvd.ap_status;
310 uvt->data_len = IB_CM_APR_PRIVATE_DATA_SIZE;
311 uvt->info_len = evt->param.apr_rcvd.info_len;
312 info = evt->param.apr_rcvd.apr_info;
313 break;
314 case IB_CM_SIDR_REQ_RECEIVED:
315 uvt->resp.u.sidr_req_resp.pkey =
316 evt->param.sidr_req_rcvd.pkey;
317 uvt->resp.u.sidr_req_resp.port =
318 evt->param.sidr_req_rcvd.port;
319 uvt->data_len = IB_CM_SIDR_REQ_PRIVATE_DATA_SIZE;
320 break;
321 case IB_CM_SIDR_REP_RECEIVED:
322 ib_ucm_event_sidr_rep_get(&uvt->resp.u.sidr_rep_resp,
323 &evt->param.sidr_rep_rcvd);
324 uvt->data_len = IB_CM_SIDR_REP_PRIVATE_DATA_SIZE;
325 uvt->info_len = evt->param.sidr_rep_rcvd.info_len;
326 info = evt->param.sidr_rep_rcvd.info;
327 break;
328 default:
329 uvt->resp.u.send_status = evt->param.send_status;
330 break;
331 }
332
333 if (uvt->data_len) {
334 uvt->data = kmemdup(evt->private_data, uvt->data_len, GFP_KERNEL);
335 if (!uvt->data)
336 goto err1;
337
338 uvt->resp.present |= IB_UCM_PRES_DATA;
339 }
340
341 if (uvt->info_len) {
342 uvt->info = kmemdup(info, uvt->info_len, GFP_KERNEL);
343 if (!uvt->info)
344 goto err2;
345
346 uvt->resp.present |= IB_UCM_PRES_INFO;
347 }
348 return 0;
349
350 err2:
351 kfree(uvt->data);
352 err1:
353 return -ENOMEM;
354 }
355
356 static int ib_ucm_event_handler(struct ib_cm_id *cm_id,
357 struct ib_cm_event *event)
358 {
359 struct ib_ucm_event *uevent;
360 struct ib_ucm_context *ctx;
361 int result = 0;
362
363 ctx = cm_id->context;
364
365 uevent = kzalloc(sizeof *uevent, GFP_KERNEL);
366 if (!uevent)
367 goto err1;
368
369 uevent->ctx = ctx;
370 uevent->cm_id = cm_id;
371 uevent->resp.uid = ctx->uid;
372 uevent->resp.id = ctx->id;
373 uevent->resp.event = event->event;
374
375 result = ib_ucm_event_process(event, uevent);
376 if (result)
377 goto err2;
378
379 mutex_lock(&ctx->file->file_mutex);
380 list_add_tail(&uevent->file_list, &ctx->file->events);
381 list_add_tail(&uevent->ctx_list, &ctx->events);
382 wake_up_interruptible(&ctx->file->poll_wait);
383 mutex_unlock(&ctx->file->file_mutex);
384 return 0;
385
386 err2:
387 kfree(uevent);
388 err1:
389 /* Destroy new cm_id's */
390 return ib_ucm_new_cm_id(event->event);
391 }
392
393 static ssize_t ib_ucm_event(struct ib_ucm_file *file,
394 const char __user *inbuf,
395 int in_len, int out_len)
396 {
397 struct ib_ucm_context *ctx;
398 struct ib_ucm_event_get cmd;
399 struct ib_ucm_event *uevent;
400 int result = 0;
401 DEFINE_WAIT(wait);
402
403 if (out_len < sizeof(struct ib_ucm_event_resp))
404 return -ENOSPC;
405
406 if (copy_from_user(&cmd, inbuf, sizeof(cmd)))
407 return -EFAULT;
408
409 mutex_lock(&file->file_mutex);
410 while (list_empty(&file->events)) {
411 mutex_unlock(&file->file_mutex);
412
413 if (file->filp->f_flags & O_NONBLOCK)
414 return -EAGAIN;
415
416 if (wait_event_interruptible(file->poll_wait,
417 !list_empty(&file->events)))
418 return -ERESTARTSYS;
419
420 mutex_lock(&file->file_mutex);
421 }
422
423 uevent = list_entry(file->events.next, struct ib_ucm_event, file_list);
424
425 if (ib_ucm_new_cm_id(uevent->resp.event)) {
426 ctx = ib_ucm_ctx_alloc(file);
427 if (!ctx) {
428 result = -ENOMEM;
429 goto done;
430 }
431
432 ctx->cm_id = uevent->cm_id;
433 ctx->cm_id->context = ctx;
434 uevent->resp.id = ctx->id;
435 }
436
437 if (copy_to_user((void __user *)(unsigned long)cmd.response,
438 &uevent->resp, sizeof(uevent->resp))) {
439 result = -EFAULT;
440 goto done;
441 }
442
443 if (uevent->data) {
444 if (cmd.data_len < uevent->data_len) {
445 result = -ENOMEM;
446 goto done;
447 }
448 if (copy_to_user((void __user *)(unsigned long)cmd.data,
449 uevent->data, uevent->data_len)) {
450 result = -EFAULT;
451 goto done;
452 }
453 }
454
455 if (uevent->info) {
456 if (cmd.info_len < uevent->info_len) {
457 result = -ENOMEM;
458 goto done;
459 }
460 if (copy_to_user((void __user *)(unsigned long)cmd.info,
461 uevent->info, uevent->info_len)) {
462 result = -EFAULT;
463 goto done;
464 }
465 }
466
467 list_del(&uevent->file_list);
468 list_del(&uevent->ctx_list);
469 uevent->ctx->events_reported++;
470
471 kfree(uevent->data);
472 kfree(uevent->info);
473 kfree(uevent);
474 done:
475 mutex_unlock(&file->file_mutex);
476 return result;
477 }
478
479 static ssize_t ib_ucm_create_id(struct ib_ucm_file *file,
480 const char __user *inbuf,
481 int in_len, int out_len)
482 {
483 struct ib_ucm_create_id cmd;
484 struct ib_ucm_create_id_resp resp;
485 struct ib_ucm_context *ctx;
486 int result;
487
488 if (out_len < sizeof(resp))
489 return -ENOSPC;
490
491 if (copy_from_user(&cmd, inbuf, sizeof(cmd)))
492 return -EFAULT;
493
494 mutex_lock(&file->file_mutex);
495 ctx = ib_ucm_ctx_alloc(file);
496 mutex_unlock(&file->file_mutex);
497 if (!ctx)
498 return -ENOMEM;
499
500 ctx->uid = cmd.uid;
501 ctx->cm_id = ib_create_cm_id(file->device->ib_dev,
502 ib_ucm_event_handler, ctx);
503 if (IS_ERR(ctx->cm_id)) {
504 result = PTR_ERR(ctx->cm_id);
505 goto err1;
506 }
507
508 resp.id = ctx->id;
509 if (copy_to_user((void __user *)(unsigned long)cmd.response,
510 &resp, sizeof(resp))) {
511 result = -EFAULT;
512 goto err2;
513 }
514 return 0;
515
516 err2:
517 ib_destroy_cm_id(ctx->cm_id);
518 err1:
519 mutex_lock(&ctx_id_mutex);
520 idr_remove(&ctx_id_table, ctx->id);
521 mutex_unlock(&ctx_id_mutex);
522 kfree(ctx);
523 return result;
524 }
525
526 static ssize_t ib_ucm_destroy_id(struct ib_ucm_file *file,
527 const char __user *inbuf,
528 int in_len, int out_len)
529 {
530 struct ib_ucm_destroy_id cmd;
531 struct ib_ucm_destroy_id_resp resp;
532 struct ib_ucm_context *ctx;
533 int result = 0;
534
535 if (out_len < sizeof(resp))
536 return -ENOSPC;
537
538 if (copy_from_user(&cmd, inbuf, sizeof(cmd)))
539 return -EFAULT;
540
541 mutex_lock(&ctx_id_mutex);
542 ctx = idr_find(&ctx_id_table, cmd.id);
543 if (!ctx)
544 ctx = ERR_PTR(-ENOENT);
545 else if (ctx->file != file)
546 ctx = ERR_PTR(-EINVAL);
547 else
548 idr_remove(&ctx_id_table, ctx->id);
549 mutex_unlock(&ctx_id_mutex);
550
551 if (IS_ERR(ctx))
552 return PTR_ERR(ctx);
553
554 ib_ucm_ctx_put(ctx);
555 wait_for_completion(&ctx->comp);
556
557 /* No new events will be generated after destroying the cm_id. */
558 ib_destroy_cm_id(ctx->cm_id);
559 /* Cleanup events not yet reported to the user. */
560 ib_ucm_cleanup_events(ctx);
561
562 resp.events_reported = ctx->events_reported;
563 if (copy_to_user((void __user *)(unsigned long)cmd.response,
564 &resp, sizeof(resp)))
565 result = -EFAULT;
566
567 kfree(ctx);
568 return result;
569 }
570
571 static ssize_t ib_ucm_attr_id(struct ib_ucm_file *file,
572 const char __user *inbuf,
573 int in_len, int out_len)
574 {
575 struct ib_ucm_attr_id_resp resp;
576 struct ib_ucm_attr_id cmd;
577 struct ib_ucm_context *ctx;
578 int result = 0;
579
580 if (out_len < sizeof(resp))
581 return -ENOSPC;
582
583 if (copy_from_user(&cmd, inbuf, sizeof(cmd)))
584 return -EFAULT;
585
586 ctx = ib_ucm_ctx_get(file, cmd.id);
587 if (IS_ERR(ctx))
588 return PTR_ERR(ctx);
589
590 resp.service_id = ctx->cm_id->service_id;
591 resp.service_mask = ctx->cm_id->service_mask;
592 resp.local_id = ctx->cm_id->local_id;
593 resp.remote_id = ctx->cm_id->remote_id;
594
595 if (copy_to_user((void __user *)(unsigned long)cmd.response,
596 &resp, sizeof(resp)))
597 result = -EFAULT;
598
599 ib_ucm_ctx_put(ctx);
600 return result;
601 }
602
603 static ssize_t ib_ucm_init_qp_attr(struct ib_ucm_file *file,
604 const char __user *inbuf,
605 int in_len, int out_len)
606 {
607 struct ib_uverbs_qp_attr resp;
608 struct ib_ucm_init_qp_attr cmd;
609 struct ib_ucm_context *ctx;
610 struct ib_qp_attr qp_attr;
611 int result = 0;
612
613 if (out_len < sizeof(resp))
614 return -ENOSPC;
615
616 if (copy_from_user(&cmd, inbuf, sizeof(cmd)))
617 return -EFAULT;
618
619 ctx = ib_ucm_ctx_get(file, cmd.id);
620 if (IS_ERR(ctx))
621 return PTR_ERR(ctx);
622
623 resp.qp_attr_mask = 0;
624 memset(&qp_attr, 0, sizeof qp_attr);
625 qp_attr.qp_state = cmd.qp_state;
626 result = ib_cm_init_qp_attr(ctx->cm_id, &qp_attr, &resp.qp_attr_mask);
627 if (result)
628 goto out;
629
630 ib_copy_qp_attr_to_user(&resp, &qp_attr);
631
632 if (copy_to_user((void __user *)(unsigned long)cmd.response,
633 &resp, sizeof(resp)))
634 result = -EFAULT;
635
636 out:
637 ib_ucm_ctx_put(ctx);
638 return result;
639 }
640
641 static int ucm_validate_listen(__be64 service_id, __be64 service_mask)
642 {
643 service_id &= service_mask;
644
645 if (((service_id & IB_CMA_SERVICE_ID_MASK) == IB_CMA_SERVICE_ID) ||
646 ((service_id & IB_SDP_SERVICE_ID_MASK) == IB_SDP_SERVICE_ID))
647 return -EINVAL;
648
649 return 0;
650 }
651
652 static ssize_t ib_ucm_listen(struct ib_ucm_file *file,
653 const char __user *inbuf,
654 int in_len, int out_len)
655 {
656 struct ib_ucm_listen cmd;
657 struct ib_ucm_context *ctx;
658 int result;
659
660 if (copy_from_user(&cmd, inbuf, sizeof(cmd)))
661 return -EFAULT;
662
663 ctx = ib_ucm_ctx_get(file, cmd.id);
664 if (IS_ERR(ctx))
665 return PTR_ERR(ctx);
666
667 result = ucm_validate_listen(cmd.service_id, cmd.service_mask);
668 if (result)
669 goto out;
670
671 result = ib_cm_listen(ctx->cm_id, cmd.service_id, cmd.service_mask,
672 NULL);
673 out:
674 ib_ucm_ctx_put(ctx);
675 return result;
676 }
677
678 static ssize_t ib_ucm_notify(struct ib_ucm_file *file,
679 const char __user *inbuf,
680 int in_len, int out_len)
681 {
682 struct ib_ucm_notify cmd;
683 struct ib_ucm_context *ctx;
684 int result;
685
686 if (copy_from_user(&cmd, inbuf, sizeof(cmd)))
687 return -EFAULT;
688
689 ctx = ib_ucm_ctx_get(file, cmd.id);
690 if (IS_ERR(ctx))
691 return PTR_ERR(ctx);
692
693 result = ib_cm_notify(ctx->cm_id, (enum ib_event_type) cmd.event);
694 ib_ucm_ctx_put(ctx);
695 return result;
696 }
697
698 static int ib_ucm_alloc_data(const void **dest, u64 src, u32 len)
699 {
700 void *data;
701
702 *dest = NULL;
703
704 if (!len)
705 return 0;
706
707 data = kmalloc(len, GFP_KERNEL);
708 if (!data)
709 return -ENOMEM;
710
711 if (copy_from_user(data, (void __user *)(unsigned long)src, len)) {
712 kfree(data);
713 return -EFAULT;
714 }
715
716 *dest = data;
717 return 0;
718 }
719
720 static int ib_ucm_path_get(struct ib_sa_path_rec **path, u64 src)
721 {
722 struct ib_user_path_rec upath;
723 struct ib_sa_path_rec *sa_path;
724
725 *path = NULL;
726
727 if (!src)
728 return 0;
729
730 sa_path = kmalloc(sizeof(*sa_path), GFP_KERNEL);
731 if (!sa_path)
732 return -ENOMEM;
733
734 if (copy_from_user(&upath, (void __user *)(unsigned long)src,
735 sizeof(upath))) {
736
737 kfree(sa_path);
738 return -EFAULT;
739 }
740
741 ib_copy_path_rec_from_user(sa_path, &upath);
742 *path = sa_path;
743 return 0;
744 }
745
746 static ssize_t ib_ucm_send_req(struct ib_ucm_file *file,
747 const char __user *inbuf,
748 int in_len, int out_len)
749 {
750 struct ib_cm_req_param param;
751 struct ib_ucm_context *ctx;
752 struct ib_ucm_req cmd;
753 int result;
754
755 param.private_data = NULL;
756 param.primary_path = NULL;
757 param.alternate_path = NULL;
758
759 if (copy_from_user(&cmd, inbuf, sizeof(cmd)))
760 return -EFAULT;
761
762 result = ib_ucm_alloc_data(&param.private_data, cmd.data, cmd.len);
763 if (result)
764 goto done;
765
766 result = ib_ucm_path_get(&param.primary_path, cmd.primary_path);
767 if (result)
768 goto done;
769
770 result = ib_ucm_path_get(&param.alternate_path, cmd.alternate_path);
771 if (result)
772 goto done;
773
774 param.private_data_len = cmd.len;
775 param.service_id = cmd.sid;
776 param.qp_num = cmd.qpn;
777 param.qp_type = cmd.qp_type;
778 param.starting_psn = cmd.psn;
779 param.peer_to_peer = cmd.peer_to_peer;
780 param.responder_resources = cmd.responder_resources;
781 param.initiator_depth = cmd.initiator_depth;
782 param.remote_cm_response_timeout = cmd.remote_cm_response_timeout;
783 param.flow_control = cmd.flow_control;
784 param.local_cm_response_timeout = cmd.local_cm_response_timeout;
785 param.retry_count = cmd.retry_count;
786 param.rnr_retry_count = cmd.rnr_retry_count;
787 param.max_cm_retries = cmd.max_cm_retries;
788 param.srq = cmd.srq;
789
790 ctx = ib_ucm_ctx_get(file, cmd.id);
791 if (!IS_ERR(ctx)) {
792 result = ib_send_cm_req(ctx->cm_id, &param);
793 ib_ucm_ctx_put(ctx);
794 } else
795 result = PTR_ERR(ctx);
796
797 done:
798 kfree(param.private_data);
799 kfree(param.primary_path);
800 kfree(param.alternate_path);
801 return result;
802 }
803
804 static ssize_t ib_ucm_send_rep(struct ib_ucm_file *file,
805 const char __user *inbuf,
806 int in_len, int out_len)
807 {
808 struct ib_cm_rep_param param;
809 struct ib_ucm_context *ctx;
810 struct ib_ucm_rep cmd;
811 int result;
812
813 param.private_data = NULL;
814
815 if (copy_from_user(&cmd, inbuf, sizeof(cmd)))
816 return -EFAULT;
817
818 result = ib_ucm_alloc_data(&param.private_data, cmd.data, cmd.len);
819 if (result)
820 return result;
821
822 param.qp_num = cmd.qpn;
823 param.starting_psn = cmd.psn;
824 param.private_data_len = cmd.len;
825 param.responder_resources = cmd.responder_resources;
826 param.initiator_depth = cmd.initiator_depth;
827 param.failover_accepted = cmd.failover_accepted;
828 param.flow_control = cmd.flow_control;
829 param.rnr_retry_count = cmd.rnr_retry_count;
830 param.srq = cmd.srq;
831
832 ctx = ib_ucm_ctx_get(file, cmd.id);
833 if (!IS_ERR(ctx)) {
834 ctx->uid = cmd.uid;
835 result = ib_send_cm_rep(ctx->cm_id, &param);
836 ib_ucm_ctx_put(ctx);
837 } else
838 result = PTR_ERR(ctx);
839
840 kfree(param.private_data);
841 return result;
842 }
843
844 static ssize_t ib_ucm_send_private_data(struct ib_ucm_file *file,
845 const char __user *inbuf, int in_len,
846 int (*func)(struct ib_cm_id *cm_id,
847 const void *private_data,
848 u8 private_data_len))
849 {
850 struct ib_ucm_private_data cmd;
851 struct ib_ucm_context *ctx;
852 const void *private_data = NULL;
853 int result;
854
855 if (copy_from_user(&cmd, inbuf, sizeof(cmd)))
856 return -EFAULT;
857
858 result = ib_ucm_alloc_data(&private_data, cmd.data, cmd.len);
859 if (result)
860 return result;
861
862 ctx = ib_ucm_ctx_get(file, cmd.id);
863 if (!IS_ERR(ctx)) {
864 result = func(ctx->cm_id, private_data, cmd.len);
865 ib_ucm_ctx_put(ctx);
866 } else
867 result = PTR_ERR(ctx);
868
869 kfree(private_data);
870 return result;
871 }
872
873 static ssize_t ib_ucm_send_rtu(struct ib_ucm_file *file,
874 const char __user *inbuf,
875 int in_len, int out_len)
876 {
877 return ib_ucm_send_private_data(file, inbuf, in_len, ib_send_cm_rtu);
878 }
879
880 static ssize_t ib_ucm_send_dreq(struct ib_ucm_file *file,
881 const char __user *inbuf,
882 int in_len, int out_len)
883 {
884 return ib_ucm_send_private_data(file, inbuf, in_len, ib_send_cm_dreq);
885 }
886
887 static ssize_t ib_ucm_send_drep(struct ib_ucm_file *file,
888 const char __user *inbuf,
889 int in_len, int out_len)
890 {
891 return ib_ucm_send_private_data(file, inbuf, in_len, ib_send_cm_drep);
892 }
893
894 static ssize_t ib_ucm_send_info(struct ib_ucm_file *file,
895 const char __user *inbuf, int in_len,
896 int (*func)(struct ib_cm_id *cm_id,
897 int status,
898 const void *info,
899 u8 info_len,
900 const void *data,
901 u8 data_len))
902 {
903 struct ib_ucm_context *ctx;
904 struct ib_ucm_info cmd;
905 const void *data = NULL;
906 const void *info = NULL;
907 int result;
908
909 if (copy_from_user(&cmd, inbuf, sizeof(cmd)))
910 return -EFAULT;
911
912 result = ib_ucm_alloc_data(&data, cmd.data, cmd.data_len);
913 if (result)
914 goto done;
915
916 result = ib_ucm_alloc_data(&info, cmd.info, cmd.info_len);
917 if (result)
918 goto done;
919
920 ctx = ib_ucm_ctx_get(file, cmd.id);
921 if (!IS_ERR(ctx)) {
922 result = func(ctx->cm_id, cmd.status, info, cmd.info_len,
923 data, cmd.data_len);
924 ib_ucm_ctx_put(ctx);
925 } else
926 result = PTR_ERR(ctx);
927
928 done:
929 kfree(data);
930 kfree(info);
931 return result;
932 }
933
934 static ssize_t ib_ucm_send_rej(struct ib_ucm_file *file,
935 const char __user *inbuf,
936 int in_len, int out_len)
937 {
938 return ib_ucm_send_info(file, inbuf, in_len, (void *)ib_send_cm_rej);
939 }
940
941 static ssize_t ib_ucm_send_apr(struct ib_ucm_file *file,
942 const char __user *inbuf,
943 int in_len, int out_len)
944 {
945 return ib_ucm_send_info(file, inbuf, in_len, (void *)ib_send_cm_apr);
946 }
947
948 static ssize_t ib_ucm_send_mra(struct ib_ucm_file *file,
949 const char __user *inbuf,
950 int in_len, int out_len)
951 {
952 struct ib_ucm_context *ctx;
953 struct ib_ucm_mra cmd;
954 const void *data = NULL;
955 int result;
956
957 if (copy_from_user(&cmd, inbuf, sizeof(cmd)))
958 return -EFAULT;
959
960 result = ib_ucm_alloc_data(&data, cmd.data, cmd.len);
961 if (result)
962 return result;
963
964 ctx = ib_ucm_ctx_get(file, cmd.id);
965 if (!IS_ERR(ctx)) {
966 result = ib_send_cm_mra(ctx->cm_id, cmd.timeout, data, cmd.len);
967 ib_ucm_ctx_put(ctx);
968 } else
969 result = PTR_ERR(ctx);
970
971 kfree(data);
972 return result;
973 }
974
975 static ssize_t ib_ucm_send_lap(struct ib_ucm_file *file,
976 const char __user *inbuf,
977 int in_len, int out_len)
978 {
979 struct ib_ucm_context *ctx;
980 struct ib_sa_path_rec *path = NULL;
981 struct ib_ucm_lap cmd;
982 const void *data = NULL;
983 int result;
984
985 if (copy_from_user(&cmd, inbuf, sizeof(cmd)))
986 return -EFAULT;
987
988 result = ib_ucm_alloc_data(&data, cmd.data, cmd.len);
989 if (result)
990 goto done;
991
992 result = ib_ucm_path_get(&path, cmd.path);
993 if (result)
994 goto done;
995
996 ctx = ib_ucm_ctx_get(file, cmd.id);
997 if (!IS_ERR(ctx)) {
998 result = ib_send_cm_lap(ctx->cm_id, path, data, cmd.len);
999 ib_ucm_ctx_put(ctx);
1000 } else
1001 result = PTR_ERR(ctx);
1002
1003 done:
1004 kfree(data);
1005 kfree(path);
1006 return result;
1007 }
1008
1009 static ssize_t ib_ucm_send_sidr_req(struct ib_ucm_file *file,
1010 const char __user *inbuf,
1011 int in_len, int out_len)
1012 {
1013 struct ib_cm_sidr_req_param param;
1014 struct ib_ucm_context *ctx;
1015 struct ib_ucm_sidr_req cmd;
1016 int result;
1017
1018 param.private_data = NULL;
1019 param.path = NULL;
1020
1021 if (copy_from_user(&cmd, inbuf, sizeof(cmd)))
1022 return -EFAULT;
1023
1024 result = ib_ucm_alloc_data(&param.private_data, cmd.data, cmd.len);
1025 if (result)
1026 goto done;
1027
1028 result = ib_ucm_path_get(&param.path, cmd.path);
1029 if (result)
1030 goto done;
1031
1032 param.private_data_len = cmd.len;
1033 param.service_id = cmd.sid;
1034 param.timeout_ms = cmd.timeout;
1035 param.max_cm_retries = cmd.max_cm_retries;
1036
1037 ctx = ib_ucm_ctx_get(file, cmd.id);
1038 if (!IS_ERR(ctx)) {
1039 result = ib_send_cm_sidr_req(ctx->cm_id, &param);
1040 ib_ucm_ctx_put(ctx);
1041 } else
1042 result = PTR_ERR(ctx);
1043
1044 done:
1045 kfree(param.private_data);
1046 kfree(param.path);
1047 return result;
1048 }
1049
1050 static ssize_t ib_ucm_send_sidr_rep(struct ib_ucm_file *file,
1051 const char __user *inbuf,
1052 int in_len, int out_len)
1053 {
1054 struct ib_cm_sidr_rep_param param;
1055 struct ib_ucm_sidr_rep cmd;
1056 struct ib_ucm_context *ctx;
1057 int result;
1058
1059 param.info = NULL;
1060
1061 if (copy_from_user(&cmd, inbuf, sizeof(cmd)))
1062 return -EFAULT;
1063
1064 result = ib_ucm_alloc_data(&param.private_data,
1065 cmd.data, cmd.data_len);
1066 if (result)
1067 goto done;
1068
1069 result = ib_ucm_alloc_data(&param.info, cmd.info, cmd.info_len);
1070 if (result)
1071 goto done;
1072
1073 param.qp_num = cmd.qpn;
1074 param.qkey = cmd.qkey;
1075 param.status = cmd.status;
1076 param.info_length = cmd.info_len;
1077 param.private_data_len = cmd.data_len;
1078
1079 ctx = ib_ucm_ctx_get(file, cmd.id);
1080 if (!IS_ERR(ctx)) {
1081 result = ib_send_cm_sidr_rep(ctx->cm_id, &param);
1082 ib_ucm_ctx_put(ctx);
1083 } else
1084 result = PTR_ERR(ctx);
1085
1086 done:
1087 kfree(param.private_data);
1088 kfree(param.info);
1089 return result;
1090 }
1091
1092 static ssize_t (*ucm_cmd_table[])(struct ib_ucm_file *file,
1093 const char __user *inbuf,
1094 int in_len, int out_len) = {
1095 [IB_USER_CM_CMD_CREATE_ID] = ib_ucm_create_id,
1096 [IB_USER_CM_CMD_DESTROY_ID] = ib_ucm_destroy_id,
1097 [IB_USER_CM_CMD_ATTR_ID] = ib_ucm_attr_id,
1098 [IB_USER_CM_CMD_LISTEN] = ib_ucm_listen,
1099 [IB_USER_CM_CMD_NOTIFY] = ib_ucm_notify,
1100 [IB_USER_CM_CMD_SEND_REQ] = ib_ucm_send_req,
1101 [IB_USER_CM_CMD_SEND_REP] = ib_ucm_send_rep,
1102 [IB_USER_CM_CMD_SEND_RTU] = ib_ucm_send_rtu,
1103 [IB_USER_CM_CMD_SEND_DREQ] = ib_ucm_send_dreq,
1104 [IB_USER_CM_CMD_SEND_DREP] = ib_ucm_send_drep,
1105 [IB_USER_CM_CMD_SEND_REJ] = ib_ucm_send_rej,
1106 [IB_USER_CM_CMD_SEND_MRA] = ib_ucm_send_mra,
1107 [IB_USER_CM_CMD_SEND_LAP] = ib_ucm_send_lap,
1108 [IB_USER_CM_CMD_SEND_APR] = ib_ucm_send_apr,
1109 [IB_USER_CM_CMD_SEND_SIDR_REQ] = ib_ucm_send_sidr_req,
1110 [IB_USER_CM_CMD_SEND_SIDR_REP] = ib_ucm_send_sidr_rep,
1111 [IB_USER_CM_CMD_EVENT] = ib_ucm_event,
1112 [IB_USER_CM_CMD_INIT_QP_ATTR] = ib_ucm_init_qp_attr,
1113 };
1114
1115 static ssize_t ib_ucm_write(struct file *filp, const char __user *buf,
1116 size_t len, loff_t *pos)
1117 {
1118 struct ib_ucm_file *file = filp->private_data;
1119 struct ib_ucm_cmd_hdr hdr;
1120 ssize_t result;
1121
1122 if (len < sizeof(hdr))
1123 return -EINVAL;
1124
1125 if (copy_from_user(&hdr, buf, sizeof(hdr)))
1126 return -EFAULT;
1127
1128 if (hdr.cmd < 0 || hdr.cmd >= ARRAY_SIZE(ucm_cmd_table))
1129 return -EINVAL;
1130
1131 if (hdr.in + sizeof(hdr) > len)
1132 return -EINVAL;
1133
1134 result = ucm_cmd_table[hdr.cmd](file, buf + sizeof(hdr),
1135 hdr.in, hdr.out);
1136 if (!result)
1137 result = len;
1138
1139 return result;
1140 }
1141
1142 static unsigned int ib_ucm_poll(struct file *filp,
1143 struct poll_table_struct *wait)
1144 {
1145 struct ib_ucm_file *file = filp->private_data;
1146 unsigned int mask = 0;
1147
1148 poll_wait(filp, &file->poll_wait, wait);
1149
1150 if (!list_empty(&file->events))
1151 mask = POLLIN | POLLRDNORM;
1152
1153 return mask;
1154 }
1155
1156 /*
1157 * ib_ucm_open() does not need the BKL:
1158 *
1159 * - no global state is referred to;
1160 * - there is no ioctl method to race against;
1161 * - no further module initialization is required for open to work
1162 * after the device is registered.
1163 */
1164 static int ib_ucm_open(struct inode *inode, struct file *filp)
1165 {
1166 struct ib_ucm_file *file;
1167
1168 file = kmalloc(sizeof(*file), GFP_KERNEL);
1169 if (!file)
1170 return -ENOMEM;
1171
1172 INIT_LIST_HEAD(&file->events);
1173 INIT_LIST_HEAD(&file->ctxs);
1174 init_waitqueue_head(&file->poll_wait);
1175
1176 mutex_init(&file->file_mutex);
1177
1178 filp->private_data = file;
1179 file->filp = filp;
1180 file->device = container_of(inode->i_cdev, struct ib_ucm_device, cdev);
1181
1182 return 0;
1183 }
1184
1185 static int ib_ucm_close(struct inode *inode, struct file *filp)
1186 {
1187 struct ib_ucm_file *file = filp->private_data;
1188 struct ib_ucm_context *ctx;
1189
1190 mutex_lock(&file->file_mutex);
1191 while (!list_empty(&file->ctxs)) {
1192 ctx = list_entry(file->ctxs.next,
1193 struct ib_ucm_context, file_list);
1194 mutex_unlock(&file->file_mutex);
1195
1196 mutex_lock(&ctx_id_mutex);
1197 idr_remove(&ctx_id_table, ctx->id);
1198 mutex_unlock(&ctx_id_mutex);
1199
1200 ib_destroy_cm_id(ctx->cm_id);
1201 ib_ucm_cleanup_events(ctx);
1202 kfree(ctx);
1203
1204 mutex_lock(&file->file_mutex);
1205 }
1206 mutex_unlock(&file->file_mutex);
1207 kfree(file);
1208 return 0;
1209 }
1210
1211 static void ib_ucm_release_dev(struct device *dev)
1212 {
1213 struct ib_ucm_device *ucm_dev;
1214
1215 ucm_dev = container_of(dev, struct ib_ucm_device, dev);
1216 cdev_del(&ucm_dev->cdev);
1217 clear_bit(ucm_dev->devnum, dev_map);
1218 kfree(ucm_dev);
1219 }
1220
1221 static const struct file_operations ucm_fops = {
1222 .owner = THIS_MODULE,
1223 .open = ib_ucm_open,
1224 .release = ib_ucm_close,
1225 .write = ib_ucm_write,
1226 .poll = ib_ucm_poll,
1227 };
1228
1229 static ssize_t show_ibdev(struct device *dev, struct device_attribute *attr,
1230 char *buf)
1231 {
1232 struct ib_ucm_device *ucm_dev;
1233
1234 ucm_dev = container_of(dev, struct ib_ucm_device, dev);
1235 return sprintf(buf, "%s\n", ucm_dev->ib_dev->name);
1236 }
1237 static DEVICE_ATTR(ibdev, S_IRUGO, show_ibdev, NULL);
1238
1239 static void ib_ucm_add_one(struct ib_device *device)
1240 {
1241 struct ib_ucm_device *ucm_dev;
1242
1243 if (!device->alloc_ucontext ||
1244 rdma_node_get_transport(device->node_type) != RDMA_TRANSPORT_IB)
1245 return;
1246
1247 ucm_dev = kzalloc(sizeof *ucm_dev, GFP_KERNEL);
1248 if (!ucm_dev)
1249 return;
1250
1251 ucm_dev->ib_dev = device;
1252
1253 ucm_dev->devnum = find_first_zero_bit(dev_map, IB_UCM_MAX_DEVICES);
1254 if (ucm_dev->devnum >= IB_UCM_MAX_DEVICES)
1255 goto err;
1256
1257 set_bit(ucm_dev->devnum, dev_map);
1258
1259 cdev_init(&ucm_dev->cdev, &ucm_fops);
1260 ucm_dev->cdev.owner = THIS_MODULE;
1261 kobject_set_name(&ucm_dev->cdev.kobj, "ucm%d", ucm_dev->devnum);
1262 if (cdev_add(&ucm_dev->cdev, IB_UCM_BASE_DEV + ucm_dev->devnum, 1))
1263 goto err;
1264
1265 ucm_dev->dev.class = &cm_class;
1266 ucm_dev->dev.parent = device->dma_device;
1267 ucm_dev->dev.devt = ucm_dev->cdev.dev;
1268 ucm_dev->dev.release = ib_ucm_release_dev;
1269 dev_set_name(&ucm_dev->dev, "ucm%d", ucm_dev->devnum);
1270 if (device_register(&ucm_dev->dev))
1271 goto err_cdev;
1272
1273 if (device_create_file(&ucm_dev->dev, &dev_attr_ibdev))
1274 goto err_dev;
1275
1276 ib_set_client_data(device, &ucm_client, ucm_dev);
1277 return;
1278
1279 err_dev:
1280 device_unregister(&ucm_dev->dev);
1281 err_cdev:
1282 cdev_del(&ucm_dev->cdev);
1283 clear_bit(ucm_dev->devnum, dev_map);
1284 err:
1285 kfree(ucm_dev);
1286 return;
1287 }
1288
1289 static void ib_ucm_remove_one(struct ib_device *device)
1290 {
1291 struct ib_ucm_device *ucm_dev = ib_get_client_data(device, &ucm_client);
1292
1293 if (!ucm_dev)
1294 return;
1295
1296 device_unregister(&ucm_dev->dev);
1297 }
1298
1299 static ssize_t show_abi_version(struct class *class, char *buf)
1300 {
1301 return sprintf(buf, "%d\n", IB_USER_CM_ABI_VERSION);
1302 }
1303 static CLASS_ATTR(abi_version, S_IRUGO, show_abi_version, NULL);
1304
1305 static int __init ib_ucm_init(void)
1306 {
1307 int ret;
1308
1309 ret = register_chrdev_region(IB_UCM_BASE_DEV, IB_UCM_MAX_DEVICES,
1310 "infiniband_cm");
1311 if (ret) {
1312 printk(KERN_ERR "ucm: couldn't register device number\n");
1313 goto error1;
1314 }
1315
1316 ret = class_create_file(&cm_class, &class_attr_abi_version);
1317 if (ret) {
1318 printk(KERN_ERR "ucm: couldn't create abi_version attribute\n");
1319 goto error2;
1320 }
1321
1322 ret = ib_register_client(&ucm_client);
1323 if (ret) {
1324 printk(KERN_ERR "ucm: couldn't register client\n");
1325 goto error3;
1326 }
1327 return 0;
1328
1329 error3:
1330 class_remove_file(&cm_class, &class_attr_abi_version);
1331 error2:
1332 unregister_chrdev_region(IB_UCM_BASE_DEV, IB_UCM_MAX_DEVICES);
1333 error1:
1334 return ret;
1335 }
1336
1337 static void __exit ib_ucm_cleanup(void)
1338 {
1339 ib_unregister_client(&ucm_client);
1340 class_remove_file(&cm_class, &class_attr_abi_version);
1341 unregister_chrdev_region(IB_UCM_BASE_DEV, IB_UCM_MAX_DEVICES);
1342 idr_destroy(&ctx_id_table);
1343 }
1344
1345 module_init(ib_ucm_init);
1346 module_exit(ib_ucm_cleanup);
connection oriented routing - ARCHIVE NO UPDATES HERE