Whamcloud - gitweb
* lctl set_route <nid> <up/down> enables or disables particular portals
[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         ci = (kpr_control_interface_t *)PORTAL_SYMBOL_GET(kpr_control_interface);
166         if (ci == NULL)
167                 return (-ENODEV);
168
169         rc = ci->kprci_notify (gw_nalid, gw_nid, alive, when);
170
171         PORTAL_SYMBOL_PUT(kpr_control_interface);
172         return (rc);
173 }
174
175 static int
176 kportal_get_route(int index, __u32 *gateway_nalidp, ptl_nid_t *gateway_nidp,
177                   ptl_nid_t *lo_nidp, ptl_nid_t *hi_nidp, int *alivep)
178 {
179         int       gateway_nalid;
180         ptl_nid_t gateway_nid;
181         ptl_nid_t lo_nid;
182         ptl_nid_t hi_nid;
183         int       alive;
184         int       rc;
185         kpr_control_interface_t *ci;
186
187         ci = (kpr_control_interface_t *) PORTAL_SYMBOL_GET(kpr_control_interface);
188         if (ci == NULL)
189                 return (-ENODEV);
190
191         rc = ci->kprci_get_route(index, &gateway_nalid, &gateway_nid,
192                                  &lo_nid, &hi_nid, &alive);
193
194         if (rc == 0) {
195                 CDEBUG(D_IOCTL, "got route [%d] %d "LPX64":"LPX64" - "LPX64", %s\n",
196                        index, gateway_nalid, gateway_nid, lo_nid, hi_nid,
197                        alive ? "up" : "down");
198
199                 *gateway_nalidp = (__u32)gateway_nalid;
200                 *gateway_nidp   = gateway_nid;
201                 *lo_nidp        = lo_nid;
202                 *hi_nidp        = hi_nid;
203                 *alivep         = alive;
204         }
205
206         PORTAL_SYMBOL_PUT (kpr_control_interface);
207         return (rc);
208 }
209
210 static int
211 kportal_nal_cmd(int nal, struct portal_ioctl_data *data)
212 {
213         int rc = -EINVAL;
214
215         ENTRY;
216
217         down(&nal_cmd_sem);
218         if (nal > 0 && nal <= NAL_MAX_NR && nal_cmd[nal].nch_handler) {
219                 CDEBUG(D_IOCTL, "calling handler nal: %d, cmd: %d\n", nal, data->ioc_nal_cmd);
220                 rc = nal_cmd[nal].nch_handler(data, nal_cmd[nal].nch_private);
221         }
222         up(&nal_cmd_sem);
223         RETURN(rc);
224 }
225
226 ptl_handle_ni_t *
227 kportal_get_ni (int nal)
228 {
229
230         switch (nal)
231         {
232         case QSWNAL:
233                 return (PORTAL_SYMBOL_GET(kqswnal_ni));
234         case SOCKNAL:
235                 return (PORTAL_SYMBOL_GET(ksocknal_ni));
236         case TOENAL:
237                 return  (PORTAL_SYMBOL_GET(ktoenal_ni));
238         case GMNAL:
239                 return  (PORTAL_SYMBOL_GET(kgmnal_ni));
240         case TCPNAL:
241                 /* userspace NAL */
242                 return (NULL);
243         case SCIMACNAL:
244                 return  (PORTAL_SYMBOL_GET(kscimacnal_ni));
245         default:
246                 /* A warning to a naive caller */
247                 CERROR ("unknown nal: %d\n", nal);
248                 return (NULL);
249         }
250 }
251
252 void
253 kportal_put_ni (int nal)
254 {
255
256         switch (nal)
257         {
258         case QSWNAL:
259                 PORTAL_SYMBOL_PUT(kqswnal_ni);
260                 break;
261         case SOCKNAL:
262                 PORTAL_SYMBOL_PUT(ksocknal_ni);
263                 break;
264         case TOENAL:
265                 PORTAL_SYMBOL_PUT(ktoenal_ni);
266                 break;
267         case GMNAL:
268                 PORTAL_SYMBOL_PUT(kgmnal_ni);
269                 break;
270         case TCPNAL:
271                 /* A lesson to a malicious caller */
272                 LBUG ();
273         case SCIMACNAL:
274                 PORTAL_SYMBOL_PUT(kscimacnal_ni);
275                 break;
276         default:
277                 CERROR ("unknown nal: %d\n", nal);
278         }
279 }
280
281 int
282 kportal_nal_register(int nal, nal_cmd_handler_t handler, void * private)
283 {
284         int rc = 0;
285
286         CDEBUG(D_IOCTL, "Register NAL %d, handler: %p\n", nal, handler);
287
288         if (nal > 0  && nal <= NAL_MAX_NR) {
289                 down(&nal_cmd_sem);
290                 if (nal_cmd[nal].nch_handler != NULL)
291                         rc = -EBUSY;
292                 else {
293                         nal_cmd[nal].nch_handler = handler;
294                         nal_cmd[nal].nch_private = private;
295                 }
296                 up(&nal_cmd_sem);
297         }
298         return rc;
299 }
300
301 int
302 kportal_nal_unregister(int nal)
303 {
304         int rc = 0;
305
306         CDEBUG(D_IOCTL, "Unregister NAL %d\n", nal);
307
308         if (nal > 0  && nal <= NAL_MAX_NR) {
309                 down(&nal_cmd_sem);
310                 nal_cmd[nal].nch_handler = NULL;
311                 nal_cmd[nal].nch_private = NULL;
312                 up(&nal_cmd_sem);
313         }
314         return rc;
315 }
316
317
318 static int kportal_ioctl(struct inode *inode, struct file *file,
319                          unsigned int cmd, unsigned long arg)
320 {
321         int err = 0;
322         char buf[1024];
323         struct portal_ioctl_data *data;
324
325         ENTRY;
326
327         if ( _IOC_TYPE(cmd) != IOC_PORTAL_TYPE ||
328              _IOC_NR(cmd) < IOC_PORTAL_MIN_NR  ||
329              _IOC_NR(cmd) > IOC_PORTAL_MAX_NR ) {
330                 CDEBUG(D_IOCTL, "invalid ioctl ( type %d, nr %d, size %d )\n",
331                                 _IOC_TYPE(cmd), _IOC_NR(cmd), _IOC_SIZE(cmd));
332                 RETURN(-EINVAL);
333         }
334
335         if (portal_ioctl_getdata(buf, buf + 800, (void *)arg)) {
336                 CERROR("PORTALS ioctl: data error\n");
337                 RETURN(-EINVAL);
338         }
339
340         data = (struct portal_ioctl_data *)buf;
341
342         switch (cmd) {
343         case IOC_PORTAL_SET_DAEMON: 
344                 RETURN (portals_debug_set_daemon ( 
345                                         (unsigned int) data->ioc_count,
346                                         (unsigned int) data->ioc_inllen1,
347                                         (char *) data->ioc_inlbuf1,
348                                         (unsigned int) data->ioc_misc)); 
349         case IOC_PORTAL_GET_DEBUG: {
350                 __s32 size = portals_debug_copy_to_user(data->ioc_pbuf1,
351                                                         data->ioc_plen1);
352
353                 if (size < 0)
354                         RETURN(size);
355
356                 data->ioc_size = size;
357                 err = copy_to_user((char *)arg, data, sizeof(*data));
358                 RETURN(err);
359         }
360         case IOC_PORTAL_CLEAR_DEBUG:
361                 portals_debug_clear_buffer();
362                 RETURN(0);
363         case IOC_PORTAL_PANIC:
364                 if (!capable (CAP_SYS_BOOT))
365                         RETURN (-EPERM);
366                 panic("debugctl-invoked panic");
367                 RETURN(0);
368         case IOC_PORTAL_MARK_DEBUG:
369                 if (data->ioc_inlbuf1 == NULL ||
370                     data->ioc_inlbuf1[data->ioc_inllen1 - 1] != '\0')
371                         RETURN(-EINVAL);
372                 portals_debug_mark_buffer(data->ioc_inlbuf1);
373                 RETURN(0);
374         case IOC_PORTAL_PING: {
375                 void (*ping)(struct portal_ioctl_data *);
376
377                 CDEBUG(D_IOCTL, "doing %d pings to nid "LPU64"\n",
378                        data->ioc_count, data->ioc_nid);
379                 ping = PORTAL_SYMBOL_GET(kping_client);
380                 if (!ping)
381                         CERROR("PORTAL_SYMBOL_GET failed\n");
382                 else {
383                         ping(data);
384                         PORTAL_SYMBOL_PUT(kping_client);
385                 }
386                 RETURN(0);
387         }
388
389         case IOC_PORTAL_ADD_ROUTE:
390                 CDEBUG(D_IOCTL, "Adding route: [%d] "LPU64" : "LPU64" - "LPU64"\n",
391                        data->ioc_nal, data->ioc_nid, 
392                        data->ioc_nid2, data->ioc_nid3);
393                 err = kportal_add_route(data->ioc_nal, data->ioc_nid,
394                                         data->ioc_nid2, data->ioc_nid3);
395                 break;
396
397         case IOC_PORTAL_DEL_ROUTE:
398                 CDEBUG (D_IOCTL, "Removing routes via [%d] "LPU64" : "LPU64" - "LPU64"\n",
399                         data->ioc_nal, data->ioc_nid, 
400                         data->ioc_nid2, data->ioc_nid3);
401                 err = kportal_del_route (data->ioc_nal, data->ioc_nid,
402                                          data->ioc_nid2, data->ioc_nid3);
403                 break;
404
405         case IOC_PORTAL_NOTIFY_ROUTER: {
406                 CDEBUG (D_IOCTL, "Notifying peer [%d] "LPU64" %s @ %ld\n",
407                         data->ioc_nal, data->ioc_nid,
408                         data->ioc_flags ? "Enabling" : "Disabling",
409                         (time_t)data->ioc_nid3);
410                 
411                 err = kportal_notify_router (data->ioc_nal, data->ioc_nid,
412                                              data->ioc_flags, 
413                                              (time_t)data->ioc_nid3);
414                 break;
415         }
416                 
417         case IOC_PORTAL_GET_ROUTE:
418                 CDEBUG (D_IOCTL, "Getting route [%d]\n", data->ioc_count);
419                 err = kportal_get_route(data->ioc_count, &data->ioc_nal,
420                                         &data->ioc_nid, 
421                                         &data->ioc_nid2, &data->ioc_nid3,
422                                         &data->ioc_flags);
423                 if (err == 0)
424                         if (copy_to_user((char *)arg, data, sizeof (*data)))
425                                 err = -EFAULT;
426                 break;
427
428         case IOC_PORTAL_GET_NID: {
429                 const ptl_handle_ni_t *nip;
430                 ptl_process_id_t       pid;
431
432                 CDEBUG (D_IOCTL, "Getting nid [%d]\n", data->ioc_nal);
433
434                 nip = kportal_get_ni (data->ioc_nal);
435                 if (nip == NULL)
436                         RETURN (-EINVAL);
437
438                 err = PtlGetId (*nip, &pid);
439                 LASSERT (err == PTL_OK);
440                 kportal_put_ni (data->ioc_nal);
441
442                 data->ioc_nid = pid.nid;
443                 if (copy_to_user ((char *)arg, data, sizeof (*data)))
444                         err = -EFAULT;
445                 break;
446         }
447
448         case IOC_PORTAL_NAL_CMD:
449                 CDEBUG (D_IOCTL, "nal command nal %d cmd %d\n", data->ioc_nal,
450                         data->ioc_nal_cmd);
451                 err = kportal_nal_cmd(data->ioc_nal, data);
452                 if (err == 0)
453                         if (copy_to_user((char *)arg, data, sizeof (*data)))
454                                 err = -EFAULT;
455                 break;
456
457         case IOC_PORTAL_FAIL_NID: {
458                 const ptl_handle_ni_t *nip;
459
460                 CDEBUG (D_IOCTL, "fail nid: [%d] "LPU64" count %d\n",
461                         data->ioc_nal, data->ioc_nid, data->ioc_count);
462
463                 nip = kportal_get_ni (data->ioc_nal);
464                 if (nip == NULL)
465                         return (-EINVAL);
466
467                 err = PtlFailNid (*nip, data->ioc_nid, data->ioc_count);
468                 kportal_put_ni (data->ioc_nal);
469                 break;
470         }
471 #if LWT_SUPPORT
472         case IOC_PORTAL_LWT_CONTROL: 
473                 err = lwt_control (data->ioc_flags, data->ioc_misc);
474                 break;
475                 
476         case IOC_PORTAL_LWT_SNAPSHOT:
477                 err = lwt_snapshot (&data->ioc_count, &data->ioc_misc,
478                                     data->ioc_pbuf1, data->ioc_plen1);
479                 if (err == 0 &&
480                     copy_to_user((char *)arg, data, sizeof (*data)))
481                         err = -EFAULT;
482                 break;
483                 
484         case IOC_PORTAL_LWT_LOOKUP_STRING:
485                 err = lwt_lookup_string (&data->ioc_count, data->ioc_pbuf1,
486                                          data->ioc_pbuf2, data->ioc_plen2);
487                 if (err == 0 &&
488                     copy_to_user((char *)arg, data, sizeof (*data)))
489                         err = -EFAULT;
490                 break;
491 #endif                        
492         default:
493                 err = -EINVAL;
494                 break;
495         }
496
497         RETURN(err);
498 }
499
500
501 static struct file_operations portalsdev_fops = {
502         ioctl:   kportal_ioctl,
503         open:    kportal_psdev_open,
504         release: kportal_psdev_release
505 };
506
507
508 static struct miscdevice portal_dev = {
509         PORTAL_MINOR,
510         "portals",
511         &portalsdev_fops
512 };
513
514 extern int insert_proc(void);
515 extern void remove_proc(void);
516 MODULE_AUTHOR("Peter J. Braam <braam@clusterfs.com>");
517 MODULE_DESCRIPTION("Portals v3.1");
518 MODULE_LICENSE("GPL");
519
520 static int init_kportals_module(void)
521 {
522         int rc;
523
524         rc = portals_debug_init(5 * 1024 * 1024);
525         if (rc < 0) {
526                 printk(KERN_ERR "portals_debug_init: %d\n", rc);
527                 return (rc);
528         }
529
530 #if LWT_SUPPORT
531         rc = lwt_init();
532         if (rc != 0) {
533                 CERROR("lwt_init: error %d\n", rc);
534                 goto cleanup_debug;
535         }
536 #endif
537         sema_init(&nal_cmd_sem, 1);
538
539         rc = misc_register(&portal_dev);
540         if (rc) {
541                 CERROR("misc_register: error %d\n", rc);
542                 goto cleanup_lwt;
543         }
544
545         rc = PtlInit();
546         if (rc) {
547                 CERROR("PtlInit: error %d\n", rc);
548                 goto cleanup_deregister;
549         }
550
551         rc = insert_proc();
552         if (rc) {
553                 CERROR("insert_proc: error %d\n", rc);
554                 goto cleanup_fini;
555         }
556
557         CDEBUG (D_OTHER, "portals setup OK\n");
558         return (0);
559
560  cleanup_fini:
561         PtlFini();
562  cleanup_deregister:
563         misc_deregister(&portal_dev);
564  cleanup_lwt:
565 #if LWT_SUPPORT
566         lwt_fini();
567 #endif
568  cleanup_debug:
569         portals_debug_cleanup();
570         return rc;
571 }
572
573 static void exit_kportals_module(void)
574 {
575         int rc;
576
577         remove_proc();
578         PtlFini();
579
580         CDEBUG(D_MALLOC, "before Portals cleanup: kmem %d\n",
581                atomic_read(&portal_kmemory));
582
583
584         rc = misc_deregister(&portal_dev);
585         if (rc)
586                 CERROR("misc_deregister error %d\n", rc);
587
588 #if LWT_SUPPORT
589         lwt_fini();
590 #endif
591
592         if (atomic_read(&portal_kmemory) != 0)
593                 CERROR("Portals memory leaked: %d bytes\n",
594                        atomic_read(&portal_kmemory));
595
596         rc = portals_debug_cleanup();
597         if (rc)
598                 printk(KERN_ERR "portals_debug_cleanup: %d\n", rc);
599 }
600
601 EXPORT_SYMBOL(lib_dispatch);
602 EXPORT_SYMBOL(PtlMEAttach);
603 EXPORT_SYMBOL(PtlMEInsert);
604 EXPORT_SYMBOL(PtlMEUnlink);
605 EXPORT_SYMBOL(PtlEQAlloc);
606 EXPORT_SYMBOL(PtlMDAttach);
607 EXPORT_SYMBOL(PtlMDUnlink);
608 EXPORT_SYMBOL(PtlNIInit);
609 EXPORT_SYMBOL(PtlNIFini);
610 EXPORT_SYMBOL(PtlNIDebug);
611 EXPORT_SYMBOL(PtlInit);
612 EXPORT_SYMBOL(PtlFini);
613 EXPORT_SYMBOL(PtlPut);
614 EXPORT_SYMBOL(PtlGet);
615 EXPORT_SYMBOL(ptl_err_str);
616 EXPORT_SYMBOL(portal_subsystem_debug);
617 EXPORT_SYMBOL(portal_debug);
618 EXPORT_SYMBOL(portal_stack);
619 EXPORT_SYMBOL(portal_printk);
620 EXPORT_SYMBOL(PtlEQWait);
621 EXPORT_SYMBOL(PtlEQFree);
622 EXPORT_SYMBOL(PtlEQGet);
623 EXPORT_SYMBOL(PtlGetId);
624 EXPORT_SYMBOL(PtlMDBind);
625 EXPORT_SYMBOL(lib_iov_nob);
626 EXPORT_SYMBOL(lib_copy_iov2buf);
627 EXPORT_SYMBOL(lib_copy_buf2iov);
628 EXPORT_SYMBOL(lib_kiov_nob);
629 EXPORT_SYMBOL(lib_copy_kiov2buf);
630 EXPORT_SYMBOL(lib_copy_buf2kiov);
631 EXPORT_SYMBOL(lib_finalize);
632 EXPORT_SYMBOL(lib_parse);
633 EXPORT_SYMBOL(lib_init);
634 EXPORT_SYMBOL(lib_fini);
635 EXPORT_SYMBOL(portal_kmemory);
636 EXPORT_SYMBOL(kportal_daemonize);
637 EXPORT_SYMBOL(kportal_blockallsigs);
638 EXPORT_SYMBOL(kportal_nal_register);
639 EXPORT_SYMBOL(kportal_nal_unregister);
640 EXPORT_SYMBOL(kportal_assertion_failed);
641 EXPORT_SYMBOL(dispatch_name);
642 EXPORT_SYMBOL(kportal_get_ni);
643 EXPORT_SYMBOL(kportal_put_ni);
644
645 module_init(init_kportals_module);
646 module_exit (exit_kportals_module);