libcfs/include/libcfs/libcfs.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_LIBCFS_H__
  34 #define __LIBCFS_LIBCFS_H__
  35
  36 #include <linux/kernel.h>
  37 #include <linux/module.h>
  38 #include <linux/workqueue.h>
  39 #include <linux/sched.h>
  40 #ifdef HAVE_SCHED_HEADERS
  41 #include <linux/sched/signal.h>
  42 #endif
  43
  44 #include <libcfs/linux/linux-misc.h>
  45 #include <libcfs/linux/linux-mem.h>
  46 #include <libcfs/linux/linux-time.h>
  47 #include <libcfs/linux/linux-wait.h>
  48
  49 #include <uapi/linux/lnet/libcfs_ioctl.h>
  50 #include <libcfs/libcfs_debug.h>
  51 #include <libcfs/libcfs_private.h>
  52 #include <libcfs/bitmap.h>
  53 #include <libcfs/libcfs_cpu.h>
  54 #include <libcfs/libcfs_string.h>
  55 #include <libcfs/libcfs_workitem.h>
  56 #include <libcfs/libcfs_hash.h>
  57 #include <libcfs/libcfs_fail.h>
  58 #include "curproc.h"
  59
  60 #define LIBCFS_VERSION  "0.7.1"
  61
  62 #define PO2_ROUNDUP_TYPED(x, po2, type) (-(-(type)(x) & -(type)(po2)))
  63 #define LOWEST_BIT_SET(x) ((x) & ~((x) - 1))
  64
  65 /* Sparse annotations */
  66 #if !defined(__must_hold)
  67 # ifdef __CHECKER__
  68 #  define __must_hold(x) __attribute__((context(x, 1, 1)))
  69 # else  /* __CHECKER__ */
  70 #  define __must_hold(x)
  71 # endif /* !__CHECKER__ */
  72 #endif /* !__must_hold */
  73
  74 typedef s32 timeout_t;
  75
  76 /* need both kernel and user-land acceptor */
  77 #define LNET_ACCEPTOR_MIN_RESERVED_PORT    512
  78 #define LNET_ACCEPTOR_MAX_RESERVED_PORT    1023
  79
  80 extern struct blocking_notifier_head libcfs_ioctl_list;
  81 static inline int notifier_from_ioctl_errno(int err)
  82 {
  83         if (err == -EINVAL)
  84                 return NOTIFY_OK;
  85         return notifier_from_errno(err) | NOTIFY_STOP_MASK;
  86 }
  87
  88 int libcfs_ioctl_data_adjust(struct libcfs_ioctl_data *data);
  89
  90 extern struct workqueue_struct *cfs_rehash_wq;
  91
  92 struct lnet_debugfs_symlink_def {
  93         const char *name;
  94         const char *target;
  95 };
  96
  97 void lnet_insert_debugfs(struct ctl_table *table);
  98 void lnet_remove_debugfs(struct ctl_table *table);
  99
 100 /* helper for sysctl handlers */
 101 int lprocfs_call_handler(void *data, int write, loff_t *ppos,
 102                          void __user *buffer, size_t *lenp,
 103                          int (*handler)(void *data, int write, loff_t pos,
 104                                         void __user *buffer, int len));
 105
 106 /*
 107  * Memory
 108  */
 109 #if BITS_PER_LONG == 32
 110 /* limit to lowmem on 32-bit systems */
 111 #define NUM_CACHEPAGES \
 112         min(cfs_totalram_pages(), 1UL << (30 - PAGE_SHIFT) * 3 / 4)
 113 #else
 114 #define NUM_CACHEPAGES cfs_totalram_pages()
 115 #endif
 116
 117 #define wait_var_event_warning(var, condition, format, ...)             \
 118 do {                                                                    \
 119         int counter = 4;                                                \
 120         might_sleep();                                                  \
 121         if (condition)                                                  \
 122                 break;                                                  \
 123         ___wait_var_event(var, condition, TASK_UNINTERRUPTIBLE, 0, 0,   \
 124                           if (schedule_timeout(cfs_time_seconds(1)) == 0)\
 125                                   CDEBUG(is_power_of_2(counter++) ?     \
 126                                          D_WARNING : D_NET,             \
 127                                          format, ## __VA_ARGS__)        \
 128                 );                                                      \
 129 } while (0)
 130
 131 /* atomic-context safe vfree */
 132 void libcfs_vfree_atomic(const void *addr);
 133
 134 #endif /* _LIBCFS_LIBCFS_H_ */