Whamcloud - gitweb
LU-9679 lustre: avoid cast of file->private_data
[fs/lustre-release.git] / lustre / fid / lproc_fid.c
index 63b4c16..688082e 100644 (file)
  *
  * You should have received a copy of the GNU General Public License
  * version 2 along with this program; If not, see
- * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
- *
- * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
- * CA 95054 USA or visit www.sun.com if you need additional information or
- * have any questions.
+ * http://www.gnu.org/licenses/gpl-2.0.html
  *
  * GPL HEADER END
  */
@@ -27,7 +23,7 @@
  * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
  * Use is subject to license terms.
  *
- * Copyright (c) 2011, 2013, Intel Corporation.
+ * Copyright (c) 2011, 2015, Intel Corporation.
  */
 /*
  * This file is part of Lustre, http://www.lustre.org/
 #include <lustre_fid.h>
 #include <lprocfs_status.h>
 #include "fid_internal.h"
-#include <md_object.h>
 
-#ifdef LPROCFS
-/*
- * Note: this function is only used for testing, it is no safe for production
- * use.
+/* Format: [0x64BIT_INT - 0x64BIT_INT] + 32 bytes just in case */
+#define MAX_FID_RANGE_STRLEN (32 + 2 * 2 * sizeof(__u64))
+/**
+ * Reduce the SEQ range allocated to a node to a strict subset of the range
+ * currently-allocated SEQ range.  If the specified range is "clear", then
+ * drop all allocated sequences and request a new one from the master.
+ *
+ * Note: this function should only be used for testing, it is not necessarily
+ * safe for production use.
  */
 static int
