Whamcloud - gitweb
b=21259 "lfs check" is only allowed for root.
[fs/lustre-release.git] / lustre / obdclass / linux / linux-module.c
1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
2  * vim:expandtab:shiftwidth=8:tabstop=8:
3  *
4  * GPL HEADER START
5  *
6  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
7  *
8  * This program is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License version 2 only,
10  * as published by the Free Software Foundation.
11  *
12  * This program is distributed in the hope that it will be useful, but
13  * WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * General Public License version 2 for more details (a copy is included
16  * in the LICENSE file that accompanied this code).
17  *
18  * You should have received a copy of the GNU General Public License
19  * version 2 along with this program; If not, see
20  * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
21  *
22  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
23  * CA 95054 USA or visit www.sun.com if you need additional information or
24  * have any questions.
25  *
26  * GPL HEADER END
27  */
28 /*
29  * Copyright  2008 Sun Microsystems, Inc. All rights reserved
30  * Use is subject to license terms.
31  */
32 /*
33  * This file is part of Lustre, http://www.lustre.org/
34  * Lustre is a trademark of Sun Microsystems, Inc.
35  *
36  * lustre/obdclass/linux/linux-module.c
37  *
38  * Object Devices Class Driver
39  * These are the only exported functions, they provide some generic
40  * infrastructure for managing object devices
41  */
42
43 #define DEBUG_SUBSYSTEM S_CLASS
44 #ifndef EXPORT_SYMTAB
45 # define EXPORT_SYMTAB
46 #endif
47
48 #ifdef __KERNEL__
49 #ifndef AUTOCONF_INCLUDED
50 #include <linux/config.h> /* for CONFIG_PROC_FS */
51 #endif
52 #include <linux/module.h>
53 #include <linux/errno.h>
54 #include <linux/kernel.h>
55 #include <linux/major.h>
56 #include <linux/sched.h>
57 #include <linux/lp.h>
58 #include <linux/slab.h>
59 #include <linux/ioport.h>
60 #include <linux/fcntl.h>
61 #include <linux/delay.h>
62 #include <linux/skbuff.h>
63 #include <linux/proc_fs.h>
64 #include <linux/fs.h>
65 #include <linux/poll.h>
66 #include <linux/init.h>
67 #include <linux/list.h>
68 #include <linux/highmem.h>
69 #include <asm/io.h>
70 #include <asm/ioctls.h>
71 #include <asm/system.h>
72 #include <asm/poll.h>
73 #include <asm/uaccess.h>
74 #include <linux/miscdevice.h>
75 #include <linux/smp_lock.h>
76 #include <linux/seq_file.h>
77 #else
78 # include <liblustre.h>
79 #endif
80
81 #include <libcfs/libcfs.h>
82 #include <obd_support.h>
83 #include <obd_class.h>
84 #include <lnet/lnetctl.h>
85 #include <lprocfs_status.h>
86 #include <lustre_ver.h>
87 #include <lustre/lustre_build_version.h>
88 #ifdef __KERNEL__
89 #include <linux/lustre_version.h>
90
91 int proc_version;
92
93 /* buffer MUST be at least the size of obd_ioctl_hdr */
94 int obd_ioctl_getdata(char **buf, int *len, void *arg)
95 {
96         struct obd_ioctl_hdr hdr;
97         struct obd_ioctl_data *data;
98         int err;
99         int offset = 0;
100         ENTRY;
101
102         err = cfs_copy_from_user(&hdr, (void *)arg, sizeof(hdr));
103         if ( err )
104                 RETURN(err);
105
106         if (hdr.ioc_version != OBD_IOCTL_VERSION) {
107                 CERROR("Version mismatch kernel (%x) vs application (%x)\n",
108                        OBD_IOCTL_VERSION, hdr.ioc_version);
109                 RETURN(-EINVAL);
110         }
111
112         if (hdr.ioc_len > OBD_MAX_IOCTL_BUFFER) {
113                 CERROR("User buffer len %d exceeds %d max buffer\n",
114                        hdr.ioc_len, OBD_MAX_IOCTL_BUFFER);
115                 RETURN(-EINVAL);
116         }
117
118         if (hdr.ioc_len < sizeof(struct obd_ioctl_data)) {
119                 CERROR("User buffer too small for ioctl (%d)\n", hdr.ioc_len);
120                 RETURN(-EINVAL);
121         }
122
123         /* XXX allocate this more intelligently, using kmalloc when
124          * appropriate */
125         OBD_VMALLOC(*buf, hdr.ioc_len);
126         if (*buf == NULL) {
127                 CERROR("Cannot allocate control buffer of len %d\n",
128                        hdr.ioc_len);
129                 RETURN(-EINVAL);
130         }
131         *len = hdr.ioc_len;
132         data = (struct obd_ioctl_data *)*buf;
133
134         err = cfs_copy_from_user(*buf, (void *)arg, hdr.ioc_len);
135         if ( err ) {
136                 OBD_VFREE(*buf, hdr.ioc_len);
137                 RETURN(err);
138         }
139
140         if (obd_ioctl_is_invalid(data)) {
141                 CERROR("ioctl not correctly formatted\n");
142                 OBD_VFREE(*buf, hdr.ioc_len);
143                 RETURN(-EINVAL);
144         }
145
146         if (data->ioc_inllen1) {
147                 data->ioc_inlbuf1 = &data->ioc_bulk[0];
148                 offset += cfs_size_round(data->ioc_inllen1);
149         }
150
151         if (data->ioc_inllen2) {
152                 data->ioc_inlbuf2 = &data->ioc_bulk[0] + offset;
153                 offset += cfs_size_round(data->ioc_inllen2);
154         }
155
156         if (data->ioc_inllen3) {
157                 data->ioc_inlbuf3 = &data->ioc_bulk[0] + offset;
158                 offset += cfs_size_round(data->ioc_inllen3);
159         }
160
161         if (data->ioc_inllen4) {
162                 data->ioc_inlbuf4 = &data->ioc_bulk[0] + offset;
163         }
164
165         EXIT;
166         return 0;
167 }
168
169 int obd_ioctl_popdata(void *arg, void *data, int len)
170 {
171         int err;
172
173         err = cfs_copy_to_user(arg, data, len);
174         if (err)
175                 err = -EFAULT;
176         return err;
177 }
178
179 EXPORT_SYMBOL(obd_ioctl_getdata);
180 EXPORT_SYMBOL(obd_ioctl_popdata);
181
182 /*  opening /dev/obd */
183 static int obd_class_open(struct inode * inode, struct file * file)
184 {
185         ENTRY;
186
187         PORTAL_MODULE_USE;
188         RETURN(0);
189 }
190
191 /*  closing /dev/obd */
192 static int obd_class_release(struct inode * inode, struct file * file)
193 {
194         ENTRY;
195
196         PORTAL_MODULE_UNUSE;
197         RETURN(0);
198 }
199
200 /* to control /dev/obd */
201 static int obd_class_ioctl(struct inode *inode, struct file *filp,
202                            unsigned int cmd, unsigned long arg)
203 {
204         int err = 0;
205         ENTRY;
206
207         /* Allow non-root access for OBD_IOC_PING_TARGET - used by lfs check */
208         if (!cfs_capable(CFS_CAP_SYS_ADMIN) && (cmd != OBD_IOC_PING_TARGET))
209                 RETURN(err = -EACCES);
210         if ((cmd & 0xffffff00) == ((int)'T') << 8) /* ignore all tty ioctls */
211                 RETURN(err = -ENOTTY);
212
213         err = class_handle_ioctl(cmd, (unsigned long)arg);
214
215         RETURN(err);
216 }
217
218 /* declare character device */
219 static struct file_operations obd_psdev_fops = {
220         .owner   = THIS_MODULE,
221         .ioctl   = obd_class_ioctl,     /* ioctl */
222         .open    = obd_class_open,      /* open */
223         .release = obd_class_release,   /* release */
224 };
225
226 /* modules setup */
227 cfs_psdev_t obd_psdev = {
228         .minor = OBD_DEV_MINOR,
229         .name  = OBD_DEV_NAME,
230         .fops  = &obd_psdev_fops,
231 };
232
233 #endif
234
235 #ifdef LPROCFS
236 int obd_proc_read_version(char *page, char **start, off_t off, int count,
237                           int *eof, void *data)
238 {
239         *eof = 1;
240 #ifdef HAVE_VFS_INTENT_PATCHES
241         return snprintf(page, count, "lustre: %s\nkernel: %u\nbuild:  %s\n",
242                         LUSTRE_VERSION_STRING, LUSTRE_KERNEL_VERSION,
243                         BUILD_VERSION);
244 #else
245         return snprintf(page, count, "lustre: %s\nkernel: %s\nbuild:  %s\n",
246                         LUSTRE_VERSION_STRING, "patchless_client",
247                         BUILD_VERSION);
248 #endif
249 }
250
251 int obd_proc_read_pinger(char *page, char **start, off_t off, int count,
252                          int *eof, void *data)
253 {
254         *eof = 1;
255         return snprintf(page, count, "%s\n",
256 #ifdef ENABLE_PINGER
257                         "on"
258 #else
259                         "off"
260 #endif
261                        );
262 }
263
264 /**
265  * Check all obd devices health
266  *
267  * \param page
268  * \param start
269  * \param off
270  * \param count
271  * \param eof
272  * \param data
273  *                  proc read function parameters, please refer to kernel
274  *                  code fs/proc/generic.c proc_file_read()
275  * \param data [in] unused
276  *
277  * \retval number of characters printed
278  */
279 static int obd_proc_read_health(char *page, char **start, off_t off,
280                                 int count, int *eof, void *data)
281 {
282         int rc = 0, i;
283         *eof = 1;
284
285         if (libcfs_catastrophe)
286                 rc += snprintf(page + rc, count - rc, "LBUG\n");
287
288         cfs_spin_lock(&obd_dev_lock);
289         for (i = 0; i < class_devno_max(); i++) {
290                 struct obd_device *obd;
291
292                 obd = class_num2obd(i);
293                 if (obd == NULL || !obd->obd_attached || !obd->obd_set_up)
294                         continue;
295
296                 LASSERT(obd->obd_magic == OBD_DEVICE_MAGIC);
297                 if (obd->obd_stopping)
298                         continue;
299
300                 class_incref(obd, __FUNCTION__, cfs_current());
301                 cfs_spin_unlock(&obd_dev_lock);
302
303                 if (obd_health_check(obd)) {
304                         rc += snprintf(page + rc, count - rc,
305                                        "device %s reported unhealthy\n",
306                                        obd->obd_name);
307                 }
308                 class_decref(obd, __FUNCTION__, cfs_current());
309                 cfs_spin_lock(&obd_dev_lock);
310         }
311         cfs_spin_unlock(&obd_dev_lock);
312
313         if (rc == 0)
314                 return snprintf(page, count, "healthy\n");
315
316         rc += snprintf(page + rc, count - rc, "NOT HEALTHY\n");
317         return rc;
318 }
319
320 /* Root for /proc/fs/lustre */
321 struct proc_dir_entry *proc_lustre_root = NULL;
322
323 struct lprocfs_vars lprocfs_base[] = {
324         { "version", obd_proc_read_version, NULL, NULL },
325         { "pinger", obd_proc_read_pinger, NULL, NULL },
326         { "health_check", obd_proc_read_health, NULL, NULL },
327         { 0 }
328 };
329 #else
330 #define lprocfs_base NULL
331 #endif /* LPROCFS */
332
333 #ifdef __KERNEL__
334 static void *obd_device_list_seq_start(struct seq_file *p, loff_t *pos)
335 {
336         if (*pos >= class_devno_max())
337                 return NULL;
338
339         return pos;
340 }
341
342 static void obd_device_list_seq_stop(struct seq_file *p, void *v)
343 {
344 }
345
346 static void *obd_device_list_seq_next(struct seq_file *p, void *v, loff_t *pos)
347 {
348         ++*pos;
349         if (*pos >= class_devno_max())
350                 return NULL;
351
352         return pos;
353 }
354
355 static int obd_device_list_seq_show(struct seq_file *p, void *v)
356 {
357         loff_t index = *(loff_t *)v;
358         struct obd_device *obd = class_num2obd((int)index);
359         char *status;
360
361         if (obd == NULL)
362                 return 0;
363
364         LASSERT(obd->obd_magic == OBD_DEVICE_MAGIC);
365         if (obd->obd_stopping)
366                 status = "ST";
367         else if (obd->obd_inactive)
368                 status = "IN";
369         else if (obd->obd_set_up)
370                 status = "UP";
371         else if (obd->obd_attached)
372                 status = "AT";
373         else
374                 status = "--";
375
376         return seq_printf(p, "%3d %s %s %s %s %d\n",
377                           (int)index, status, obd->obd_type->typ_name,
378                           obd->obd_name, obd->obd_uuid.uuid,
379                           cfs_atomic_read(&obd->obd_refcount));
380 }
381
382 struct seq_operations obd_device_list_sops = {
383         .start = obd_device_list_seq_start,
384         .stop = obd_device_list_seq_stop,
385         .next = obd_device_list_seq_next,
386         .show = obd_device_list_seq_show,
387 };
388
389 static int obd_device_list_open(struct inode *inode, struct file *file)
390 {
391         struct proc_dir_entry *dp = PDE(inode);
392         struct seq_file *seq;
393         int rc = seq_open(file, &obd_device_list_sops);
394
395         if (rc)
396                 return rc;
397
398         seq = file->private_data;
399         seq->private = dp->data;
400
401         return 0;
402 }
403
404 struct file_operations obd_device_list_fops = {
405         .owner   = THIS_MODULE,
406         .open    = obd_device_list_open,
407         .read    = seq_read,
408         .llseek  = seq_lseek,
409         .release = seq_release,
410 };
411 #endif
412
413 int class_procfs_init(void)
414 {
415 #ifdef __KERNEL__
416         int rc;
417         ENTRY;
418
419         obd_sysctl_init();
420         proc_lustre_root = lprocfs_register("fs/lustre", NULL,
421                                             lprocfs_base, NULL);
422         rc = lprocfs_seq_create(proc_lustre_root, "devices", 0444,
423                                 &obd_device_list_fops, NULL);
424         if (rc)
425                 CERROR("error adding /proc/fs/lustre/devices file\n");
426 #else
427         ENTRY;
428 #endif
429         RETURN(0);
430 }
431
432 #ifdef __KERNEL__
433 int class_procfs_clean(void)
434 {
435         ENTRY;
436         if (proc_lustre_root) {
437                 lprocfs_remove(&proc_lustre_root);
438         }
439         RETURN(0);
440 }
441
442
443 /* Check that we're building against the appropriate version of the Lustre
444  * kernel patch */
445 #include <linux/lustre_version.h>
446 #ifdef LUSTRE_KERNEL_VERSION
447 #define LUSTRE_MIN_VERSION 45
448 #define LUSTRE_MAX_VERSION 47
449 #if (LUSTRE_KERNEL_VERSION < LUSTRE_MIN_VERSION)
450 # error Cannot continue: Your Lustre kernel patch is older than the sources
451 #elif (LUSTRE_KERNEL_VERSION > LUSTRE_MAX_VERSION)
452 # error Cannot continue: Your Lustre sources are older than the kernel patch
453 #endif
454 #endif
455 #endif