Whamcloud - gitweb
add 2.6.27 kernel support
[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 <lprocfs_status.h>
85 #include <lustre_ver.h>
86 #include <lustre/lustre_build_version.h>
87 #ifdef __KERNEL__
88 #include <linux/lustre_version.h>
89
90 int proc_version;
91
92 /* buffer MUST be at least the size of obd_ioctl_hdr */
93 int obd_ioctl_getdata(char **buf, int *len, void *arg)
94 {
95         struct obd_ioctl_hdr hdr;
96         struct obd_ioctl_data *data;
97         int err;
98         int offset = 0;
99         ENTRY;
100
101         err = copy_from_user(&hdr, (void *)arg, sizeof(hdr));
102         if ( err )
103                 RETURN(err);
104
105         if (hdr.ioc_version != OBD_IOCTL_VERSION) {
106                 CERROR("Version mismatch kernel (%x) vs application (%x)\n",
107                        OBD_IOCTL_VERSION, hdr.ioc_version);
108                 RETURN(-EINVAL);
109         }
110
111         if (hdr.ioc_len > OBD_MAX_IOCTL_BUFFER) {
112                 CERROR("User buffer len %d exceeds %d max buffer\n",
113                        hdr.ioc_len, OBD_MAX_IOCTL_BUFFER);
114                 RETURN(-EINVAL);
115         }
116
117         if (hdr.ioc_len < sizeof(struct obd_ioctl_data)) {
118                 CERROR("User buffer too small for ioctl (%d)\n", hdr.ioc_len);
119                 RETURN(-EINVAL);
120         }
121
122         /* XXX allocate this more intelligently, using kmalloc when
123          * appropriate */
124         OBD_VMALLOC(*buf, hdr.ioc_len);
125         if (*buf == NULL) {
126                 CERROR("Cannot allocate control buffer of len %d\n",
127                        hdr.ioc_len);
128                 RETURN(-EINVAL);
129         }
130         *len = hdr.ioc_len;
131         data = (struct obd_ioctl_data *)*buf;
132
133         err = copy_from_user(*buf, (void *)arg, hdr.ioc_len);
134         if ( err ) {
135                 OBD_VFREE(*buf, hdr.ioc_len);
136                 RETURN(err);
137         }
138
139         if (obd_ioctl_is_invalid(data)) {
140                 CERROR("ioctl not correctly formatted\n");
141                 OBD_VFREE(*buf, hdr.ioc_len);
142                 RETURN(-EINVAL);
143         }
144
145         if (data->ioc_inllen1) {
146                 data->ioc_inlbuf1 = &data->ioc_bulk[0];
147                 offset += size_round(data->ioc_inllen1);
148         }
149
150         if (data->ioc_inllen2) {
151                 data->ioc_inlbuf2 = &data->ioc_bulk[0] + offset;
152                 offset += size_round(data->ioc_inllen2);
153         }
154
155         if (data->ioc_inllen3) {
156                 data->ioc_inlbuf3 = &data->ioc_bulk[0] + offset;
157                 offset += size_round(data->ioc_inllen3);
158         }
159
160         if (data->ioc_inllen4) {
161                 data->ioc_inlbuf4 = &data->ioc_bulk[0] + offset;
162         }
163
164         EXIT;
165         return 0;
166 }
167
168 int obd_ioctl_popdata(void *arg, void *data, int len)
169 {
170         int err;
171
172         err = copy_to_user(arg, data, len);
173         if (err)
174                 err = -EFAULT;
175         return err;
176 }
177
178 EXPORT_SYMBOL(obd_ioctl_getdata);
179 EXPORT_SYMBOL(obd_ioctl_popdata);
180
181 #define OBD_MINOR 241
182 extern struct cfs_psdev_ops          obd_psdev_ops;
183
184 /*  opening /dev/obd */
185 static int obd_class_open(struct inode * inode, struct file * file)
186 {
187         if (obd_psdev_ops.p_open != NULL)
188                 return obd_psdev_ops.p_open(0, NULL);
189         return -EPERM;
190 }
191
192 /*  closing /dev/obd */
193 static int obd_class_release(struct inode * inode, struct file * file)
194 {
195         if (obd_psdev_ops.p_close != NULL)
196                 return obd_psdev_ops.p_close(0, NULL);
197         return -EPERM;
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         if (current->fsuid != 0)
208                 RETURN(err = -EACCES);
209         if ((cmd & 0xffffff00) == ((int)'T') << 8) /* ignore all tty ioctls */
210                 RETURN(err = -ENOTTY);
211
212         if (obd_psdev_ops.p_ioctl != NULL)
213                 err = obd_psdev_ops.p_ioctl(NULL, cmd, (void *)arg);
214         else
215                 err = -EPERM;
216
217         RETURN(err);
218 }
219
220 /* declare character device */
221 static struct file_operations obd_psdev_fops = {
222         .owner   = THIS_MODULE,
223         .ioctl   = obd_class_ioctl,     /* ioctl */
224         .open    = obd_class_open,      /* open */
225         .release = obd_class_release,   /* release */
226 };
227
228 /* modules setup */
229 cfs_psdev_t obd_psdev = {
230         .minor = OBD_MINOR,
231         .name  = "obd_psdev",
232         .fops  = &obd_psdev_fops,
233 };
234
235 #endif
236
237 #ifdef LPROCFS
238 int obd_proc_read_version(char *page, char **start, off_t off, int count,
239                           int *eof, void *data)
240 {
241         *eof = 1;
242 #ifdef HAVE_VFS_INTENT_PATCHES
243         return snprintf(page, count, "lustre: %s\nkernel: %u\nbuild:  %s\n",
244                         LUSTRE_VERSION_STRING, LUSTRE_KERNEL_VERSION,
245                         BUILD_VERSION);
246 #else
247         return snprintf(page, count, "lustre: %s\nkernel: %s\nbuild:  %s\n",
248                         LUSTRE_VERSION_STRING, "patchless_client",
249                         BUILD_VERSION);
250 #endif
251 }
252
253 int obd_proc_read_pinger(char *page, char **start, off_t off, int count,
254                          int *eof, void *data)
255 {
256         *eof = 1;
257         return snprintf(page, count, "%s\n",
258 #ifdef ENABLE_PINGER
259                         "on"
260 #else
261                         "off"
262 #endif
263                        );
264 }
265
266 /**
267  * Check all obd devices health
268  *
269  * \param page
270  * \param start
271  * \param off
272  * \param count
273  * \param eof
274  * \param data
275  *                  proc read function parameters, please refer to kernel
276  *                  code fs/proc/generic.c proc_file_read()
277  * \param data [in] unused
278  *
279  * \retval number of characters printed
280  */
281 static int obd_proc_read_health(char *page, char **start, off_t off,
282                                 int count, int *eof, void *data)
283 {
284         int rc = 0, i;
285         *eof = 1;
286
287         if (libcfs_catastrophe)
288                 rc += snprintf(page + rc, count - rc, "LBUG\n");
289
290         spin_lock(&obd_dev_lock);
291         for (i = 0; i < class_devno_max(); i++) {
292                 struct obd_device *obd;
293
294                 obd = class_num2obd(i);
295                 if (obd == NULL || !obd->obd_attached || !obd->obd_set_up)
296                         continue;
297
298                 LASSERT(obd->obd_magic == OBD_DEVICE_MAGIC);
299                 if (obd->obd_stopping)
300                         continue;
301
302                 class_incref(obd, __FUNCTION__, cfs_current());
303                 spin_unlock(&obd_dev_lock);
304
305                 if (obd_health_check(obd)) {
306                         rc += snprintf(page + rc, count - rc,
307                                        "device %s reported unhealthy\n",
308                                        obd->obd_name);
309                 }
310                 class_decref(obd, __FUNCTION__, cfs_current());
311                 spin_lock(&obd_dev_lock);
312         }
313         spin_unlock(&obd_dev_lock);
314
315         if (rc == 0)
316                 return snprintf(page, count, "healthy\n");
317
318         rc += snprintf(page + rc, count - rc, "NOT HEALTHY\n");
319         return rc;
320 }
321
322 /* Root for /proc/fs/lustre */
323 struct proc_dir_entry *proc_lustre_root = NULL;
324
325 struct lprocfs_vars lprocfs_base[] = {
326         { "version", obd_proc_read_version, NULL, NULL },
327         { "pinger", obd_proc_read_pinger, NULL, NULL },
328         { "health_check", obd_proc_read_health, NULL, NULL },
329         { 0 }
330 };
331 #else
332 #define lprocfs_base NULL
333 #endif /* LPROCFS */
334
335 #ifdef __KERNEL__
336 static void *obd_device_list_seq_start(struct seq_file *p, loff_t *pos)
337 {
338         if (*pos >= class_devno_max())
339                 return NULL;
340
341         return pos;
342 }
343
344 static void obd_device_list_seq_stop(struct seq_file *p, void *v)
345 {
346 }
347
348 static void *obd_device_list_seq_next(struct seq_file *p, void *v, loff_t *pos)
349 {
350         ++*pos;
351         if (*pos >= class_devno_max())
352                 return NULL;
353
354         return pos;
355 }
356
357 static int obd_device_list_seq_show(struct seq_file *p, void *v)
358 {
359         loff_t index = *(loff_t *)v;
360         struct obd_device *obd = class_num2obd((int)index);
361         char *status;
362
363         if (obd == NULL)
364                 return 0;
365
366         LASSERT(obd->obd_magic == OBD_DEVICE_MAGIC);
367         if (obd->obd_stopping)
368                 status = "ST";
369         else if (obd->obd_inactive)
370                 status = "IN";
371         else if (obd->obd_set_up)
372                 status = "UP";
373         else if (obd->obd_attached)
374                 status = "AT";
375         else
376                 status = "--";
377
378         return seq_printf(p, "%3d %s %s %s %s %d\n",
379                           (int)index, status, obd->obd_type->typ_name,
380                           obd->obd_name, obd->obd_uuid.uuid,
381                           atomic_read(&obd->obd_refcount));
382 }
383
384 struct seq_operations obd_device_list_sops = {
385         .start = obd_device_list_seq_start,
386         .stop = obd_device_list_seq_stop,
387         .next = obd_device_list_seq_next,
388         .show = obd_device_list_seq_show,
389 };
390
391 static int obd_device_list_open(struct inode *inode, struct file *file)
392 {
393         struct proc_dir_entry *dp = PDE(inode);
394         struct seq_file *seq;
395         int rc = seq_open(file, &obd_device_list_sops);
396
397         if (rc)
398                 return rc;
399
400         seq = file->private_data;
401         seq->private = dp->data;
402
403         return 0;
404 }
405
406 struct file_operations obd_device_list_fops = {
407         .owner   = THIS_MODULE,
408         .open    = obd_device_list_open,
409         .read    = seq_read,
410         .llseek  = seq_lseek,
411         .release = seq_release,
412 };
413 #endif
414
415 int class_procfs_init(void)
416 {
417 #ifdef __KERNEL__
418         int rc;
419         ENTRY;
420
421         obd_sysctl_init();
422         proc_lustre_root = lprocfs_register("fs/lustre", NULL,
423                                             lprocfs_base, NULL);
424         rc = lprocfs_seq_create(proc_lustre_root, "devices", 0444,
425                                 &obd_device_list_fops, NULL);
426         if (rc)
427                 CERROR("error adding /proc/fs/lustre/devices file\n");
428 #else
429         ENTRY;
430 #endif
431         RETURN(0);
432 }
433
434 #ifdef __KERNEL__
435 int class_procfs_clean(void)
436 {
437         ENTRY;
438         if (proc_lustre_root) {
439                 lprocfs_remove(&proc_lustre_root);
440         }
441         RETURN(0);
442 }
443
444
445 /* Check that we're building against the appropriate version of the Lustre
446  * kernel patch */
447 #include <linux/lustre_version.h>
448 #ifdef LUSTRE_KERNEL_VERSION
449 #define LUSTRE_MIN_VERSION 45
450 #define LUSTRE_MAX_VERSION 47
451 #if (LUSTRE_KERNEL_VERSION < LUSTRE_MIN_VERSION)
452 # error Cannot continue: Your Lustre kernel patch is older than the sources
453 #elif (LUSTRE_KERNEL_VERSION > LUSTRE_MAX_VERSION)
454 # error Cannot continue: Your Lustre sources are older than the kernel patch
455 #endif
456 #endif
457 #endif