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, 2012, Intel Corporation.
  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 #include <linux/module.h>
  47 #include <linux/errno.h>
  48 #include <linux/kernel.h>
  49 #include <linux/major.h>
  50 #include <linux/sched.h>
  51 #include <linux/lp.h>
  52 #include <linux/slab.h>
  53 #include <linux/ioport.h>
  54 #include <linux/fcntl.h>
  55 #include <linux/delay.h>
  56 #include <linux/skbuff.h>
  57 #include <linux/proc_fs.h>
  58 #include <linux/fs.h>
  59 #include <linux/poll.h>
  60 #include <linux/init.h>
  61 #include <linux/list.h>
  62 #include <linux/highmem.h>
  63 #include <asm/io.h>
  64 #include <asm/ioctls.h>
  65 #include <asm/poll.h>
  66 #include <asm/uaccess.h>
  67 #include <linux/miscdevice.h>
  68 #include <linux/seq_file.h>
  69 #else
  70 # include <liblustre.h>
  71 #endif
  72
  73 #include <libcfs/libcfs.h>
  74 #include <obd_support.h>
  75 #include <obd_class.h>
  76 #include <lnet/lnetctl.h>
  77 #include <lprocfs_status.h>
  78 #include <lustre_ver.h>
  79 #include <lustre/lustre_build_version.h>
  80 #ifdef __KERNEL__
  81
  82 int proc_version;
  83
  84 /* buffer MUST be at least the size of obd_ioctl_hdr */
  85 int obd_ioctl_getdata(char **buf, int *len, void *arg)
  86 {
  87         struct obd_ioctl_hdr hdr;
  88         struct obd_ioctl_data *data;
  89         int err;
  90         int offset = 0;
  91         ENTRY;
  92
  93         err = copy_from_user(&hdr, (void *)arg, sizeof(hdr));
  94         if ( err )
  95                 RETURN(err);
  96
  97         if (hdr.ioc_version != OBD_IOCTL_VERSION) {
  98                 CERROR("Version mismatch kernel (%x) vs application (%x)\n",
  99                        OBD_IOCTL_VERSION, hdr.ioc_version);
 100                 RETURN(-EINVAL);
 101         }
 102
 103         if (hdr.ioc_len > OBD_MAX_IOCTL_BUFFER) {
 104                 CERROR("User buffer len %d exceeds %d max buffer\n",
 105                        hdr.ioc_len, OBD_MAX_IOCTL_BUFFER);
 106                 RETURN(-EINVAL);
 107         }
 108
 109         if (hdr.ioc_len < sizeof(struct obd_ioctl_data)) {
 110                 CERROR("User buffer too small for ioctl (%d)\n", hdr.ioc_len);
 111                 RETURN(-EINVAL);
 112         }
 113
 114         /* When there are lots of processes calling vmalloc on multi-core
 115          * system, the high lock contention will hurt performance badly,
 116          * obdfilter-survey is an example, which relies on ioctl. So we'd
 117          * better avoid vmalloc on ioctl path. LU-66 */
 118         OBD_ALLOC_LARGE(*buf, hdr.ioc_len);
 119         if (*buf == NULL) {
 120                 CERROR("Cannot allocate control buffer of len %d\n",
 121                        hdr.ioc_len);
 122                 RETURN(-EINVAL);
 123         }
 124         *len = hdr.ioc_len;
 125         data = (struct obd_ioctl_data *)*buf;
 126
 127         err = copy_from_user(*buf, (void *)arg, hdr.ioc_len);
 128         if ( err ) {
 129                 OBD_FREE_LARGE(*buf, hdr.ioc_len);
 130                 RETURN(err);
 131         }
 132
 133         if (obd_ioctl_is_invalid(data)) {
 134                 CERROR("ioctl not correctly formatted\n");
 135                 OBD_FREE_LARGE(*buf, hdr.ioc_len);
 136                 RETURN(-EINVAL);
 137         }
 138
 139         if (data->ioc_inllen1) {
 140                 data->ioc_inlbuf1 = &data->ioc_bulk[0];
 141                 offset += cfs_size_round(data->ioc_inllen1);
 142         }
 143
 144         if (data->ioc_inllen2) {
 145                 data->ioc_inlbuf2 = &data->ioc_bulk[0] + offset;
 146                 offset += cfs_size_round(data->ioc_inllen2);
 147         }
 148
 149         if (data->ioc_inllen3) {
 150                 data->ioc_inlbuf3 = &data->ioc_bulk[0] + offset;
 151                 offset += cfs_size_round(data->ioc_inllen3);
 152         }
 153
 154         if (data->ioc_inllen4) {
 155                 data->ioc_inlbuf4 = &data->ioc_bulk[0] + offset;
 156         }
 157
 158         EXIT;
 159         return 0;
 160 }
 161 EXPORT_SYMBOL(obd_ioctl_getdata);
 162
 163 int obd_ioctl_popdata(void *arg, void *data, int len)
 164 {
 165         int err;
 166
 167         err = copy_to_user(arg, data, len);
 168         if (err)
 169                 err = -EFAULT;
 170         return err;
 171 }
 172 EXPORT_SYMBOL(obd_ioctl_popdata);
 173
 174 /*  opening /dev/obd */
 175 static int obd_class_open(struct inode * inode, struct file * file)
 176 {
 177         ENTRY;
 178
 179         try_module_get(THIS_MODULE);
 180         RETURN(0);
 181 }
 182
 183 /*  closing /dev/obd */
 184 static int obd_class_release(struct inode * inode, struct file * file)
 185 {
 186         ENTRY;
 187
 188         module_put(THIS_MODULE);
 189         RETURN(0);
 190 }
 191
 192 /* to control /dev/obd */
 193 static long obd_class_ioctl(struct file *filp, unsigned int cmd,
 194                             unsigned long arg)
 195 {
 196         int err = 0;
 197         ENTRY;
 198
 199         /* Allow non-root access for OBD_IOC_PING_TARGET - used by lfs check */
 200         if (!cfs_capable(CFS_CAP_SYS_ADMIN) && (cmd != OBD_IOC_PING_TARGET))
 201                 RETURN(err = -EACCES);
 202         if ((cmd & 0xffffff00) == ((int)'T') << 8) /* ignore all tty ioctls */
 203                 RETURN(err = -ENOTTY);
 204
 205         err = class_handle_ioctl(cmd, (unsigned long)arg);
 206
 207         RETURN(err);
 208 }
 209
 210 /* declare character device */
 211 static struct file_operations obd_psdev_fops = {
 212         .owner          = THIS_MODULE,
 213         .unlocked_ioctl = obd_class_ioctl, /* unlocked_ioctl */
 214         .open           = obd_class_open,      /* open */
 215         .release        = obd_class_release,   /* release */
 216 };
 217
 218 /* modules setup */
 219 struct miscdevice obd_psdev = {
 220         .minor = OBD_DEV_MINOR,
 221         .name  = OBD_DEV_NAME,
 222         .fops  = &obd_psdev_fops,
 223 };
 224
 225 #endif
 226
 227 #ifdef LPROCFS
 228 static int obd_proc_version_seq_show(struct seq_file *m, void *v)
 229 {
 230         return seq_printf(m, "lustre: %s\nkernel: %s\nbuild:  %s\n",
 231                           LUSTRE_VERSION_STRING, "patchless_client",
 232                           BUILD_VERSION);
 233 }
 234 LPROC_SEQ_FOPS_RO(obd_proc_version);
 235
 236 static int obd_proc_pinger_seq_show(struct seq_file *m, void *v)
 237 {
 238         return seq_printf(m, "%s\n",
 239 #ifdef ENABLE_PINGER
 240                              "on"
 241 #else
 242                              "off"
 243 #endif
 244                          );
 245 }
 246 LPROC_SEQ_FOPS_RO(obd_proc_pinger);
 247
 248 /**
 249  * Check all obd devices health
 250  *
 251  * \param seq_file
 252  * \param data [in] unused
 253  *
 254  * \retval number of characters printed if healthy
 255  */
 256 static int obd_proc_health_seq_show(struct seq_file *m, void *data)
 257 {
 258         bool healthy = true;
 259         int i;
 260
 261         if (libcfs_catastrophe)
 262                 seq_printf(m, "LBUG\n");
 263
 264         read_lock(&obd_dev_lock);
 265         for (i = 0; i < class_devno_max(); i++) {
 266                 struct obd_device *obd;
 267
 268                 obd = class_num2obd(i);
 269                 if (obd == NULL || !obd->obd_attached || !obd->obd_set_up)
 270                         continue;
 271
 272                 LASSERT(obd->obd_magic == OBD_DEVICE_MAGIC);
 273                 if (obd->obd_stopping)
 274                         continue;
 275
 276                 class_incref(obd, __FUNCTION__, current);
 277                 read_unlock(&obd_dev_lock);
 278
 279                 if (obd_health_check(NULL, obd)) {
 280                         seq_printf(m, "device %s reported unhealthy\n",
 281                                         obd->obd_name);
 282                         healthy = false;
 283                 }
 284                 class_decref(obd, __FUNCTION__, current);
 285                 read_lock(&obd_dev_lock);
 286         }
 287         read_unlock(&obd_dev_lock);
 288
 289         if (healthy)
 290                 return seq_printf(m, "healthy\n");
 291
 292         seq_printf(m, "NOT HEALTHY\n");
 293         return 0;
 294 }
 295 LPROC_SEQ_FOPS_RO(obd_proc_health);
 296
 297 static int obd_proc_jobid_var_seq_show(struct seq_file *m, void *v)
 298 {
 299         return seq_printf(m, "%s\n", obd_jobid_var);
 300 }
 301
 302 static ssize_t
 303 obd_proc_jobid_var_seq_write(struct file *file, const char *buffer,
 304                                 size_t count, loff_t *off)
 305 {
 306         if (!count || count > JOBSTATS_JOBID_VAR_MAX_LEN)
 307                 return -EINVAL;
 308
 309         memset(obd_jobid_var, 0, JOBSTATS_JOBID_VAR_MAX_LEN + 1);
 310         /* Trim the trailing '\n' if any */
 311         memcpy(obd_jobid_var, buffer, count - (buffer[count - 1] == '\n'));
 312         return count;
 313 }
 314 LPROC_SEQ_FOPS(obd_proc_jobid_var);
 315
 316 /* Root for /proc/fs/lustre */
 317 struct proc_dir_entry *proc_lustre_root = NULL;
 318 EXPORT_SYMBOL(proc_lustre_root);
 319
 320 struct lprocfs_seq_vars lprocfs_base[] = {
 321         { .name =       "version",
 322           .fops =       &obd_proc_version_fops  },
 323         { .name =       "pinger",
 324           .fops =       &obd_proc_pinger_fops   },
 325         { .name =       "health_check",
 326           .fops =       &obd_proc_health_fops   },
 327         { .name =       "jobid_var",
 328           .fops =       &obd_proc_jobid_var_fops},
 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 seq_file *seq;
 394         int rc = seq_open(file, &obd_device_list_sops);
 395
 396         if (rc)
 397                 return rc;
 398
 399         seq = file->private_data;
 400         seq->private = PDE_DATA(inode);
 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_seq_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 #endif