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, 2014, 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 #include <linux/module.h>
  46 #include <linux/errno.h>
  47 #include <linux/kernel.h>
  48 #include <linux/major.h>
  49 #include <linux/sched.h>
  50 #include <linux/lp.h>
  51 #include <linux/slab.h>
  52 #include <linux/ioport.h>
  53 #include <linux/fcntl.h>
  54 #include <linux/delay.h>
  55 #include <linux/skbuff.h>
  56 #include <linux/proc_fs.h>
  57 #include <linux/fs.h>
  58 #include <linux/poll.h>
  59 #include <linux/init.h>
  60 #include <linux/list.h>
  61 #include <linux/highmem.h>
  62 #include <asm/io.h>
  63 #include <asm/ioctls.h>
  64 #include <asm/poll.h>
  65 #include <asm/uaccess.h>
  66 #include <linux/miscdevice.h>
  67 #include <linux/seq_file.h>
  68
  69 #include <libcfs/libcfs.h>
  70 #include <obd_support.h>
  71 #include <obd_class.h>
  72 #include <lnet/lnetctl.h>
  73 #include <lprocfs_status.h>
  74 #include <lustre_ioctl.h>
  75 #include <lustre_ver.h>
  76 #include <lustre/lustre_build_version.h>
  77
  78 int proc_version;
  79
  80 /* buffer MUST be at least the size of obd_ioctl_hdr */
  81 int obd_ioctl_getdata(char **buf, int *len, void __user *arg)
  82 {
  83         struct obd_ioctl_hdr hdr;
  84         struct obd_ioctl_data *data;
  85         int offset = 0;
  86         ENTRY;
  87
  88         if (copy_from_user(&hdr, arg, sizeof(hdr)))
  89                 RETURN(-EFAULT);
  90
  91         if (hdr.ioc_version != OBD_IOCTL_VERSION) {
  92                 CERROR("Version mismatch kernel (%x) vs application (%x)\n",
  93                        OBD_IOCTL_VERSION, hdr.ioc_version);
  94                 RETURN(-EINVAL);
  95         }
  96
  97         if (hdr.ioc_len > OBD_MAX_IOCTL_BUFFER) {
  98                 CERROR("User buffer len %d exceeds %d max buffer\n",
  99                        hdr.ioc_len, OBD_MAX_IOCTL_BUFFER);
 100                 RETURN(-EINVAL);
 101         }
 102
 103         if (hdr.ioc_len < sizeof(struct obd_ioctl_data)) {
 104                 CERROR("User buffer too small for ioctl (%d)\n", hdr.ioc_len);
 105                 RETURN(-EINVAL);
 106         }
 107
 108         /* When there are lots of processes calling vmalloc on multi-core
 109          * system, the high lock contention will hurt performance badly,
 110          * obdfilter-survey is an example, which relies on ioctl. So we'd
 111          * better avoid vmalloc on ioctl path. LU-66 */
 112         OBD_ALLOC_LARGE(*buf, hdr.ioc_len);
 113         if (*buf == NULL) {
 114                 CERROR("Cannot allocate control buffer of len %d\n",
 115                        hdr.ioc_len);
 116                 RETURN(-EINVAL);
 117         }
 118         *len = hdr.ioc_len;
 119         data = (struct obd_ioctl_data *)*buf;
 120
 121         if (copy_from_user(*buf, arg, hdr.ioc_len)) {
 122                 OBD_FREE_LARGE(*buf, hdr.ioc_len);
 123                 RETURN(-EFAULT);
 124         }
 125
 126         if (obd_ioctl_is_invalid(data)) {
 127                 CERROR("ioctl not correctly formatted\n");
 128                 OBD_FREE_LARGE(*buf, hdr.ioc_len);
 129                 RETURN(-EINVAL);
 130         }
 131
 132         if (data->ioc_inllen1) {
 133                 data->ioc_inlbuf1 = &data->ioc_bulk[0];
 134                 offset += cfs_size_round(data->ioc_inllen1);
 135         }
 136
 137         if (data->ioc_inllen2) {
 138                 data->ioc_inlbuf2 = &data->ioc_bulk[0] + offset;
 139                 offset += cfs_size_round(data->ioc_inllen2);
 140         }
 141
 142         if (data->ioc_inllen3) {
 143                 data->ioc_inlbuf3 = &data->ioc_bulk[0] + offset;
 144                 offset += cfs_size_round(data->ioc_inllen3);
 145         }
 146
 147         if (data->ioc_inllen4)
 148                 data->ioc_inlbuf4 = &data->ioc_bulk[0] + offset;
 149
 150         RETURN(0);
 151 }
 152 EXPORT_SYMBOL(obd_ioctl_getdata);
 153
 154 int obd_ioctl_popdata(void __user *arg, void *data, int len)
 155 {
 156         int err;
 157         ENTRY;
 158
 159         err = copy_to_user(arg, data, len) ? -EFAULT : 0;
 160         RETURN(err);
 161 }
 162
 163 /*  opening /dev/obd */
 164 static int obd_class_open(struct inode * inode, struct file * file)
 165 {
 166         ENTRY;
 167
 168         try_module_get(THIS_MODULE);
 169         RETURN(0);
 170 }
 171
 172 /*  closing /dev/obd */
 173 static int obd_class_release(struct inode * inode, struct file * file)
 174 {
 175         ENTRY;
 176
 177         module_put(THIS_MODULE);
 178         RETURN(0);
 179 }
 180
 181 /* to control /dev/obd */
 182 static long obd_class_ioctl(struct file *filp, unsigned int cmd,
 183                             unsigned long arg)
 184 {
 185         int err = 0;
 186         ENTRY;
 187
 188         /* Allow non-root access for OBD_IOC_PING_TARGET - used by lfs check */
 189         if (!cfs_capable(CFS_CAP_SYS_ADMIN) && (cmd != OBD_IOC_PING_TARGET))
 190                 RETURN(err = -EACCES);
 191         if ((cmd & 0xffffff00) == ((int)'T') << 8) /* ignore all tty ioctls */
 192                 RETURN(err = -ENOTTY);
 193
 194         err = class_handle_ioctl(cmd, (unsigned long)arg);
 195
 196         RETURN(err);
 197 }
 198
 199 /* declare character device */
 200 static struct file_operations obd_psdev_fops = {
 201         .owner          = THIS_MODULE,
 202         .unlocked_ioctl = obd_class_ioctl, /* unlocked_ioctl */
 203         .open           = obd_class_open,      /* open */
 204         .release        = obd_class_release,   /* release */
 205 };
 206
 207 /* modules setup */
 208 struct miscdevice obd_psdev = {
 209         .minor = OBD_DEV_MINOR,
 210         .name  = OBD_DEV_NAME,
 211         .fops  = &obd_psdev_fops,
 212 };
 213
 214
 215 #ifdef CONFIG_PROC_FS
 216 static int obd_proc_version_seq_show(struct seq_file *m, void *v)
 217 {
 218         seq_printf(m, "lustre: %s\nkernel: %s\nbuild:  %s\n",
 219                    LUSTRE_VERSION_STRING, "patchless_client",
 220                    BUILD_VERSION);
 221         return 0;
 222 }
 223 LPROC_SEQ_FOPS_RO(obd_proc_version);
 224
 225 static int obd_proc_pinger_seq_show(struct seq_file *m, void *v)
 226 {
 227         seq_printf(m, "%s\n",
 228 #ifdef ENABLE_PINGER
 229                    "on"
 230 #else
 231                    "off"
 232 #endif
 233                  );
 234         return 0;
 235 }
 236 LPROC_SEQ_FOPS_RO(obd_proc_pinger);
 237
 238 /**
 239  * Check all obd devices health
 240  *
 241  * \param seq_file
 242  * \param data [in] unused
 243  *
 244  * \retval number of characters printed if healthy
 245  */
 246 static int obd_proc_health_seq_show(struct seq_file *m, void *data)
 247 {
 248         bool healthy = true;
 249         int i;
 250
 251         if (libcfs_catastrophe)
 252                 seq_printf(m, "LBUG\n");
 253
 254         read_lock(&obd_dev_lock);
 255         for (i = 0; i < class_devno_max(); i++) {
 256                 struct obd_device *obd;
 257
 258                 obd = class_num2obd(i);
 259                 if (obd == NULL || !obd->obd_attached || !obd->obd_set_up)
 260                         continue;
 261
 262                 LASSERT(obd->obd_magic == OBD_DEVICE_MAGIC);
 263                 if (obd->obd_stopping)
 264                         continue;
 265
 266                 class_incref(obd, __FUNCTION__, current);
 267                 read_unlock(&obd_dev_lock);
 268
 269                 if (obd_health_check(NULL, obd)) {
 270                         seq_printf(m, "device %s reported unhealthy\n",
 271                                    obd->obd_name);
 272                         healthy = false;
 273                 }
 274                 class_decref(obd, __FUNCTION__, current);
 275                 read_lock(&obd_dev_lock);
 276         }
 277         read_unlock(&obd_dev_lock);
 278
 279         if (healthy)
 280                 seq_puts(m, "healthy\n");
 281
 282         seq_printf(m, "NOT HEALTHY\n");
 283         return 0;
 284 }
 285 LPROC_SEQ_FOPS_RO(obd_proc_health);
 286
 287 static int obd_proc_jobid_var_seq_show(struct seq_file *m, void *v)
 288 {
 289         if (strlen(obd_jobid_var) != 0)
 290                 seq_printf(m, "%s\n", obd_jobid_var);
 291         return 0;
 292 }
 293
 294 static ssize_t
 295 obd_proc_jobid_var_seq_write(struct file *file, const char __user *buffer,
 296                              size_t count, loff_t *off)
 297 {
 298         if (!count || count > JOBSTATS_JOBID_VAR_MAX_LEN)
 299                 return -EINVAL;
 300
 301         memset(obd_jobid_var, 0, JOBSTATS_JOBID_VAR_MAX_LEN + 1);
 302
 303         /* This might leave the var invalid on error, which is probably fine.*/
 304         if (copy_from_user(obd_jobid_var, buffer, count))
 305                 return -EFAULT;
 306
 307         /* Trim the trailing '\n' if any */
 308         if (obd_jobid_var[count - 1] == '\n')
 309                 obd_jobid_var[count - 1] = 0;
 310
 311         return count;
 312 }
 313 LPROC_SEQ_FOPS(obd_proc_jobid_var);
 314
 315 static int obd_proc_jobid_name_seq_show(struct seq_file *m, void *v)
 316 {
 317         if (strlen(obd_jobid_node) != 0)
 318                 seq_printf(m, "%s\n", obd_jobid_node);
 319         return 0;
 320 }
 321
 322 static ssize_t obd_proc_jobid_name_seq_write(struct file *file,
 323                                              const char __user *buffer,
 324                                              size_t count, loff_t *off)
 325 {
 326         if (count == 0 || count > LUSTRE_JOBID_SIZE)
 327                 return -EINVAL;
 328
 329         /* clear previous value */
 330         memset(obd_jobid_node, 0, LUSTRE_JOBID_SIZE);
 331
 332         if (copy_from_user(obd_jobid_node, buffer, count))
 333                 return -EFAULT;
 334
 335         /* Trim the trailing '\n' if any */
 336         if (obd_jobid_node[count - 1] == '\n') {
 337                 /* Don't echo just a newline */
 338                 if (count == 1)
 339                         return -EINVAL;
 340                 obd_jobid_node[count - 1] = 0;
 341         }
 342
 343         return count;
 344 }
 345 LPROC_SEQ_FOPS(obd_proc_jobid_name);
 346
 347 /* Root for /proc/fs/lustre */
 348 struct proc_dir_entry *proc_lustre_root = NULL;
 349 EXPORT_SYMBOL(proc_lustre_root);
 350
 351 static struct lprocfs_vars lprocfs_base[] = {
 352         { .name =       "version",
 353           .fops =       &obd_proc_version_fops  },
 354         { .name =       "pinger",
 355           .fops =       &obd_proc_pinger_fops   },
 356         { .name =       "health_check",
 357           .fops =       &obd_proc_health_fops   },
 358         { .name =       "jobid_var",
 359           .fops =       &obd_proc_jobid_var_fops},
 360         { .name =       "jobid_name",
 361           .fops =       &obd_proc_jobid_name_fops},
 362         { NULL }
 363 };
 364 #else
 365 #define lprocfs_base NULL
 366 #endif /* CONFIG_PROC_FS */
 367
 368 static void *obd_device_list_seq_start(struct seq_file *p, loff_t *pos)
 369 {
 370         if (*pos >= class_devno_max())
 371                 return NULL;
 372
 373         return pos;
 374 }
 375
 376 static void obd_device_list_seq_stop(struct seq_file *p, void *v)
 377 {
 378 }
 379
 380 static void *obd_device_list_seq_next(struct seq_file *p, void *v, loff_t *pos)
 381 {
 382         ++*pos;
 383         if (*pos >= class_devno_max())
 384                 return NULL;
 385
 386         return pos;
 387 }
 388
 389 static int obd_device_list_seq_show(struct seq_file *p, void *v)
 390 {
 391         loff_t index = *(loff_t *)v;
 392         struct obd_device *obd = class_num2obd((int)index);
 393         char *status;
 394
 395         if (obd == NULL)
 396                 return 0;
 397
 398         LASSERT(obd->obd_magic == OBD_DEVICE_MAGIC);
 399         if (obd->obd_stopping)
 400                 status = "ST";
 401         else if (obd->obd_inactive)
 402                 status = "IN";
 403         else if (obd->obd_set_up)
 404                 status = "UP";
 405         else if (obd->obd_attached)
 406                 status = "AT";
 407         else
 408                 status = "--";
 409
 410         seq_printf(p, "%3d %s %s %s %s %d\n",
 411                    (int)index, status, obd->obd_type->typ_name,
 412                    obd->obd_name, obd->obd_uuid.uuid,
 413                    atomic_read(&obd->obd_refcount));
 414         return 0;
 415 }
 416
 417 static const struct seq_operations obd_device_list_sops = {
 418         .start = obd_device_list_seq_start,
 419         .stop = obd_device_list_seq_stop,
 420         .next = obd_device_list_seq_next,
 421         .show = obd_device_list_seq_show,
 422 };
 423
 424 static int obd_device_list_open(struct inode *inode, struct file *file)
 425 {
 426         struct seq_file *seq;
 427         int rc = seq_open(file, &obd_device_list_sops);
 428
 429         if (rc)
 430                 return rc;
 431
 432         seq = file->private_data;
 433         seq->private = PDE_DATA(inode);
 434         return 0;
 435 }
 436
 437 static const struct file_operations obd_device_list_fops = {
 438         .owner   = THIS_MODULE,
 439         .open    = obd_device_list_open,
 440         .read    = seq_read,
 441         .llseek  = seq_lseek,
 442         .release = seq_release,
 443 };
 444
 445 int class_procfs_init(void)
 446 {
 447         struct proc_dir_entry *entry;
 448         int rc;
 449         ENTRY;
 450
 451         obd_sysctl_init();
 452
 453         entry = lprocfs_register("fs/lustre", NULL, lprocfs_base, NULL);
 454         if (IS_ERR(entry)) {
 455                 rc = PTR_ERR(entry);
 456                 CERROR("cannot create '/proc/fs/lustre': rc = %d\n", rc);
 457                 RETURN(rc);
 458         }
 459
 460         proc_lustre_root = entry;
 461
 462         rc = lprocfs_seq_create(proc_lustre_root, "devices", 0444,
 463                                 &obd_device_list_fops, NULL);
 464         if (rc < 0) {
 465                 CERROR("cannot create '/proc/fs/lustre/devices': rc = %d\n",
 466                        rc);
 467                 GOTO(out_proc, rc);
 468         }
 469
 470         RETURN(rc);
 471
 472 out_proc:
 473         lprocfs_remove(&proc_lustre_root);
 474
 475         RETURN(rc);
 476 }
 477
 478 int class_procfs_clean(void)
 479 {
 480         ENTRY;
 481         if (proc_lustre_root) {
 482                 lprocfs_remove(&proc_lustre_root);
 483         }
 484         RETURN(0);
 485 }