-seq_proc_write_common(struct file *file, const char *buffer,
-                      unsigned long count, void *data,
-                      struct lu_seq_range *range)
+ldebugfs_fid_write_common(const char __user *buffer, size_t count,
+                         struct lu_seq_range *range)
 {
-       struct lu_seq_range tmp;
+       char kernbuf[MAX_FID_RANGE_STRLEN];
+       struct lu_seq_range tmp = {
+               .lsr_start = 0,
+       };
        int rc;
+
        ENTRY;
+       LASSERT(range);
+
+       if (count >= sizeof(kernbuf))
+               RETURN(-EINVAL);
+
+       if (copy_from_user(kernbuf, buffer, count))
+               RETURN(-EFAULT);
 
-       LASSERT(range != NULL);
+       kernbuf[count] = 0;
 
-       if (count == 5 && strcmp(buffer, "clear") == 0) {
+       if (count == 5 && strcmp(kernbuf, "clear") == 0) {
                memset(range, 0, sizeof(*range));
-               RETURN(0);
+               RETURN(count);
        }
 
-        rc = sscanf(buffer, "[%llx - %llx]\n",
-                    (long long unsigned *)&tmp.lsr_start,
-                    (long long unsigned *)&tmp.lsr_end);
-       if (rc != 2 || !range_is_sane(&tmp) || range_is_zero(&tmp))
+       /* of the form "[0x0000000240000400 - 0x000000028000400]" */
+       rc = sscanf(kernbuf, "[%llx - %llx]\n",
+                   (unsigned long long *)&tmp.lsr_start,
+                   (unsigned long long *)&tmp.lsr_end);
+       if (rc != 2)
+               RETURN(-EINVAL);
+       if (!lu_seq_range_is_sane(&tmp) || lu_seq_range_is_zero(&tmp) ||
+           tmp.lsr_start < range->lsr_start || tmp.lsr_end > range->lsr_end)
                RETURN(-EINVAL);
        *range = tmp;
-        RETURN(0);
-}
-
-static int
-seq_proc_read_common(char *page, char **start, off_t off,
-                     int count, int *eof, void *data,
-                     struct lu_seq_range *range)
-{
-       int rc;
-       ENTRY;
-
-        *eof = 1;
-       rc = snprintf(page, count, "["LPX64" - "LPX64"]:%x:%s\n",
-                       PRANGE(range));
-       RETURN(rc);
+       RETURN(0);
 }
 
 #ifdef HAVE_SERVER_SUPPORT
 /*
- * Server side procfs stuff.
+ * Server side debugfs stuff.
  */
-static int
-seq_server_proc_write_space(struct file *file, const char *buffer,
-                            unsigned long count, void *data)
+static ssize_t
+ldebugfs_server_fid_space_seq_write(struct file *file,
+                                   const char __user *buffer,
+                                   size_t count, loff_t *off)
 {
-        struct lu_server_seq *seq = (struct lu_server_seq *)data;
+       struct seq_file *m = file->private_data;
+       struct lu_server_seq *seq = m->private;
        int rc;
-       ENTRY;
 
-        LASSERT(seq != NULL);
+       ENTRY;
 
        mutex_lock(&seq->lss_mutex);
-       rc = seq_proc_write_common(file, buffer, count,
-                                   data, &seq->lss_space);
+       rc = ldebugfs_fid_write_common(buffer, count, &seq->lss_space);
        if (rc == 0) {
-               CDEBUG(D_INFO, "%s: Space: "DRANGE"\n",
-                       seq->lss_name, PRANGE(&seq->lss_space));
+               CDEBUG(D_INFO, "%s: Space: " DRANGE "\n",
+                      seq->lss_name, PRANGE(&seq->lss_space));
        }
-
        mutex_unlock(&seq->lss_mutex);
 
-        RETURN(count);
+       RETURN(count);
 }
 
 static int
-seq_server_proc_read_space(char *page, char **start, off_t off,
-                           int count, int *eof, void *data)
+ldebugfs_server_fid_space_seq_show(struct seq_file *m, void *unused)
 {
-        struct lu_server_seq *seq = (struct lu_server_seq *)data;
-       int rc;
+       struct lu_server_seq *seq = (struct lu_server_seq *)m->private;
        ENTRY;
 
-        LASSERT(seq != NULL);
-
        mutex_lock(&seq->lss_mutex);
-       rc = seq_proc_read_common(page, start, off, count, eof,
-                                  data, &seq->lss_space);
+       seq_printf(m, "[%#llx - %#llx]:%x:%s\n", PRANGE(&seq->lss_space));
        mutex_unlock(&seq->lss_mutex);
 
-       RETURN(rc);
+       RETURN(0);
 }
 
 static int
-seq_server_proc_read_server(char *page, char **start, off_t off,
-                            int count, int *eof, void *data)
+ldebugfs_server_fid_server_seq_show(struct seq_file *m, void *unused)
 {
-        struct lu_server_seq *seq = (struct lu_server_seq *)data;
-        struct client_obd *cli;
-       int rc;
+       struct lu_server_seq *seq = (struct lu_server_seq *)m->private;
+       struct client_obd *cli;
        ENTRY;
 
-        LASSERT(seq != NULL);
-
-       *eof = 1;
        if (seq->lss_cli) {
-                if (seq->lss_cli->lcs_exp != NULL) {
-                        cli = &seq->lss_cli->lcs_exp->exp_obd->u.cli;
-                        rc = snprintf(page, count, "%s\n",
-                                      cli->cl_target_uuid.uuid);
-                } else {
-                        rc = snprintf(page, count, "%s\n",
-                                      seq->lss_cli->lcs_srv->lss_name);
+               if (seq->lss_cli->lcs_exp != NULL) {
+                       cli = &seq->lss_cli->lcs_exp->exp_obd->u.cli;
+                       seq_printf(m, "%s\n", cli->cl_target_uuid.uuid);
+               } else {
+                       seq_printf(m, "%s\n", seq->lss_cli->lcs_srv->lss_name);
                 }
        } else {
-               rc = snprintf(page, count, "<none>\n");
+               seq_puts(m, "<none>\n");
        }
 
-       RETURN(rc);
+       RETURN(0);
 }
 
-static int
-seq_server_proc_write_width(struct file *file, const char *buffer,
-                            unsigned long count, void *data)
+static ssize_t ldebugfs_server_fid_width_seq_write(struct file *file,
+                                                  const char __user *buffer,
+                                                  size_t count, loff_t *off)
 {
-        struct lu_server_seq *seq = (struct lu_server_seq *)data;
-       int rc, val;
-       ENTRY;
-
-        LASSERT(seq != NULL);
+       struct seq_file *m = file->private_data;
+       struct lu_server_seq *seq = m->private;
+       int rc;
 
+       ENTRY;
        mutex_lock(&seq->lss_mutex);
 
-       rc = lprocfs_write_helper(buffer, count, &val);
-       if (rc != 0) {
-               CERROR("%s: invalid width.\n", seq->lss_name);
-               GOTO(out_unlock, rc);
+       rc = kstrtoull_from_user(buffer, count, 0, &seq->lss_width);
+       if (rc) {
+               CERROR("%s: invalid FID sequence width: rc = %d\n",
+                      seq->lss_name, rc);
+               GOTO(out_unlock, count = rc);
        }
 
-       seq->lss_width = val;
-
-       CDEBUG(D_INFO, "%s: Width: "LPU64"\n",
+       CDEBUG(D_INFO, "%s: Width: %llu\n",
               seq->lss_name, seq->lss_width);
 out_unlock:
        mutex_unlock(&seq->lss_mutex);
 
-        RETURN(count);
+       RETURN(count);
 }
 
 static int
-seq_server_proc_read_width(char *page, char **start, off_t off,
-                           int count, int *eof, void *data)
+ldebugfs_server_fid_width_seq_show(struct seq_file *m, void *unused)
 {
-        struct lu_server_seq *seq = (struct lu_server_seq *)data;
-       int rc;
-       ENTRY;
-
-        LASSERT(seq != NULL);
+       struct lu_server_seq *seq = (struct lu_server_seq *)m->private;
 
+       ENTRY;
        mutex_lock(&seq->lss_mutex);
-        rc = snprintf(page, count, LPU64"\n", seq->lss_width);
+       seq_printf(m, "%llu\n", seq->lss_width);
        mutex_unlock(&seq->lss_mutex);
 
-       RETURN(rc);
+       RETURN(0);
 }
 
-struct lprocfs_vars seq_server_proc_list[] = {
-       { "space",
-         seq_server_proc_read_space, seq_server_proc_write_space, NULL },
-       { "width",
-         seq_server_proc_read_width, seq_server_proc_write_width, NULL },
-       { "server",
-         seq_server_proc_read_server, NULL, NULL },
+LDEBUGFS_SEQ_FOPS(ldebugfs_server_fid_space);
+LDEBUGFS_SEQ_FOPS(ldebugfs_server_fid_width);
+LDEBUGFS_SEQ_FOPS_RO(ldebugfs_server_fid_server);
+
+struct lprocfs_vars seq_server_debugfs_list[] = {
+       { .name =       "space",
+         .fops =       &ldebugfs_server_fid_space_fops },
+       { .name =       "width",
+         .fops =       &ldebugfs_server_fid_width_fops },
+       { .name =       "server",
+         .fops =       &ldebugfs_server_fid_server_fops},
        { NULL }
 };
 
@@ -243,6 +228,8 @@ static void *fldb_seq_start(struct seq_file *p, loff_t *pos)
        struct lu_server_fld    *fld;
        struct dt_object        *obj;
        const struct dt_it_ops  *iops;
+       struct dt_key           *key;
+       int                     rc;
 
        if (param == NULL || param->fsp_stop)
                return NULL;
@@ -252,9 +239,16 @@ static void *fldb_seq_start(struct seq_file *p, loff_t *pos)
        LASSERT(obj != NULL);
        iops = &obj->do_index_ops->dio_it;
 
-       iops->load(&param->fsp_env, param->fsp_it, *pos);
+       rc = iops->load(&param->fsp_env, param->fsp_it, *pos);
+       if (rc <= 0)
+               return NULL;
+
+       key = iops->key(&param->fsp_env, param->fsp_it);
+       if (IS_ERR(key))
+               return NULL;
+
+       *pos = be64_to_cpu(*(__u64 *)key);
 
-       *pos = be64_to_cpu(*(__u64 *)iops->key(&param->fsp_env, param->fsp_it));
        return param;
 }
 
@@ -326,7 +320,7 @@ static int fldb_seq_show(struct seq_file *p, void *v)
                       fld->lsf_name, rc);
        } else if (fld_rec.lsr_start != 0) {
                range_be_to_cpu(&fld_rec, &fld_rec);
-               rc = seq_printf(p, DRANGE"\n", PRANGE(&fld_rec));
+               seq_printf(p, DRANGE"\n", PRANGE(&fld_rec));
        }
 
        return rc;
@@ -341,9 +335,8 @@ struct seq_operations fldb_sops = {
 
 static int fldb_seq_open(struct inode *inode, struct file *file)
 {
-       struct proc_dir_entry   *dp = PDE(inode);
        struct seq_file         *seq;
-       struct lu_server_seq    *ss = (struct lu_server_seq *)dp->data;
+       struct lu_server_seq *ss = inode->i_private;
        struct lu_server_fld    *fld;
        struct dt_object        *obj;
        const struct dt_it_ops  *iops;
@@ -354,10 +347,9 @@ static int fldb_seq_open(struct inode *inode, struct file *file)
        fld = ss->lss_site->ss_server_fld;
        LASSERT(fld != NULL);
 
-       LPROCFS_ENTRY_AND_CHECK(dp);
        rc = seq_open(file, &fldb_sops);
        if (rc)
-               GOTO(out, rc);
+               return rc;
 
        obj = fld->lsf_obj;
        if (obj == NULL) {
@@ -376,7 +368,7 @@ static int fldb_seq_open(struct inode *inode, struct file *file)
 
        env_init = 1;
        iops = &obj->do_index_ops->dio_it;
-       param->fsp_it = iops->init(&param->fsp_env, obj, 0, NULL);
+       param->fsp_it = iops->init(&param->fsp_env, obj, 0);
        if (IS_ERR(param->fsp_it))
                GOTO(out, rc = PTR_ERR(param->fsp_it));
 
@@ -392,7 +384,6 @@ out:
                        lu_env_fini(&param->fsp_env);
                if (param != NULL)
                        OBD_FREE_PTR(param);
-               LPROCFS_EXIT();
        }
        return rc;
 }
@@ -407,7 +398,7 @@ static int fldb_seq_release(struct inode *inode, struct file *file)
 
        param = seq->private;
        if (param == NULL) {
-               lprocfs_seq_release(inode, file);
+               seq_release(inode, file);
                return 0;
        }
 
@@ -417,36 +408,36 @@ static int fldb_seq_release(struct inode *inode, struct file *file)
        iops = &obj->do_index_ops->dio_it;
 
        LASSERT(iops != NULL);
-       LASSERT(obj != NULL);
        LASSERT(param->fsp_it != NULL);
        iops->fini(&param->fsp_env, param->fsp_it);
        lu_env_fini(&param->fsp_env);
        OBD_FREE_PTR(param);
-       lprocfs_seq_release(inode, file);
+       seq_release(inode, file);
 
        return 0;
 }
 
-static ssize_t fldb_seq_write(struct file *file, const char *buf,
+static ssize_t fldb_seq_write(struct file *file, const char __user *buf,
                              size_t len, loff_t *off)
 {
        struct seq_file         *seq = file->private_data;
        struct fld_seq_param    *param;
        struct lu_seq_range      range;
        int                      rc = 0;
-       char                    *buffer, *_buffer;
+       char                     _buffer[MAX_FID_RANGE_STRLEN];
+       char                    *buffer = _buffer;
        ENTRY;
 
        param = seq->private;
        if (param == NULL)
                RETURN(-EINVAL);
 
-       OBD_ALLOC(buffer, len + 1);
-       if (buffer == NULL)
-               RETURN(-ENOMEM);
-       memcpy(buffer, buf, len);
+       if (len >= sizeof(_buffer))
+               RETURN(-EINVAL);
+
+       if (copy_from_user(buffer, buf, len))
+               GOTO(out, rc = -EFAULT);
        buffer[len] = 0;
-       _buffer = buffer;
 
        /*
         * format - [0x0000000200000007-0x0000000200000008):0:mdt
@@ -484,11 +475,10 @@ static ssize_t fldb_seq_write(struct file *file, const char *buf,
                                   &range, &param->fsp_env);
 
 out:
-       OBD_FREE(_buffer, len + 1);
        RETURN(rc < 0 ? rc : len);
 }
 
-const struct file_operations seq_fld_proc_seq_fops = {
+const struct file_operations seq_fld_debugfs_seq_fops = {
        .owner   = THIS_MODULE,
        .open    = fldb_seq_open,
        .read    = seq_read,
@@ -498,145 +488,134 @@ const struct file_operations seq_fld_proc_seq_fops = {
 
 #endif /* HAVE_SERVER_SUPPORT */
 
-/* Client side procfs stuff */
-static int
-seq_client_proc_write_space(struct file *file, const char *buffer,
-                            unsigned long count, void *data)
+/* Client side debugfs stuff */
+static ssize_t
+ldebugfs_client_fid_space_seq_write(struct file *file,
+                                   const char __user *buffer,
+                                   size_t count, loff_t *off)
 {
-        struct lu_client_seq *seq = (struct lu_client_seq *)data;
+       struct seq_file *m = file->private_data;
+       struct lu_client_seq *seq = m->private;
        int rc;
-       ENTRY;
 
-        LASSERT(seq != NULL);
+       ENTRY;
 
        mutex_lock(&seq->lcs_mutex);
-       rc = seq_proc_write_common(file, buffer, count,
-                                   data, &seq->lcs_space);
-
+       rc = ldebugfs_fid_write_common(buffer, count, &seq->lcs_space);
        if (rc == 0) {
-               CDEBUG(D_INFO, "%s: Space: "DRANGE"\n",
+               CDEBUG(D_INFO, "%s: Space: " DRANGE "\n",
                        seq->lcs_name, PRANGE(&seq->lcs_space));
        }
 
        mutex_unlock(&seq->lcs_mutex);
 
-        RETURN(count);
+       RETURN(count);
 }
 
-static int
-seq_client_proc_read_space(char *page, char **start, off_t off,
-                           int count, int *eof, void *data)
+static int ldebugfs_client_fid_space_seq_show(struct seq_file *m, void *unused)
 {
-        struct lu_client_seq *seq = (struct lu_client_seq *)data;
-       int rc;
-       ENTRY;
-
-        LASSERT(seq != NULL);
+       struct lu_client_seq *seq = (struct lu_client_seq *)m->private;
 
+       ENTRY;
        mutex_lock(&seq->lcs_mutex);
-       rc = seq_proc_read_common(page, start, off, count, eof,
-                                  data, &seq->lcs_space);
+       seq_printf(m, "[%#llx - %#llx]:%x:%s\n", PRANGE(&seq->lcs_space));
        mutex_unlock(&seq->lcs_mutex);
 
-       RETURN(rc);
+       RETURN(0);
 }
 
-static int
-seq_client_proc_write_width(struct file *file, const char *buffer,
-                            unsigned long count, void *data)
+static ssize_t ldebugfs_client_fid_width_seq_write(struct file *file,
+                                                  const char __user *buffer,
+                                                  size_t count, loff_t *off)
 {
-        struct lu_client_seq *seq = (struct lu_client_seq *)data;
-       __u64  max;
-       int rc, val;
-       ENTRY;
+       struct seq_file *m = file->private_data;
+       struct lu_client_seq *seq = m->private;
+       u64 val;
+       u64 max;
+       int rc;
 
-        LASSERT(seq != NULL);
+       ENTRY;
+       rc = kstrtoull_from_user(buffer, count, 0, &val);
+       if (rc)
+               return rc;
 
        mutex_lock(&seq->lcs_mutex);
-
-        rc = lprocfs_write_helper(buffer, count, &val);
-        if (rc) {
-               mutex_unlock(&seq->lcs_mutex);
-                RETURN(rc);
-        }
-
        if (seq->lcs_type == LUSTRE_SEQ_DATA)
                max = LUSTRE_DATA_SEQ_MAX_WIDTH;
        else
                max = LUSTRE_METADATA_SEQ_MAX_WIDTH;
 
-       if (val <= max && val > 0) {
+       if (val <= max) {
                seq->lcs_width = val;
 
-               if (rc == 0) {
-                       CDEBUG(D_INFO, "%s: Sequence size: "LPU64"\n",
-                              seq->lcs_name, seq->lcs_width);
-               }
+               CDEBUG(D_INFO, "%s: Sequence size: %llu\n", seq->lcs_name,
+                      seq->lcs_width);
+       } else {
+               count = -ERANGE;
        }
 
        mutex_unlock(&seq->lcs_mutex);
-
-        RETURN(count);
+       RETURN(count);
 }
 
 static int
-seq_client_proc_read_width(char *page, char **start, off_t off,
-                           int count, int *eof, void *data)
+ldebugfs_client_fid_width_seq_show(struct seq_file *m, void *unused)
 {
-        struct lu_client_seq *seq = (struct lu_client_seq *)data;
-       int rc;
-       ENTRY;
-
-        LASSERT(seq != NULL);
+       struct lu_client_seq *seq = (struct lu_client_seq *)m->private;
 
+       ENTRY;
        mutex_lock(&seq->lcs_mutex);
-        rc = snprintf(page, count, LPU64"\n", seq->lcs_width);
+       seq_printf(m, "%llu\n", seq->lcs_width);
        mutex_unlock(&seq->lcs_mutex);
 
-       RETURN(rc);
+       RETURN(0);
 }
 
 static int
-seq_client_proc_read_fid(char *page, char **start, off_t off,
-                         int count, int *eof, void *data)
+ldebugfs_client_fid_fid_seq_show(struct seq_file *m, void *unused)
 {
-        struct lu_client_seq *seq = (struct lu_client_seq *)data;
-       int rc;
-       ENTRY;
-
-        LASSERT(seq != NULL);
+       struct lu_client_seq *seq = (struct lu_client_seq *)m->private;
 
+       ENTRY;
        mutex_lock(&seq->lcs_mutex);
-        rc = snprintf(page, count, DFID"\n", PFID(&seq->lcs_fid));
+       seq_printf(m, DFID"\n", PFID(&seq->lcs_fid));
        mutex_unlock(&seq->lcs_mutex);
 
-       RETURN(rc);
+       RETURN(0);
 }
 
 static int
-seq_client_proc_read_server(char *page, char **start, off_t off,
-                            int count, int *eof, void *data)
+ldebugfs_client_fid_server_seq_show(struct seq_file *m, void *unused)
 {
-        struct lu_client_seq *seq = (struct lu_client_seq *)data;
-        struct client_obd *cli;
-       int rc;
+       struct lu_client_seq *seq = (struct lu_client_seq *)m->private;
+       struct client_obd *cli;
        ENTRY;
 
-        LASSERT(seq != NULL);
+       if (seq->lcs_exp) {
+               cli = &seq->lcs_exp->exp_obd->u.cli;
+               seq_printf(m, "%s\n", cli->cl_target_uuid.uuid);
+#ifdef HAVE_SERVER_SUPPORT
+       } else {
+               seq_printf(m, "%s\n", seq->lcs_srv->lss_name);
+#endif /* HAVE_SERVER_SUPPORT */
+       }
 
-        if (seq->lcs_exp != NULL) {
-                cli = &seq->lcs_exp->exp_obd->u.cli;
-                rc = snprintf(page, count, "%s\n", cli->cl_target_uuid.uuid);
-        } else {
-                rc = snprintf(page, count, "%s\n", seq->lcs_srv->lss_name);
-        }
-       RETURN(rc);
+       RETURN(0);
 }
 
-struct lprocfs_vars seq_client_proc_list[] = {
-       { "space",    seq_client_proc_read_space, seq_client_proc_write_space, NULL },
-       { "width",    seq_client_proc_read_width, seq_client_proc_write_width, NULL },
-       { "server",   seq_client_proc_read_server, NULL, NULL },
-       { "fid",      seq_client_proc_read_fid, NULL, NULL },
-       { NULL }};
-#endif
+LDEBUGFS_SEQ_FOPS(ldebugfs_client_fid_space);
+LDEBUGFS_SEQ_FOPS(ldebugfs_client_fid_width);
+LDEBUGFS_SEQ_FOPS_RO(ldebugfs_client_fid_server);
+LDEBUGFS_SEQ_FOPS_RO(ldebugfs_client_fid_fid);
+
+struct lprocfs_vars seq_client_debugfs_list[] = {
+       { .name =       "space",
+         .fops =       &ldebugfs_client_fid_space_fops },
+       { .name =       "width",
+         .fops =       &ldebugfs_client_fid_width_fops },
+       { .name =       "server",
+         .fops =       &ldebugfs_client_fid_server_fops},
+       { .name =       "fid",
+         .fops =       &ldebugfs_client_fid_fid_fops   },
+       { NULL }
+};