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  */
  31
  32 #ifndef __LIBCFS_LINUX_MISC_H__
  33 #define __LIBCFS_LINUX_MISC_H__
  34
  35 #include <linux/fs.h>
  36 /* Since Commit 2f8b544477e6 ("block,fs: untangle fs.h and blk_types.h")
  37  * fs.h doesn't include blk_types.h, but we need it.
  38  */
  39 #include <linux/blk_types.h>
  40 #include <linux/mutex.h>
  41 #include <linux/user_namespace.h>
  42 #include <linux/uio.h>
  43 #include <linux/kallsyms.h>
  44
  45 /*
  46  * Since 4.20 commit 00e23707442a75b404392cef1405ab4fd498de6b
  47  * iov_iter: Use accessor functions to access an iterator's type and direction.
  48  * iter_is_iovec() and iov_iter_is_* are available, supply the missing
  49  * functionality for older kernels.
  50  */
  51 #ifdef HAVE_IOV_ITER_TYPE
  52 #ifndef HAVE_ENUM_ITER_PIPE
  53 #define iov_iter_is_pipe(iter)  0
  54 #endif
  55 #else
  56 /*
  57  * Since 3.15-rc4 commit 71d8e532b1549a478e6a6a8a44f309d050294d00
  58  * The iov iterator has a type and can iterate over numerous vector types.
  59  * Prior to this only iovec is supported, so all iov_iter_is_* are false.
  60  */
  61 #ifdef HAVE_IOV_ITER_HAS_TYPE_MEMBER
  62 #define iter_is_iovec(iter)             ((iter)->type & ITER_IOVEC)
  63 #define iov_iter_is_kvec(iter)          ((iter)->type & ITER_KVEC)
  64 #define iov_iter_is_bvec(iter)          ((iter)->type & ITER_BVEC)
  65 #if defined HAVE_ENUM_ITER_PIPE
  66 #define iov_iter_is_pipe(iter)          ((iter)->type & ITER_PIPE)
  67 #else
  68 #define iov_iter_is_pipe(iter)          0
  69 #endif
  70 #define iov_iter_is_discard(iter)       ((iter)->type & ITER_DISCARD)
  71 #else
  72 #define iter_is_iovec(iter)             1
  73 #define iov_iter_is_kvec(iter)          0
  74 #define iov_iter_is_bvec(iter)          0
  75 #define iov_iter_is_pipe(iter)          0
  76 #define iov_iter_is_discard(iter)       0
  77 #endif
  78 #endif /* HAVE_IOV_ITER_TYPE */
  79
  80 int cfs_kernel_write(struct file *filp, const void *buf, size_t count,
  81                      loff_t *pos);
  82 ssize_t cfs_kernel_read(struct file *file, void *buf, size_t count,
  83                         loff_t *pos);
  84
  85 /*
  86  * For RHEL6 struct kernel_parm_ops doesn't exist. Also
  87  * the arguments for .set and .get take different
  88  * parameters which is handled below
  89  */
  90 #ifdef HAVE_KERNEL_PARAM_OPS
  91 #define cfs_kernel_param_arg_t const struct kernel_param
  92 #else
  93 #define cfs_kernel_param_arg_t struct kernel_param_ops
  94 #define kernel_param_ops kernel_param
  95 #endif /* ! HAVE_KERNEL_PARAM_OPS */
  96
  97 #ifndef HAVE_KERNEL_PARAM_LOCK
  98 static inline void kernel_param_unlock(struct module *mod)
  99 {
 100         __kernel_param_unlock();
 101 }
 102
 103 static inline void kernel_param_lock(struct module *mod)
 104 {
 105         __kernel_param_lock();
 106 }
 107 #endif /* ! HAVE_KERNEL_PARAM_LOCK */
 108
 109 int cfs_apply_workqueue_attrs(struct workqueue_struct *wq,
 110                               const struct workqueue_attrs *attrs);
 111
 112 #ifndef HAVE_KSTRTOBOOL_FROM_USER
 113
 114 #define kstrtobool strtobool
 115
 116 int kstrtobool_from_user(const char __user *s, size_t count, bool *res);
 117 #endif /* HAVE_KSTRTOBOOL_FROM_USER */
 118
 119 #ifndef HAVE_MATCH_WILDCARD
 120 bool match_wildcard(const char *pattern, const char *str);
 121 #endif /* !HAVE_MATCH_WILDCARD */
 122
 123 #ifndef HAVE_KREF_READ
 124 static inline int kref_read(const struct kref *kref)
 125 {
 126         return atomic_read(&kref->refcount);
 127 }
 128 #endif /* HAVE_KREF_READ */
 129
 130 int cfs_arch_init(void);
 131 void cfs_arch_exit(void);
 132
 133 #ifndef container_of_safe
 134 /**
 135  * container_of_safe - cast a member of a structure out to the containing structure
 136  * @ptr:        the pointer to the member.
 137  * @type:       the type of the container struct this is embedded in.
 138  * @member:     the name of the member within the struct.
 139  *
 140  * If IS_ERR_OR_NULL(ptr), ptr is returned unchanged.
 141  *
 142  * Note: Copied from Linux 5.6, with BUILD_BUG_ON_MSG section removed.
 143  */
 144 #define container_of_safe(ptr, type, member) ({                         \
 145         void *__mptr = (void *)(ptr);                                   \
 146         IS_ERR_OR_NULL(__mptr) ? ERR_CAST(__mptr) :                     \
 147                 ((type *)(__mptr - offsetof(type, member))); })
 148 #endif
 149
 150 /*
 151  * Linux v4.15-rc2-5-g4229a470175b added sizeof_field()
 152  * Linux v5.5-rc4-1-g1f07dcc459d5 removed FIELD_SIZEOF()
 153  * Proved a sizeof_field in terms of FIELD_SIZEOF() when one is not provided
 154  */
 155 #ifndef sizeof_field
 156 #define sizeof_field(type, member)      FIELD_SIZEOF(type, member)
 157 #endif
 158
 159 #ifndef HAVE_TASK_IS_RUNNING
 160 #define task_is_running(task)           (task->state == TASK_RUNNING)
 161 #endif
 162
 163 /* interval tree */
 164 #ifdef HAVE_INTERVAL_TREE_CACHED
 165 #define interval_tree_root rb_root_cached
 166 #define interval_tree_first rb_first_cached
 167 #define INTERVAL_TREE_ROOT RB_ROOT_CACHED
 168 #else
 169 #define interval_tree_root rb_root
 170 #define interval_tree_first rb_first
 171 #define INTERVAL_TREE_ROOT RB_ROOT
 172 #endif /* HAVE_INTERVAL_TREE_CACHED */
 173
 174 /* Linux v5.1-rc5 214d8ca6ee ("stacktrace: Provide common infrastructure")
 175  * CONFIG_ARCH_STACKWALK indicates that save_stack_trace_tsk symbol is not
 176  * exported. Use symbol_get() to find if save_stack_trace_tsk is available.
 177  */
 178 #ifdef CONFIG_ARCH_STACKWALK
 179 int cfs_stack_trace_save_tsk(struct task_struct *task, unsigned long *store,
 180                              unsigned int size, unsigned int skipnr);
 181 #endif
 182
 183 #ifndef memset_startat
 184 /** from linux 5.19 include/linux/string.h: */
 185 #define memset_startat(obj, v, member)                                  \
 186 ({                                                                      \
 187         u8 *__ptr = (u8 *)(obj);                                        \
 188         typeof(v) __val = (v);                                          \
 189         memset(__ptr + offsetof(typeof(*(obj)), member), __val,         \
 190                sizeof(*(obj)) - offsetof(typeof(*(obj)), member));      \
 191 })
 192 #endif /* memset_startat() */
 193
 194 #ifdef HAVE_KALLSYMS_LOOKUP_NAME
 195 static inline void *cfs_kallsyms_lookup_name(const char *name)
 196 {
 197         return (void *)kallsyms_lookup_name(name);
 198 }
 199 #else
 200 static inline void *cfs_kallsyms_lookup_name(const char *name)
 201 {
 202         return NULL;
 203 }
 204 #endif
 205
 206 #ifndef HAVE_STRSCPY
 207 static inline ssize_t strscpy(char *s1, const char *s2, size_t sz)
 208 {
 209         ssize_t len = strlcpy(s1, s2, sz);
 210
 211         return (len >= sz) ? -E2BIG : len;
 212 }
 213 #endif
 214
 215 #ifndef HAVE_BITMAP_TO_ARR32
 216 void bitmap_to_arr32(u32 *buf, const unsigned long *bitmap, unsigned int nbits);
 217 #endif
 218
 219 #ifndef HAVE_KOBJ_TYPE_DEFAULT_GROUPS
 220 #define default_groups                  default_attrs
 221 #define KOBJ_ATTR_GROUPS(_name)         _name##_attrs
 222 #define KOBJ_ATTRIBUTE_GROUPS(_name)
 223 #else
 224 #define KOBJ_ATTR_GROUPS(_name)         _name##_groups
 225 #define KOBJ_ATTRIBUTE_GROUPS(_name)    ATTRIBUTE_GROUPS(_name)
 226 #endif
 227
 228 #endif /* __LIBCFS_LINUX_MISC_H__ */