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
  39 #include <libcfs/linux/linux-misc.h>
  40 #include <libcfs/linux/linux-time.h>
  41 #include <libcfs/linux/linux-wait.h>
  42
  43 #include <uapi/linux/lnet/libcfs_ioctl.h>
  44 #include <libcfs/libcfs_debug.h>
  45 #include <libcfs/libcfs_private.h>
  46 #include <libcfs/bitmap.h>
  47 #include <libcfs/libcfs_cpu.h>
  48 #include <libcfs/libcfs_prim.h>
  49 #include <libcfs/libcfs_string.h>
  50 #include <libcfs/libcfs_workitem.h>
  51 #include <libcfs/libcfs_hash.h>
  52 #include <libcfs/libcfs_heap.h>
  53 #include <libcfs/libcfs_fail.h>
  54 #include "curproc.h"
  55
  56 #define LIBCFS_VERSION  "0.7.1"
  57
  58 #define PO2_ROUNDUP_TYPED(x, po2, type) (-(-(type)(x) & -(type)(po2)))
  59 #define LOWEST_BIT_SET(x) ((x) & ~((x) - 1))
  60
  61 /* Sparse annotations */
  62 #if !defined(__must_hold)
  63 # ifdef __CHECKER__
  64 #  define __must_hold(x) __attribute__((context(x, 1, 1)))
  65 # else  /* __CHECKER__ */
  66 #  define __must_hold(x)
  67 # endif /* !__CHECKER__ */
  68 #endif /* !__must_hold */
  69
  70 /* libcfs watchdogs */
  71 struct lc_watchdog;
  72
  73 /* Add a watchdog which fires after "time" milliseconds of delay.  You have to
  74  * touch it once to enable it. */
  75 struct lc_watchdog *lc_watchdog_add(int time,
  76                                     void (*cb)(pid_t pid, void *),
  77                                     void *data);
  78
  79 /* Enables a watchdog and resets its timer. */
  80 void lc_watchdog_touch(struct lc_watchdog *lcw, int timeout);
  81 #define CFS_GET_TIMEOUT(svc) (max_t(int, obd_timeout,                   \
  82                           AT_OFF ? 0 : at_get(&svc->srv_at_estimate)) * \
  83                           svc->srv_watchdog_factor)
  84
  85 /* Disable a watchdog; touch it to restart it. */
  86 void lc_watchdog_disable(struct lc_watchdog *lcw);
  87
  88 /* Clean up the watchdog */
  89 void lc_watchdog_delete(struct lc_watchdog *lcw);
  90
  91 /* need both kernel and user-land acceptor */
  92 #define LNET_ACCEPTOR_MIN_RESERVED_PORT    512
  93 #define LNET_ACCEPTOR_MAX_RESERVED_PORT    1023
  94
  95 extern struct blocking_notifier_head libcfs_ioctl_list;
  96 static inline int notifier_from_ioctl_errno(int err)
  97 {
  98         if (err == -EINVAL)
  99                 return NOTIFY_OK;
 100         return notifier_from_errno(err) | NOTIFY_STOP_MASK;
 101 }
 102
 103 /*
 104  * Defined by platform
 105  */
 106 int unshare_fs_struct(void);
 107 sigset_t cfs_block_allsigs(void);
 108 sigset_t cfs_block_sigs(unsigned long sigs);
 109 sigset_t cfs_block_sigsinv(unsigned long sigs);
 110 void cfs_restore_sigs(sigset_t);
 111 void cfs_clear_sigpending(void);
 112
 113 /*
 114  * Random number handling
 115  */
 116
 117 /* returns a random 32-bit integer */
 118 unsigned int cfs_rand(void);
 119 /* seed the generator */
 120 void cfs_srand(unsigned int, unsigned int);
 121 void cfs_get_random_bytes(void *buf, int size);
 122
 123 int libcfs_ioctl_data_adjust(struct libcfs_ioctl_data *data);
 124 int libcfs_ioctl(unsigned long cmd, void __user *uparam);
 125
 126 /* container_of depends on "likely" which is defined in libcfs_private.h */
 127 static inline void *__container_of(const void *ptr, unsigned long shift)
 128 {
 129         if (unlikely(IS_ERR(ptr) || ptr == NULL))
 130                 return ERR_CAST(ptr);
 131         else
 132                 return (char *)ptr - shift;
 133 }
 134
 135 #define container_of0(ptr, type, member) \
 136         ((type *)__container_of((ptr), offsetof(type, member)))
 137
 138 struct lnet_debugfs_symlink_def {
 139         const char *name;
 140         const char *target;
 141 };
 142
 143 void lnet_insert_debugfs(struct ctl_table *table);
 144 void lnet_remove_debugfs(struct ctl_table *table);
 145
 146 /* helper for sysctl handlers */
 147 int lprocfs_call_handler(void *data, int write, loff_t *ppos,
 148                          void __user *buffer, size_t *lenp,
 149                          int (*handler)(void *data, int write, loff_t pos,
 150                                         void __user *buffer, int len));
 151
 152 #endif /* _LIBCFS_LIBCFS_H_ */