Whamcloud - gitweb
* Stopped outputting error messages on lctl set_route, when <nid> isn't
[fs/lustre-release.git] / lnet / libcfs / module.c
1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
2  * vim:expandtab:shiftwidth=8:tabstop=8:
3  *
4  * Copyright (C) 2001, 2002 Cluster File Systems, Inc.
5  *
6  *   This file is part of Lustre, http://www.lustre.org.
7  *
8  *   Lustre is free software; you can redistribute it and/or
9  *   modify it under the terms of version 2 of the GNU General Public
10  *   License as published by the Free Software Foundation.
11  *
12  *   Lustre 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 Lustre; if not, write to the Free Software
19  *   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
20  */
21
22 #ifndef EXPORT_SYMTAB
23 # define EXPORT_SYMTAB
24 #endif
25 #define DEBUG_SUBSYSTEM S_PORTALS
26
27 #include <linux/config.h>
28 #include <linux/module.h>
29 #include <linux/kernel.h>
30 #include <linux/mm.h>
31 #include <linux/string.h>
32 #include <linux/stat.h>
33 #include <linux/init.h>
34 #include <linux/errno.h>
35 #include <linux/smp_lock.h>
36 #include <linux/unistd.h>
37
38 #include <asm/system.h>
39 #include <asm/uaccess.h>
40
41 #include <linux/fs.h>
42 #include <linux/stat.h>
43 #include <asm/uaccess.h>
44 #include <asm/segment.h>
45 #include <linux/miscdevice.h>
46
47 #include <portals/lib-p30.h>
48 #include <portals/p30.h>
49 #include <linux/kp30.h>
50 #include <linux/portals_compat25.h>
51
52 #define PORTAL_MINOR 240
53
54 extern void (kping_client)(struct portal_ioctl_data *);
55
56 struct nal_cmd_handler {
57         nal_cmd_handler_t nch_handler;
58         void * nch_private;
59 };
60
61 static struct nal_cmd_handler nal_cmd[NAL_MAX_NR + 1];
62 struct semaphore nal_cmd_sem;
63
64 #ifdef PORTAL_DEBUG
65 void kportal_assertion_failed(char *expr, char *file, const char *func,
66                               const int line)
67 {
68         portals_debug_msg(0, D_EMERG, file, func, line, CDEBUG_STACK,
69                           "ASSERTION(%s) failed\n", expr);
70         LBUG_WITH_LOC(file, func, line);
71 }
72 #endif
73
74 void
75 kportal_daemonize (char *str) 
76 {
77 #if (LINUX_VERSION_CODE >= KERNEL_VERSION(2,5,63))
78         daemonize(str);
79 #else
80         daemonize();
81         snprintf (current->comm, sizeof (current->comm), "%s", str);
82 #endif
83 }
84
85 void
86 kportal_blockallsigs ()
87 {
88         unsigned long  flags;
89
90         SIGNAL_MASK_LOCK(current, flags);
91         sigfillset(&current->blocked);
92         RECALC_SIGPENDING;
93         SIGNAL_MASK_UNLOCK(current, flags);
94 }
95
96 /* called when opening /dev/device */
97 static int kportal_psdev_open(struct inode * inode, struct file * file)
98 {
99         ENTRY;
100
101         if (!inode)
102                 RETURN(-EINVAL);
103         PORTAL_MODULE_USE;
104         RETURN(0);
105 }
106
107 /* called when closing /dev/device */
108 static int kportal_psdev_release(struct inode * inode, struct file * file)
109 {
110         ENTRY;
111
112         if (!inode)
113                 RETURN(-EINVAL);
114
115         PORTAL_MODULE_UNUSE;
116         RETURN(0);
117 }
118
119 static inline void freedata(void *data, int len)
120 {
121         PORTAL_FREE(data, len);
122 }
123
124 static int
125 kportal_add_route(int gateway_nalid, ptl_nid_t gateway_nid, 
126                   ptl_nid_t lo_nid, ptl_nid_t hi_nid)
127 {
128         int rc;
129         kpr_control_interface_t *ci;
130
131         ci = (kpr_control_interface_t *) PORTAL_SYMBOL_GET (kpr_control_interface);
132         if (ci == NULL)
133                 return (-ENODEV);
134
135         rc = ci->kprci_add_route (gateway_nalid, gateway_nid, lo_nid, hi_nid);
136
137         PORTAL_SYMBOL_PUT(kpr_control_interface);
138         return (rc);
139 }
140
141 static int
142 kportal_del_route(int gw_nalid, ptl_nid_t gw_nid, 
143                   ptl_nid_t lo, ptl_nid_t hi)
144 {
145         int rc;
146         kpr_control_interface_t *ci;
147
148         ci = (kpr_control_interface_t *)PORTAL_SYMBOL_GET(kpr_control_interface);
149         if (ci == NULL)
150                 return (-ENODEV);
151
152         rc = ci->kprci_del_route (gw_nalid, gw_nid, lo, hi);
153
154         PORTAL_SYMBOL_PUT(kpr_control_interface);
155         return (rc);
156 }
157
158 static int
159 kportal_notify_router (int gw_nalid, ptl_nid_t gw_nid,
160                        int alive, time_t when)
161 {
162         int rc;
163         kpr_control_interface_t *ci;
164
165         /* No error if router not preset.  Sysadmin is allowed to notify
166          * _everywhere_ when a NID boots or crashes, even if they know
167          * nothing of the peer. */
168         ci = (kpr_control_interface_t *)PORTAL_SYMBOL_GET(kpr_control_interface);
169         if (ci == NULL)
170                 return (0);
171
172         rc = ci->kprci_notify (gw_nalid, gw_nid, alive, when);
173
174         PORTAL_SYMBOL_PUT(kpr_control_interface);
175         return (rc);
176 }
177
178 static int
179 kportal_get_route(int index, __u32 *gateway_nalidp, ptl_nid_t *gateway_nidp,
180                   ptl_nid_t *lo_nidp, ptl_nid_t *hi_nidp, int *alivep)
181 {
182         int       gateway_nalid;
183         ptl_nid_t gateway_nid;
184         ptl_nid_t lo_nid;
185         ptl_nid_t hi_nid;
186         int       alive;
187         int       rc;
188         kpr_control_interface_t *ci;
189
190         ci = (kpr_control_interface_t *) PORTAL_SYMBOL_GET(kpr_control_interface);
191         if (ci == NULL)
192                 return (-ENODEV);
193
194         rc = ci->kprci_get_route(index, &gateway_nalid, &gateway_nid,
195                                  &lo_nid, &hi_nid, &alive);
196
197         if (rc == 0) {
198                 CDEBUG(D_IOCTL, "got route [%d] %d "LPX64":"LPX64" - "LPX64", %s\n",
199                        index, gateway_nalid, gateway_nid, lo_nid, hi_nid,
200                        alive ? "up" : "down");
201
202                 *gateway_nalidp = (__u32)gateway_nalid;
203                 *gateway_nidp   = gateway_nid;
204                 *lo_nidp        = lo_nid;
205                 *hi_nidp        = hi_nid;
206                 *alivep         = alive;
207         }
208
209         PORTAL_SYMBOL_PUT (kpr_control_interface);
210         return (rc);
211 }
212
213 static int
214 kportal_nal_cmd(int nal, struct portal_ioctl_data *data)
215 {
216         int rc = -EINVAL;
217
218         ENTRY;
219
220         down(&nal_cmd_sem);
221         if (nal > 0 && nal <= NAL_MAX_NR && nal_cmd[nal].nch_handler) {
222                 CDEBUG(D_IOCTL, "calling handler nal: %d, cmd: %d\n", nal, data->ioc_nal_cmd);
223                 rc = nal_cmd[nal].nch_handler(data, nal_cmd[nal].nch_private);
224         }
225         up(&nal_cmd_sem);
226         RETURN(rc);
227 }
228
229 ptl_handle_ni_t *
230 kportal_get_ni (int nal)
231 {
232
233         switch (nal)
234         {
235         case QSWNAL:
236                 return (PORTAL_SYMBOL_GET(kqswnal_ni));
237         case SOCKNAL:
238                 return (PORTAL_SYMBOL_GET(ksocknal_ni));
239         case TOENAL:
240                 return  (PORTAL_SYMBOL_GET(ktoenal_ni));
241         case GMNAL:
242                 return  (PORTAL_SYMBOL_GET(kgmnal_ni));
243         case TCPNAL:
244                 /* userspace NAL */
245                 return (NULL);
246         case SCIMACNAL:
247                 return  (PORTAL_SYMBOL_GET(kscimacnal_ni));
248         default:
249                 /* A warning to a naive caller */
250                 CERROR ("unknown nal: %d\n", nal);
251                 return (NULL);
252         }
253 }
254
255 void
256 kportal_put_ni (int nal)
257 {
258
259         switch (nal)
260         {
261         case QSWNAL:
262                 PORTAL_SYMBOL_PUT(kqswnal_ni);
263                 break;
264         case SOCKNAL:
265                 PORTAL_SYMBOL_PUT(ksocknal_ni);
266                 break;
267         case TOENAL:
268                 PORTAL_SYMBOL_PUT(ktoenal_ni);
269                 break;
270         case GMNAL:
271                 PORTAL_SYMBOL_PUT(kgmnal_ni);
272                 break;
273         case TCPNAL:
274                 /* A lesson to a malicious caller */
275                 LBUG ();
276         case SCIMACNAL:
277                 PORTAL_SYMBOL_PUT(kscimacnal_ni);
278                 break;
279         default:
280                 CERROR ("unknown nal: %d\n", nal);
281         }
282 }
283
284 int
285 kportal_nal_register(int nal, nal_cmd_handler_t handler, void * private)
286 {
287         int rc = 0;
288
289         CDEBUG(D_IOCTL, "Register NAL %d, handler: %p\n", nal, handler);
290
291         if (nal > 0  && nal <= NAL_MAX_NR) {
292                 down(&nal_cmd_sem);
293                 if (nal_cmd[nal].nch_handler != NULL)
294                         rc = -EBUSY;
295                 else {
296                         nal_cmd[nal].nch_handler = handler;
297                         nal_cmd[nal].nch_private = private;
298                 }
299                 up(&nal_cmd_sem);
300         }
301         return rc;
302 }
303
304 int
305 kportal_nal_unregister(int nal)
306 {
307         int rc = 0;
308
309         CDEBUG(D_IOCTL, "Unregister NAL %d\n", nal);
310
311         if (nal > 0  && nal <= NAL_MAX_NR) {
312                 down(&nal_cmd_sem);
313                 nal_cmd[nal].nch_handler = NULL;
314                 nal_cmd[nal].nch_private = NULL;
315                 up(&nal_cmd_sem);
316         }
317         return rc;
318 }
319
320
321 static int kportal_ioctl(struct inode *inode, struct file *file,
322                          unsigned int cmd, unsigned long arg)
323 {
324         int err = 0;
325         char buf[1024];
326         struct portal_ioctl_data *data;
327
328         ENTRY;
329
330         if ( _IOC_TYPE(cmd) != IOC_PORTAL_TYPE ||
331              _IOC_NR(cmd) < IOC_PORTAL_MIN_NR  ||
332              _IOC_NR(cmd) > IOC_PORTAL_MAX_NR ) {
333                 CDEBUG(D_IOCTL, "invalid ioctl ( type %d, nr %d, size %d )\n",
334                                 _IOC_TYPE(cmd), _IOC_NR(cmd), _IOC_SIZE(cmd));
335                 RETURN(-EINVAL);
336         }
337
338         if (portal_ioctl_getdata(buf, buf + 800, (void *)arg)) {
339                 CERROR("PORTALS ioctl: data error\n");
340                 RETURN(-EINVAL);
341         }
342
343         data = (struct portal_ioctl_data *)buf;
344
345         switch (cmd) {
346         case IOC_PORTAL_SET_DAEMON: 
347                 RETURN (portals_debug_set_daemon ( 
348                                         (unsigned int) data->ioc_count,
349                                         (unsigned int) data->ioc_inllen1,
350                                         (char *) data->ioc_inlbuf1,
351                                         (unsigned int) data->ioc_misc)); 
352         case IOC_PORTAL_GET_DEBUG: {
353                 __s32 size = portals_debug_copy_to_user(data->ioc_pbuf1,
354                                                         data->ioc_plen1);
355
356                 if (size < 0)
357                         RETURN(size);
358
359                 data->ioc_size = size;
360                 err = copy_to_user((char *)arg, data, sizeof(*data));
361                 RETURN(err);
362         }
363         case IOC_PORTAL_CLEAR_DEBUG:
364                 portals_debug_clear_buffer();
365                 RETURN(0);
366         case IOC_PORTAL_PANIC:
367                 if (!capable (CAP_SYS_BOOT))
368                         RETURN (-EPERM);
369                 panic("debugctl-invoked panic");
370                 RETURN(0);
371         case IOC_PORTAL_MARK_DEBUG:
372                 if (data->ioc_inlbuf1 == NULL ||
373                     data->ioc_inlbuf1[data->ioc_inllen1 - 1] != '\0')
374                         RETURN(-EINVAL);
375                 portals_debug_mark_buffer(data->ioc_inlbuf1);
376                 RETURN(0);
377         case IOC_PORTAL_PING: {
378                 void (*ping)(struct portal_ioctl_data *);
379
380                 CDEBUG(D_IOCTL, "doing %d pings to nid "LPU64"\n",
381                        data->ioc_count, data->ioc_nid);
382                 ping = PORTAL_SYMBOL_GET(kping_client);
383                 if (!ping)
384                         CERROR("PORTAL_SYMBOL_GET failed\n");
385                 else {
386                         ping(data);
387                         PORTAL_SYMBOL_PUT(kping_client);
388                 }
389                 RETURN(0);
390         }
391
392         case IOC_PORTAL_ADD_ROUTE:
393                 CDEBUG(D_IOCTL, "Adding route: [%d] "LPU64" : "LPU64" - "LPU64"\n",
394                        data->ioc_nal, data->ioc_nid, 
395                        data->ioc_nid2, data->ioc_nid3);
396                 err = kportal_add_route(data->ioc_nal, data->ioc_nid,
397                                         data->ioc_nid2, data->ioc_nid3);
398                 break;
399
400         case IOC_PORTAL_DEL_ROUTE:
401                 CDEBUG (D_IOCTL, "Removing routes via [%d] "LPU64" : "LPU64" - "LPU64"\n",
402                         data->ioc_nal, data->ioc_nid, 
403                         data->ioc_nid2, data->ioc_nid3);
404                 err = kportal_del_route (data->ioc_nal, data->ioc_nid,
405                                          data->ioc_nid2, data->ioc_nid3);
406                 break;
407
408         case IOC_PORTAL_NOTIFY_ROUTER: {
409                 CDEBUG (D_IOCTL, "Notifying peer [%d] "LPU64" %s @ %ld\n",
410                         data->ioc_nal, data->ioc_nid,
411                         data->ioc_flags ? "Enabling" : "Disabling",
412                         (time_t)data->ioc_nid3);
413                 
414                 err = kportal_notify_router (data->ioc_nal, data->ioc_nid,
415                                              data->ioc_flags, 
416                                              (time_t)data->ioc_nid3);
417                 break;
418         }
419                 
420         case IOC_PORTAL_GET_ROUTE:
421                 CDEBUG (D_IOCTL, "Getting route [%d]\n", data->ioc_count);
422                 err = kportal_get_route(data->ioc_count, &data->ioc_nal,
423                                         &data->ioc_nid, 
424                                         &data->ioc_nid2, &data->ioc_nid3,
425                                         &data->ioc_flags);
426                 if (err == 0)
427                         if (copy_to_user((char *)arg, data, sizeof (*data)))
428                                 err = -EFAULT;
429                 break;
430
431         case IOC_PORTAL_GET_NID: {
432                 const ptl_handle_ni_t *nip;
433                 ptl_process_id_t       pid;
434
435                 CDEBUG (D_IOCTL, "Getting nid [%d]\n", data->ioc_nal);
436
437                 nip = kportal_get_ni (data->ioc_nal);
438                 if (nip == NULL)
439                         RETURN (-EINVAL);
440
441                 err = PtlGetId (*nip, &pid);
442                 LASSERT (err == PTL_OK);
443                 kportal_put_ni (data->ioc_nal);
444
445                 data->ioc_nid = pid.nid;
446                 if (copy_to_user ((char *)arg, data, sizeof (*data)))
447                         err = -EFAULT;
448                 break;
449         }
450
451         case IOC_PORTAL_NAL_CMD:
452                 CDEBUG (D_IOCTL, "nal command nal %d cmd %d\n", data->ioc_nal,
453                         data->ioc_nal_cmd);
454                 err = kportal_nal_cmd(data->ioc_nal, data);
455                 if (err == 0)
456                         if (copy_to_user((char *)arg, data, sizeof (*data)))
457                                 err = -EFAULT;
458                 break;
459
460         case IOC_PORTAL_FAIL_NID: {
461                 const ptl_handle_ni_t *nip;
462
463                 CDEBUG (D_IOCTL, "fail nid: [%d] "LPU64" count %d\n",
464                         data->ioc_nal, data->ioc_nid, data->ioc_count);
465
466                 nip = kportal_get_ni (data->ioc_nal);
467                 if (nip == NULL)
468                         return (-EINVAL);
469
470                 err = PtlFailNid (*nip, data->ioc_nid, data->ioc_count);
471                 kportal_put_ni (data->ioc_nal);
472                 break;
473         }
474 #if LWT_SUPPORT
475         case IOC_PORTAL_LWT_CONTROL: 
476                 err = lwt_control (data->ioc_flags, data->ioc_misc);
477                 break;
478                 
479         case IOC_PORTAL_LWT_SNAPSHOT:
480                 err = lwt_snapshot (&data->ioc_count, &data->ioc_misc,
481                                     data->ioc_pbuf1, data->ioc_plen1);
482                 if (err == 0 &&
483                     copy_to_user((char *)arg, data, sizeof (*data)))
484                         err = -EFAULT;
485                 break;
486                 
487         case IOC_PORTAL_LWT_LOOKUP_STRING:
488                 err = lwt_lookup_string (&data->ioc_count, data->ioc_pbuf1,
489                                          data->ioc_pbuf2, data->ioc_plen2);
490                 if (err == 0 &&
491                     copy_to_user((char *)arg, data, sizeof (*data)))
492                         err = -EFAULT;
493                 break;
494 #endif                        
495         default:
496                 err = -EINVAL;
497                 break;
498         }
499
500         RETURN(err);
501 }
502
503
504 static struct file_operations portalsdev_fops = {
505         ioctl:   kportal_ioctl,
506         open:    kportal_psdev_open,
507         release: kportal_psdev_release
508 };
509
510
511 static struct miscdevice portal_dev = {
512         PORTAL_MINOR,
513         "portals",
514         &portalsdev_fops
515 };
516
517 extern int insert_proc(void);
518 extern void remove_proc(void);
519 MODULE_AUTHOR("Peter J. Braam <braam@clusterfs.com>");
520 MODULE_DESCRIPTION("Portals v3.1");
521 MODULE_LICENSE("GPL");
522
523 static int init_kportals_module(void)
524 {
525         int rc;
526
527         rc = portals_debug_init(5 * 1024 * 1024);
528         if (rc < 0) {
529                 printk(KERN_ERR "portals_debug_init: %d\n", rc);
530                 return (rc);
531         }
532
533 #if LWT_SUPPORT
534         rc = lwt_init();
535         if (rc != 0) {
536                 CERROR("lwt_init: error %d\n", rc);
537                 goto cleanup_debug;
538         }
539 #endif
540         sema_init(&nal_cmd_sem, 1);
541
542         rc = misc_register(&portal_dev);
543         if (rc) {
544                 CERROR("misc_register: error %d\n", rc);
545                 goto cleanup_lwt;
546         }
547
548         rc = PtlInit();
549         if (rc) {
550                 CERROR("PtlInit: error %d\n", rc);
551                 goto cleanup_deregister;
552         }
553
554         rc = insert_proc();
555         if (rc) {
556                 CERROR("insert_proc: error %d\n", rc);
557                 goto cleanup_fini;
558         }
559
560         CDEBUG (D_OTHER, "portals setup OK\n");
561         return (0);
562
563  cleanup_fini:
564         PtlFini();
565  cleanup_deregister:
566         misc_deregister(&portal_dev);
567  cleanup_lwt:
568 #if LWT_SUPPORT
569         lwt_fini();
570 #endif
571  cleanup_debug:
572         portals_debug_cleanup();
573         return rc;
574 }
575
576 static void exit_kportals_module(void)
577 {
578         int rc;
579
580         remove_proc();
581         PtlFini();
582
583         CDEBUG(D_MALLOC, "before Portals cleanup: kmem %d\n",
584                atomic_read(&portal_kmemory));
585
586
587         rc = misc_deregister(&portal_dev);
588         if (rc)
589                 CERROR("misc_deregister error %d\n", rc);
590
591 #if LWT_SUPPORT
592         lwt_fini();
593 #endif
594
595         if (atomic_read(&portal_kmemory) != 0)
596                 CERROR("Portals memory leaked: %d bytes\n",
597                        atomic_read(&portal_kmemory));
598
599         rc = portals_debug_cleanup();
600         if (rc)
601                 printk(KERN_ERR "portals_debug_cleanup: %d\n", rc);
602 }
603
604 EXPORT_SYMBOL(lib_dispatch);
605 EXPORT_SYMBOL(PtlMEAttach);
606 EXPORT_SYMBOL(PtlMEInsert);
607 EXPORT_SYMBOL(PtlMEUnlink);
608 EXPORT_SYMBOL(PtlEQAlloc);
609 EXPORT_SYMBOL(PtlMDAttach);
610 EXPORT_SYMBOL(PtlMDUnlink);
611 EXPORT_SYMBOL(PtlNIInit);
612 EXPORT_SYMBOL(PtlNIFini);
613 EXPORT_SYMBOL(PtlNIDebug);
614 EXPORT_SYMBOL(PtlInit);
615 EXPORT_SYMBOL(PtlFini);
616 EXPORT_SYMBOL(PtlPut);
617 EXPORT_SYMBOL(PtlGet);
618 EXPORT_SYMBOL(ptl_err_str);
619 EXPORT_SYMBOL(portal_subsystem_debug);
620 EXPORT_SYMBOL(portal_debug);
621 EXPORT_SYMBOL(portal_stack);
622 EXPORT_SYMBOL(portal_printk);
623 EXPORT_SYMBOL(PtlEQWait);
624 EXPORT_SYMBOL(PtlEQFree);
625 EXPORT_SYMBOL(PtlEQGet);
626 EXPORT_SYMBOL(PtlGetId);
627 EXPORT_SYMBOL(PtlMDBind);
628 EXPORT_SYMBOL(lib_iov_nob);
629 EXPORT_SYMBOL(lib_copy_iov2buf);
630 EXPORT_SYMBOL(lib_copy_buf2iov);
631 EXPORT_SYMBOL(lib_kiov_nob);
632 EXPORT_SYMBOL(lib_copy_kiov2buf);
633 EXPORT_SYMBOL(lib_copy_buf2kiov);
634 EXPORT_SYMBOL(lib_finalize);
635 EXPORT_SYMBOL(lib_parse);
636 EXPORT_SYMBOL(lib_init);
637 EXPORT_SYMBOL(lib_fini);
638 EXPORT_SYMBOL(portal_kmemory);
639 EXPORT_SYMBOL(kportal_daemonize);
640 EXPORT_SYMBOL(kportal_blockallsigs);
641 EXPORT_SYMBOL(kportal_nal_register);
642 EXPORT_SYMBOL(kportal_nal_unregister);
643 EXPORT_SYMBOL(kportal_assertion_failed);
644 EXPORT_SYMBOL(dispatch_name);
645 EXPORT_SYMBOL(kportal_get_ni);
646 EXPORT_SYMBOL(kportal_put_ni);
647
648 module_init(init_kportals_module);
649 module_exit (exit_kportals_module);