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