lustre/include/linux/lustre_lib.h

   1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
   2  * vim:expandtab:shiftwidth=8:tabstop=8:
   3  *
   4  * GPL HEADER START
   5  *
   6  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License version 2 only,
  10  * as published by the Free Software Foundation.
  11  *
  12  * This program is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * General Public License version 2 for more details (a copy is included
  16  * in the LICENSE file that accompanied this code).
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * version 2 along with this program; If not, see
  20  * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
  21  *
  22  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
  23  * CA 95054 USA or visit www.sun.com if you need additional information or
  24  * have any questions.
  25  *
  26  * GPL HEADER END
  27  */
  28 /*
  29  * Copyright (c) 2001, 2010, Oracle and/or its affiliates. All rights reserved.
  30  * Use is subject to license terms.
  31  *
  32  * Copyright (c) 2011, 2012, Whamcloud, Inc.
  33  */
  34 /*
  35  * This file is part of Lustre, http://www.lustre.org/
  36  * Lustre is a trademark of Sun Microsystems, Inc.
  37  *
  38  * lustre/include/linux/lustre_lib.h
  39  *
  40  * Basic Lustre library routines.
  41  */
  42
  43 #ifndef _LINUX_LUSTRE_LIB_H
  44 #define _LINUX_LUSTRE_LIB_H
  45
  46 #ifndef _LUSTRE_LIB_H
  47 #error Do not #include this file directly. #include <lustre_lib.h> instead
  48 #endif
  49
  50 #ifndef __KERNEL__
  51 # include <string.h>
  52 # include <sys/types.h>
  53 #else
  54 # include <linux/rwsem.h>
  55 # include <linux/sched.h>
  56 # include <linux/signal.h>
  57 # include <linux/types.h>
  58 #endif
  59 #include <linux/lustre_compat25.h>
  60
  61 #ifndef LP_POISON
  62 #if BITS_PER_LONG > 32
  63 # define LI_POISON ((int)0x5a5a5a5a5a5a5a5a)
  64 # define LL_POISON ((long)0x5a5a5a5a5a5a5a5a)
  65 # define LP_POISON ((void *)(long)0x5a5a5a5a5a5a5a5a)
  66 #else
  67 # define LI_POISON ((int)0x5a5a5a5a)
  68 # define LL_POISON ((long)0x5a5a5a5a)
  69 # define LP_POISON ((void *)(long)0x5a5a5a5a)
  70 #endif
  71 #endif
  72
  73 /* This macro is only for compatibility reasons with older Linux Lustre user
  74  * tools. New ioctls should NOT use this macro as the ioctl "size". Instead
  75  * the ioctl should get a "size" argument which is the actual data type used
  76  * by the ioctl, to ensure the ioctl interface is versioned correctly. */
  77 #define OBD_IOC_DATA_TYPE               long
  78
  79 #define LUSTRE_FATAL_SIGS (sigmask(SIGKILL) | sigmask(SIGINT) |                \
  80                            sigmask(SIGTERM) | sigmask(SIGQUIT) |               \
  81                            sigmask(SIGALRM))
  82
  83 #ifdef __KERNEL__
  84 /* initialize ost_lvb according to inode */
  85 static inline void inode_init_lvb(struct inode *inode, struct ost_lvb *lvb)
  86 {
  87         lvb->lvb_size = i_size_read(inode);
  88         lvb->lvb_blocks = inode->i_blocks;
  89         lvb->lvb_mtime = LTIME_S(inode->i_mtime);
  90         lvb->lvb_atime = LTIME_S(inode->i_atime);
  91         lvb->lvb_ctime = LTIME_S(inode->i_ctime);
  92 }
  93 #else
  94 /* defined in liblustre/llite_lib.h */
  95 #endif
  96
  97 #endif /* _LUSTRE_LIB_H */