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         return seq_printf(m, "lustre: %s\nkernel: %s\nbuild:  %s\n",
 219                           LUSTRE_VERSION_STRING, "patchless_client",
 220                           BUILD_VERSION);
 221 }
 222 LPROC_SEQ_FOPS_RO(obd_proc_version);
 223
 224 static int obd_proc_pinger_seq_show(struct seq_file *m, void *v)
 225 {
 226         return seq_printf(m, "%s\n",
 227 #ifdef ENABLE_PINGER
 228                              "on"
 229 #else
 230                              "off"
 231 #endif
 232                          );
 233 }
 234 LPROC_SEQ_FOPS_RO(obd_proc_pinger);
 235
 236 /**
 237  * Check all obd devices health
 238  *
 239  * \param seq_file
 240  * \param data [in] unused
 241  *
 242  * \retval number of characters printed if healthy
 243  */
 244 static int obd_proc_health_seq_show(struct seq_file *m, void *data)
 245 {
 246         bool healthy = true;
 247         int i;
 248
 249         if (libcfs_catastrophe)
 250                 seq_printf(m, "LBUG\n");
 251
 252         read_lock(&obd_dev_lock);
 253         for (i = 0; i < class_devno_max(); i++) {
 254                 struct obd_device *obd;
 255
 256                 obd = class_num2obd(i);
 257                 if (obd == NULL || !obd->obd_attached || !obd->obd_set_up)
 258                         continue;
 259
 260                 LASSERT(obd->obd_magic == OBD_DEVICE_MAGIC);
 261                 if (obd->obd_stopping)
 262                         continue;
 263
 264                 class_incref(obd, __FUNCTION__, current);
 265                 read_unlock(&obd_dev_lock);
 266
 267                 if (obd_health_check(NULL, obd)) {
 268                         seq_printf(m, "device %s reported unhealthy\n",
 269                                         obd->obd_name);
 270                         healthy = false;
 271                 }
 272                 class_decref(obd, __FUNCTION__, current);
 273                 read_lock(&obd_dev_lock);
 274         }
 275         read_unlock(&obd_dev_lock);
 276
 277         if (healthy)
 278                 return seq_printf(m, "healthy\n");
 279
 280         seq_printf(m, "NOT HEALTHY\n");
 281         return 0;
 282 }
 283 LPROC_SEQ_FOPS_RO(obd_proc_health);
 284
 285 static int obd_proc_jobid_var_seq_show(struct seq_file *m, void *v)
 286 {
 287         if (strlen(obd_jobid_var) != 0)
 288                 seq_printf(m, "%s\n", obd_jobid_var);
 289         return 0;
 290 }
 291
 292 static ssize_t
 293 obd_proc_jobid_var_seq_write(struct file *file, const char __user *buffer,
 294                              size_t count, loff_t *off)
 295 {
 296         if (!count || count > JOBSTATS_JOBID_VAR_MAX_LEN)
 297                 return -EINVAL;
 298
 299         memset(obd_jobid_var, 0, JOBSTATS_JOBID_VAR_MAX_LEN + 1);
 300
 301         /* This might leave the var invalid on error, which is probably fine.*/
 302         if (copy_from_user(obd_jobid_var, buffer, count))
 303                 return -EFAULT;
 304
 305         /* Trim the trailing '\n' if any */
 306         if (obd_jobid_var[count - 1] == '\n')
 307                 obd_jobid_var[count - 1] = 0;
 308
 309         return count;
 310 }
 311 LPROC_SEQ_FOPS(obd_proc_jobid_var);
 312
 313 static int obd_proc_jobid_name_seq_show(struct seq_file *m, void *v)
 314 {
 315         if (strlen(obd_jobid_node) != 0)
 316                 seq_printf(m, "%s\n", obd_jobid_node);
 317         return 0;
 318 }
 319
 320 static ssize_t obd_proc_jobid_name_seq_write(struct file *file,
 321                                              const char __user *buffer,
 322                                              size_t count, loff_t *off)
 323 {
 324         if (count == 0 || count > LUSTRE_JOBID_SIZE)
 325                 return -EINVAL;
 326
 327         /* clear previous value */
 328         memset(obd_jobid_node, 0, LUSTRE_JOBID_SIZE);
 329
 330         if (copy_from_user(obd_jobid_node, buffer, count))
 331                 return -EFAULT;
 332
 333         /* Trim the trailing '\n' if any */
 334         if (obd_jobid_node[count - 1] == '\n') {
 335                 /* Don't echo just a newline */
 336                 if (count == 1)
 337                         return -EINVAL;
 338                 obd_jobid_node[count - 1] = 0;
 339         }
 340
 341         return count;
 342 }
 343 LPROC_SEQ_FOPS(obd_proc_jobid_name);
 344
 345 /* Root for /proc/fs/lustre */
 346 struct proc_dir_entry *proc_lustre_root = NULL;
 347 EXPORT_SYMBOL(proc_lustre_root);
 348
 349 static struct lprocfs_vars lprocfs_base[] = {
 350         { .name =       "version",
 351           .fops =       &obd_proc_version_fops  },
 352         { .name =       "pinger",
 353           .fops =       &obd_proc_pinger_fops   },
 354         { .name =       "health_check",
 355           .fops =       &obd_proc_health_fops   },
 356         { .name =       "jobid_var",
 357           .fops =       &obd_proc_jobid_var_fops},
 358         { .name =       "jobid_name",
 359           .fops =       &obd_proc_jobid_name_fops},
 360         { NULL }
 361 };
 362 #else
 363 #define lprocfs_base NULL
 364 #endif /* CONFIG_PROC_FS */
 365
 366 static void *obd_device_list_seq_start(struct seq_file *p, loff_t *pos)
 367 {
 368         if (*pos >= class_devno_max())
 369                 return NULL;
 370
 371         return pos;
 372 }
 373
 374 static void obd_device_list_seq_stop(struct seq_file *p, void *v)
 375 {
 376 }
 377
 378 static void *obd_device_list_seq_next(struct seq_file *p, void *v, loff_t *pos)
 379 {
 380         ++*pos;
 381         if (*pos >= class_devno_max())
 382                 return NULL;
 383
 384         return pos;
 385 }
 386
 387 static int obd_device_list_seq_show(struct seq_file *p, void *v)
 388 {
 389         loff_t index = *(loff_t *)v;
 390         struct obd_device *obd = class_num2obd((int)index);
 391         char *status;
 392
 393         if (obd == NULL)
 394                 return 0;
 395
 396         LASSERT(obd->obd_magic == OBD_DEVICE_MAGIC);
 397         if (obd->obd_stopping)
 398                 status = "ST";
 399         else if (obd->obd_inactive)
 400                 status = "IN";
 401         else if (obd->obd_set_up)
 402                 status = "UP";
 403         else if (obd->obd_attached)
 404                 status = "AT";
 405         else
 406                 status = "--";
 407
 408         return seq_printf(p, "%3d %s %s %s %s %d\n",
 409                           (int)index, status, obd->obd_type->typ_name,
 410                           obd->obd_name, obd->obd_uuid.uuid,
 411                           atomic_read(&obd->obd_refcount));
 412 }
 413
 414 static const struct seq_operations obd_device_list_sops = {
 415         .start = obd_device_list_seq_start,
 416         .stop = obd_device_list_seq_stop,
 417         .next = obd_device_list_seq_next,
 418         .show = obd_device_list_seq_show,
 419 };
 420
 421 static int obd_device_list_open(struct inode *inode, struct file *file)
 422 {
 423         struct seq_file *seq;
 424         int rc = seq_open(file, &obd_device_list_sops);
 425
 426         if (rc)
 427                 return rc;
 428
 429         seq = file->private_data;
 430         seq->private = PDE_DATA(inode);
 431         return 0;
 432 }
 433
 434 static const struct file_operations obd_device_list_fops = {
 435         .owner   = THIS_MODULE,
 436         .open    = obd_device_list_open,
 437         .read    = seq_read,
 438         .llseek  = seq_lseek,
 439         .release = seq_release,
 440 };
 441
 442 int class_procfs_init(void)
 443 {
 444         struct proc_dir_entry *entry;
 445         int rc;
 446         ENTRY;
 447
 448         obd_sysctl_init();
 449
 450         entry = lprocfs_register("fs/lustre", NULL, lprocfs_base, NULL);
 451         if (IS_ERR(entry)) {
 452                 rc = PTR_ERR(entry);
 453                 CERROR("cannot create '/proc/fs/lustre': rc = %d\n", rc);
 454                 RETURN(rc);
 455         }
 456
 457         proc_lustre_root = entry;
 458
 459         rc = lprocfs_seq_create(proc_lustre_root, "devices", 0444,
 460                                 &obd_device_list_fops, NULL);
 461         if (rc < 0) {
 462                 CERROR("cannot create '/proc/fs/lustre/devices': rc = %d\n",
 463                        rc);
 464                 GOTO(out_proc, rc);
 465         }
 466
 467         RETURN(rc);
 468
 469 out_proc:
 470         lprocfs_remove(&proc_lustre_root);
 471
 472         RETURN(rc);
 473 }
 474
 475 int class_procfs_clean(void)
 476 {
 477         ENTRY;
 478         if (proc_lustre_root) {
 479                 lprocfs_remove(&proc_lustre_root);
 480         }
 481         RETURN(0);
 482 }