lustre/obdclass/linux/linux-module.c

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