lnet/include/linux/portals_lib.h

   1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
   2  * vim:expandtab:shiftwidth=8:tabstop=8:
   3  *
   4  *  Copyright (C) 2001 Cluster File Systems, Inc. <braam@clusterfs.com>
   5  *
   6  *   This file is part of Lustre, http://www.lustre.org.
   7  *
   8  *   Lustre is free software; you can redistribute it and/or
   9  *   modify it under the terms of version 2 of the GNU General Public
  10  *   License as published by the Free Software Foundation.
  11  *
  12  *   Lustre is distributed in the hope that it will be useful,
  13  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  *   GNU General Public License for more details.
  16  *
  17  *   You should have received a copy of the GNU General Public License
  18  *   along with Lustre; if not, write to the Free Software
  19  *   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  20  *
  21  * Basic library routines.
  22  *
  23  */
  24
  25 #ifndef _PORTALS_LIB_H
  26 #define _PORTALS_LIB_H
  27
  28 #ifndef __KERNEL__
  29 # include <string.h>
  30 #else
  31 # include <asm/types.h>
  32 #endif
  33
  34 #undef MIN
  35 #define MIN(a,b) (((a)<(b)) ? (a): (b))
  36 #undef MAX
  37 #define MAX(a,b) (((a)>(b)) ? (a): (b))
  38 #define MKSTR(ptr) ((ptr))? (ptr) : ""
  39
  40 static inline int size_round (int val)
  41 {
  42         return (val + 7) & (~0x7);
  43 }
  44
  45 static inline int size_round0(int val)
  46 {
  47         if (!val)
  48                 return 0;
  49         return (val + 1 + 7) & (~0x7);
  50 }
  51
  52 static inline size_t round_strlen(char *fset)
  53 {
  54         return size_round(strlen(fset) + 1);
  55 }
  56
  57 #ifdef __KERNEL__
  58 static inline char *strdup(const char *str)
  59 {
  60         int len = strlen(str) + 1;
  61         char *tmp = kmalloc(len, GFP_KERNEL);
  62         if (tmp)
  63                 memcpy(tmp, str, len);
  64
  65         return tmp;
  66 }
  67 #endif
  68
  69 #ifdef __KERNEL__
  70 # define NTOH__u32(var) le32_to_cpu(var)
  71 # define NTOH__u64(var) le64_to_cpu(var)
  72 # define HTON__u32(var) cpu_to_le32(var)
  73 # define HTON__u64(var) cpu_to_le64(var)
  74 #else
  75 # define expansion_u64(var) \
  76     ({  __u64 ret; \
  77        switch (sizeof(var)) {   \
  78        case 8: (ret) = (var); break; \
  79        case 4: (ret) = (__u32)(var); break; \
  80        case 2: (ret) = (__u16)(var); break; \
  81        case 1: (ret) = (__u8)(var); break; \
  82        };       \
  83        (ret);     \
  84     })
  85 # define NTOH__u32(var) (var)
  86 # define NTOH__u64(var) (expansion_u64(var))
  87 # define HTON__u32(var) (var)
  88 # define HTON__u64(var) (expansion_u64(var))
  89 #endif
  90
  91 /*
  92  * copy sizeof(type) bytes from pointer to var and move ptr forward.
  93  * return EFAULT if pointer goes beyond end
  94  */
  95 #define UNLOGV(var,type,ptr,end)                \
  96 do {                                            \
  97         var = *(type *)ptr;                     \
  98         ptr += sizeof(type);                    \
  99         if (ptr > end )                         \
 100                 return -EFAULT;                 \
 101 } while (0)
 102
 103 /* the following two macros convert to little endian */
 104 /* type MUST be __u32 or __u64 */
 105 #define LUNLOGV(var,type,ptr,end)               \
 106 do {                                            \
 107         var = NTOH##type(*(type *)ptr);         \
 108         ptr += sizeof(type);                    \
 109         if (ptr > end )                         \
 110                 return -EFAULT;                 \
 111 } while (0)
 112
 113 /* now log values */
 114 #define LOGV(var,type,ptr)                      \
 115 do {                                            \
 116         *((type *)ptr) = var;                   \
 117         ptr += sizeof(type);                    \
 118 } while (0)
 119
 120 /* and in network order */
 121 #define LLOGV(var,type,ptr)                     \
 122 do {                                            \
 123         *((type *)ptr) = HTON##type(var);       \
 124         ptr += sizeof(type);                    \
 125 } while (0)
 126
 127
 128 /*
 129  * set var to point at (type *)ptr, move ptr forward with sizeof(type)
 130  * return from function with EFAULT if ptr goes beyond end
 131  */
 132 #define UNLOGP(var,type,ptr,end)                \
 133 do {                                            \
 134         var = (type *)ptr;                      \
 135         ptr += sizeof(type);                    \
 136         if (ptr > end )                         \
 137                 return -EFAULT;                 \
 138 } while (0)
 139
 140 #define LOGP(var,type,ptr)                      \
 141 do {                                            \
 142         memcpy(ptr, var, sizeof(type));         \
 143         ptr += sizeof(type);                    \
 144 } while (0)
 145
 146 /*
 147  * set var to point at (char *)ptr, move ptr forward by size_round(len);
 148  * return from function with EFAULT if ptr goes beyond end
 149  */
 150 #define UNLOGL(var,type,len,ptr,end)            \
 151 do {                                            \
 152         var = (type *)ptr;                      \
 153         ptr += size_round(len * sizeof(type));  \
 154         if (ptr > end )                         \
 155                 return -EFAULT;                 \
 156 } while (0)
 157
 158 #define UNLOGL0(var,type,len,ptr,end)                                   \
 159 do {                                                                    \
 160         UNLOGL(var,type,len,ptr,end);                                   \
 161         if ( *((char *)ptr - size_round(len) + len - 1) != '\0')        \
 162                 return -EFAULT;                                         \
 163 } while (0)
 164
 165 #define LOGL(var,len,ptr)                                       \
 166 do {                                                            \
 167         if (var)                                                \
 168                 memcpy((char *)ptr, (const char *)var, len);    \
 169         ptr += size_round(len);                                 \
 170 } while (0)
 171
 172 #define LOGU(var,len,ptr)                                       \
 173 do {                                                            \
 174         if (var)                                                \
 175                 memcpy((char *)var, (const char *)ptr, len);    \
 176         ptr += size_round(len);                                 \
 177 } while (0)
 178
 179 #define LOGL0(var,len,ptr)                              \
 180 do {                                                    \
 181         if (!len)                                       \
 182                 break;                                  \
 183         memcpy((char *)ptr, (const char *)var, len);    \
 184         *((char *)(ptr) + len) = 0;                     \
 185         ptr += size_round(len + 1);                     \
 186 } while (0)
 187
 188 #endif /* _PORTALS_LIB_H */