libcfs/include/libcfs/linux/linux-misc.h

   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.gnu.org/licenses/gpl-2.0.html
  19  *
  20  * GPL HEADER END
  21  */
  22 /*
  23  * Copyright (c) 2008, 2010, Oracle and/or its affiliates. All rights reserved.
  24  * Use is subject to license terms.
  25  *
  26  * Copyright (c) 2011, 2017, Intel Corporation.
  27  */
  28 /*
  29  * This file is part of Lustre, http://www.lustre.org/
  30  * Lustre is a trademark of Sun Microsystems, Inc.
  31  */
  32
  33 #ifndef __LIBCFS_LINUX_MISC_H__
  34 #define __LIBCFS_LINUX_MISC_H__
  35
  36 #include <linux/fs.h>
  37 /* Since Commit 2f8b544477e6 ("block,fs: untangle fs.h and blk_types.h")
  38  * fs.h doesn't include blk_types.h, but we need it.
  39  */
  40 #include <linux/blk_types.h>
  41 #include <linux/mutex.h>
  42 #include <linux/user_namespace.h>
  43 #include <linux/uio.h>
  44
  45 #ifndef HAVE_IOV_ITER_TYPE
  46 #ifdef HAVE_IOV_ITER_HAS_TYPE_MEMBER
  47 #define iter_is_iovec(iter)             ((iter)->type & ITER_IOVEC)
  48 #define iov_iter_is_kvec(iter)          ((iter)->type & ITER_KVEC)
  49 #define iov_iter_is_bvec(iter)          ((iter)->type & ITER_BVEC)
  50 #define iov_iter_is_pipe(iter)          ((iter)->type & ITER_PIPE)
  51 #define iov_iter_is_discard(iter)       ((iter)->type & ITER_DISCARD)
  52 #else
  53 #define iter_is_iovec(iter)             1
  54 #define iov_iter_is_kvec(iter)          0
  55 #define iov_iter_is_bvec(iter)          0
  56 #define iov_iter_is_pipe(iter)          0
  57 #define iov_iter_is_discard(iter)       0
  58 #endif
  59 #endif /* HAVE_IOV_ITER_TYPE */
  60
  61 int cfs_get_environ(const char *key, char *value, int *val_len);
  62
  63 int cfs_kernel_write(struct file *filp, const void *buf, size_t count,
  64                      loff_t *pos);
  65 ssize_t cfs_kernel_read(struct file *file, void *buf, size_t count,
  66                         loff_t *pos);
  67
  68 /*
  69  * For RHEL6 struct kernel_parm_ops doesn't exist. Also
  70  * the arguments for .set and .get take different
  71  * parameters which is handled below
  72  */
  73 #ifdef HAVE_KERNEL_PARAM_OPS
  74 #define cfs_kernel_param_arg_t const struct kernel_param
  75 #else
  76 #define cfs_kernel_param_arg_t struct kernel_param_ops
  77 #define kernel_param_ops kernel_param
  78 #endif /* ! HAVE_KERNEL_PARAM_OPS */
  79
  80 #ifndef HAVE_KERNEL_PARAM_LOCK
  81 static inline void kernel_param_unlock(struct module *mod)
  82 {
  83         __kernel_param_unlock();
  84 }
  85
  86 static inline void kernel_param_lock(struct module *mod)
  87 {
  88         __kernel_param_lock();
  89 }
  90 #endif /* ! HAVE_KERNEL_PARAM_LOCK */
  91
  92 int cfs_apply_workqueue_attrs(struct workqueue_struct *wq,
  93                               const struct workqueue_attrs *attrs);
  94
  95 #ifndef HAVE_KSTRTOBOOL_FROM_USER
  96
  97 #define kstrtobool strtobool
  98
  99 int kstrtobool_from_user(const char __user *s, size_t count, bool *res);
 100 #endif /* HAVE_KSTRTOBOOL_FROM_USER */
 101
 102 #ifndef HAVE_KREF_READ
 103 static inline int kref_read(const struct kref *kref)
 104 {
 105         return atomic_read(&kref->refcount);
 106 }
 107 #endif /* HAVE_KREF_READ */
 108
 109 #ifdef HAVE_FORCE_SIG_WITH_TASK
 110 #define cfs_force_sig(sig, task)        force_sig((sig), (task))
 111 #else
 112 #define cfs_force_sig(sig, task)                                        \
 113 do {                                                                    \
 114         unsigned long flags;                                            \
 115                                                                         \
 116         spin_lock_irqsave(&task->sighand->siglock, flags);              \
 117         task->sighand->action[sig - 1].sa.sa_handler = SIG_DFL;         \
 118         send_sig(sig, task, 1);                                         \
 119         spin_unlock_irqrestore(&task->sighand->siglock, flags);         \
 120 } while (0)
 121 #endif
 122
 123 void cfs_arch_init(void);
 124
 125 #ifndef container_of_safe
 126 /**
 127  * container_of_safe - cast a member of a structure out to the containing structure
 128  * @ptr:        the pointer to the member.
 129  * @type:       the type of the container struct this is embedded in.
 130  * @member:     the name of the member within the struct.
 131  *
 132  * If IS_ERR_OR_NULL(ptr), ptr is returned unchanged.
 133  *
 134  * Note: Copied from Linux 5.6, with BUILD_BUG_ON_MSG section removed.
 135  */
 136 #define container_of_safe(ptr, type, member) ({                         \
 137         void *__mptr = (void *)(ptr);                                   \
 138         IS_ERR_OR_NULL(__mptr) ? ERR_CAST(__mptr) :                     \
 139                 ((type *)(__mptr - offsetof(type, member))); })
 140 #endif
 141
 142 /*
 143  * Linux v4.15-rc2-5-g4229a470175b added sizeof_field()
 144  * Linux v5.5-rc4-1-g1f07dcc459d5 removed FIELD_SIZEOF()
 145  * Proved a sizeof_field in terms of FIELD_SIZEOF() when one is not provided
 146  */
 147 #ifndef sizeof_field
 148 #define sizeof_field(type, member)      FIELD_SIZEOF(type, member)
 149 #endif
 150
 151 #endif /* __LIBCFS_LINUX_MISC_H__ */