clang-10: use AFS_FALLTHROUGH for case fallthrough
[openafs.git] / src / config / stds.h
index 10e184a..254856d 100644 (file)
@@ -1,21 +1,27 @@
 /*
  * Copyright 2000, International Business Machines Corporation and others.
  * All Rights Reserved.
- * 
+ *
  * This software has been released under the terms of the IBM Public
  * License.  For details, see the LICENSE file in the top-level source
  * directory or online at http://www.openafs.org/dl/license10.html
  */
 
-#ifndef TRANSARC_AFS_CONFIG_STDS_H
-#define TRANSARC_AFS_CONFIG_STDS_H     1
+/*
+ * Do not put anything in this file that relies on Autoconf defines, since
+ * we're not guaranteed to have included afsconfig.h before this header file.
+ * This is an installed header file, and afsconfig.h is not.
+ */
+
+#ifndef OPENAFS_AFS_CONFIG_STDS_H
+#define OPENAFS_AFS_CONFIG_STDS_H      1
 
 #include <afs/param.h>
 #include <sys/types.h>
 
-#define IN              /* indicates a parameter is read in */
-#define OUT             /* indicates a parameter is sent out (a ptr) */
-#define INOUT           /* indicates a parameter is read in and sent out (a ptr) */
+#define IN                     /* indicates a parameter is read in */
+#define OUT                    /* indicates a parameter is sent out (a ptr) */
+#define INOUT                  /* indicates a parameter is read in and sent out (a ptr) */
 
 #ifndef        MACRO_BEGIN
 #define MACRO_BEGIN    do {
@@ -44,46 +50,48 @@ pragma Off(Prototype_override_warnings);
 #error We require size of long and pointers to be equal
 #endif */
 
-typedef short            afs_int16;
-typedef unsigned short   afs_uint16;
-#ifdef  AFS_64BIT_ENV
-typedef int              afs_int32;
-typedef unsigned int     afs_uint32;
-typedef long long       afs_int64;
-typedef  unsigned long long afs_uint64;
-#define ZeroInt64(a)       (a) = 0
-#define AssignInt64(a, b)   *(a) = (b)
-#define AddInt64(a,b,c) *(c) = (a) + (b)
-#define SubtractInt64(a,b,c) *(c) = (a) - (b)
-#define CompareInt64(a,b) (a) - (b)
+#define MAX_AFS_INT32 0x7FFFFFFF
+#define MIN_AFS_INT32 (-MAX_AFS_INT32 - 1)
+#define MAX_AFS_UINT32 0xFFFFFFFF
+#define MAX_AFS_INT64 0x7FFFFFFFFFFFFFFFL
+#define MIN_AFS_INT64 (-MAX_AFS_INT64 - 1)
+#define MAX_AFS_UINT64 0xFFFFFFFFFFFFFFFFL
+
+typedef short afs_int16;
+typedef unsigned short afs_uint16;
+typedef int afs_int32;
+typedef unsigned int afs_uint32;
+#if defined(AFS_NT40_ENV) && defined(_MSC_VER)
+typedef __int64 afs_int64;
+typedef unsigned __int64 afs_uint64;
+#else
+typedef long long afs_int64;
+typedef unsigned long long afs_uint64;
+#endif
+#define ZeroInt64(a)       ((a) = 0)
+#define AssignInt64(a, b) *(b) = (a)
+#define IncInt64(a) ((*(a))++)
+#define IncUInt64(a) ((*(a))++)
+#define DecInt64(a) ((*(a))--)
+#define DecUInt64(a) ((*(a))--)
+#define GTInt64(a,b) ((a) > (b))
+#define GEInt64(a,b) ((a) >= (b))
+#define LEInt64(a,b) ((a) <= (b))
+#define LTInt64(a,b) ((a) < (b))
+#define AddInt64(a,b,c) *(c) = (afs_int64)(a) + (afs_int64)(b)
+#define AddUInt64(a,b,c) *(c) = (afs_uint64)(a) + (afs_uint64)(b)
+#define SubtractInt64(a,b,c) *(c) = (afs_int64)(a) - (afs_int64)(b)
+#define SubtractUInt64(a,b,c) *(c) = (afs_uint64)(a) - (afs_uint64)(b)
+#define CompareInt64(a,b) ((afs_int64)(a) - (afs_int64)(b))
+#define CompareUInt64(a,b) ((afs_uint64)(a) - (afs_uint64)(b))
 #define NonZeroInt64(a)                (a)
-#define Int64ToInt32(a)    (a) & 0xFFFFFFFFL
-#define FillInt64(t,h,l) (t) = (h); (t) <<= 32; (t) |= (l);
-#define SplitInt64(t,h,l) (h) = (t) >> 32; (l) = (t) & 0xFFFFFFFF;
-#else   /* AFS_64BIT_ENV */
-typedef long             afs_int32;
-typedef unsigned long    afs_uint32;
-
-struct Int64 {
-    afs_int32 high;
-    afs_uint32 low;
-};
-typedef struct Int64 afs_int64;
-
-struct u_Int64 {
-    afs_uint32 high;
-    afs_uint32 low;
-};
-typedef struct u_Int64 afs_uint64;
-#define ZeroInt64(a) (a).high = (a).low = 0
-#define AssignInt64(a, b) (b)->high = (a).high; (b)->low = (a).low
-#define NonZeroInt64(a)   (a).low || (a).high
-#define Int64ToInt32(a)    (a).low
-#define FillInt64(t,h,l) (t).high = (h); (t).low = (l);
-#define SplitInt64(t,h,l) (h) = (t).high; (l) = (t).low;
-#endif  /* AFS_64BIT_ENV */
-
-/* AFS_64BIT_CLIENT should presently be set only for AFS_64BIT_ENV systems */
+#ifndef HAVE_INT64TOINT32
+#define Int64ToInt32(a)    ((a) & MAX_AFS_UINT32)
+#endif
+#define FillInt64(t,h,l) (t) = ((afs_int64)(h) << 32) | (l)
+#define SplitInt64(t,h,l) (h) = ((afs_int64)(t)) >> 32; (l) = (t) & MAX_AFS_UINT32
+#define RoundInt64ToInt32(a)    (((a) > MAX_AFS_UINT32) ? MAX_AFS_UINT32 : (a))
+#define RoundInt64ToInt31(a)    (((a) > MAX_AFS_INT32) ? MAX_AFS_INT32 : (a))
 
 #ifdef AFS_64BIT_CLIENT
 typedef afs_int64 afs_size_t;
@@ -93,6 +101,21 @@ typedef afs_int32 afs_size_t;
 typedef afs_uint32 afs_offs_t;
 #endif /* AFS_64BIT_CLIENT */
 
+typedef afs_int64 afs_foff_t;
+typedef afs_uint64 afs_fsize_t;
+typedef afs_int64 afs_sfsize_t;
+#define SplitOffsetOrSize(t,h,l) SplitInt64(t,h,l)
+
+/* Maximum integer sizes.  Also what is expected by %lld, %llu in
+ * afs_snprintf. */
+#ifdef AFS_64BIT_CLIENT
+typedef afs_int64 afs_intmax_t;
+typedef afs_uint64 afs_uintmax_t;
+#else /* !AFS_64BIT_CLIENT */
+typedef afs_int32 afs_intmax_t;
+typedef afs_uint32 afs_uintmax_t;
+#endif /* !AFS_64BIT_CLIENT */
+
 /* you still have to include <netinet/in.h> to make these work */
 
 #define hton32 htonl
@@ -105,31 +128,7 @@ typedef afs_uint32 afs_offs_t;
  * some assistence in this matter.  The hyper type is supposed to be compatible
  * with the afsHyper type: the same macros will work on both. */
 
-#if    defined(AFS_64BIT_ENV) && 0
-
-typedef        unsigned long   afs_hyper_t;
-
-#define        hcmp(a,b)       ((a) < (b) ? -1 : ((a) > (b) ? 1 : 0))
-#define        hsame(a,b)      ((a) == (b))
-#define        hiszero(a)      ((a) == 0)
-#define        hfitsin32(a)    ((a) & 0xffffffff00000000) == 0)
-#define        hset(a,b)       ((a) = (b))
-#define        hzero(a)        ((a) = 0)
-#define        hones(a)        ((a) = ~((unsigned long)0))
-#define        hget32(i,a)     ((i) = (unsigned int)(a))
-#define        hget64(hi,lo,a) ((lo) = ((unsigned int)(a)), (hi) = ((a) & (0xffffffff00000000)))
-#define        hset32(a,i)     ((a) = ((unsigned int)(i)))
-#define        hset64(a,hi,lo) ((a) = (((hi) << 32) | (lo)))
-#define hgetlo(a)      ((a) & 0xffffffff)
-#define hgethi(a)      (((unsigned int)(a)) >> 32)
-#define        hadd(a,b)       ((a) += (b))
-/* XXX */
-#define        hadd32(a,b)     ((a) += (b))
-#define hshlft(a,n)     ((a)<<(n))
-
-#else  /* AFS_64BIT_ENV */
-
-typedef struct afs_hyper_t { /* unsigned 64 bit integers */
+typedef struct afs_hyper_t {   /* unsigned 64 bit integers */
     unsigned int high;
     unsigned int low;
 } afs_hyper_t;
@@ -155,7 +154,7 @@ typedef struct afs_hyper_t { /* unsigned 64 bit integers */
         } else if ((n) >= 2*s) { /*Shift off all bits*/                    \
            (a).high = (a).low = 0;                                         \
         } else if ((n) < s) { /*Part of low shifted into high*/            \
-           (a).high = ((a).high<<(n)) | (((a).low>>(s-(n))) & (1<<(n))-1); \
+           (a).high = ((a).high<<(n)) | (((a).low>>(s-(n))) & ((1<<(n))-1)); \
            (a).low  = (a).low << (n);                                      \
         } else if ((n) >= s) { /*All of low shifted into high plus some*/  \
            (a).high = (a).low << ((n)-s);                                  \
@@ -170,15 +169,14 @@ typedef struct afs_hyper_t { /* unsigned 64 bit integers */
 
 #define SIGN 0x80000000
 #define hadd32(a,i) \
-    (((((a).low ^ (int)(i)) & SIGN) \
+    ((void)((((a).low ^ (int)(i)) & SIGN) \
       ? (((((a).low + (int)(i)) & SIGN) == 0) && (a).high++) \
       : (((a).low & (int)(i) & SIGN) && (a).high++)), \
      (a).low += (int)(i))
 
 #define hadd(a,b) (hadd32(a,(b).low), (a).high += (b).high)
-#endif /* AFS_64BIT_ENV */
 
-#ifndef        KERNEL
+#if !defined(KERNEL) || defined(UKERNEL)
 #ifndef AFS_NT40_ENV
 #define max(a, b)               ((a) < (b) ? (b) : (a))
 #define min(a, b)               ((a) > (b) ? (b) : (a))
@@ -186,15 +184,9 @@ typedef struct afs_hyper_t { /* unsigned 64 bit integers */
 /*#define abs(x)                  ((x) >= 0 ? (x) : -(x))*/
 #endif
 
-#if defined(AFS_LINUX20_ENV) && defined(KERNEL)
-/* This is here instead of osi_machdep.h so fcrypt.c can pick it up. */
-#include "../h/string.h"
-#define bcopy(F,T,C) memcpy((T), (F), (C))
-#endif
-
-
 /* minumum length of string to pass to int_to_base64 */
 typedef char b64_string_t[8];
+#ifndef AFS_NT40_ENV
 #if defined(AFS_HPUX_ENV) || defined(AFS_USR_HPUX_ENV) || (defined(AFS_SUN_ENV) && !defined(AFS_SUN5_ENV))
 char *int_to_base64();
 int base64_to_int();
@@ -202,7 +194,7 @@ int base64_to_int();
 char *int_to_base64(b64_string_t s, int a);
 int base64_to_int(char *s);
 #endif
-
+#endif /* AFS_NT40_ENV */
 /*
  * The afsUUID data type is built in to RX
  */
@@ -215,6 +207,121 @@ struct afsUUID {
     char node[6];
 };
 typedef struct afsUUID afsUUID;
-extern int xdr_afsUUID();
 
-#endif /* TRANSARC_CONFIG_AFS_STDS_H */
+/* for now, demand attach fileserver is only support on unix pthreads builds */
+#if defined(DEMAND_ATTACH_ENABLE) && defined(AFS_PTHREAD_ENV) && !defined(AFS_NT40_ENV)
+#define AFS_DEMAND_ATTACH_FS 1
+#endif
+
+#if defined(BUILD_RXGK) && defined(AFS_PTHREAD_ENV) && !defined(KERNEL)
+/* Only build GSS bits of code on non-kernel pthread builds */
+# define AFS_RXGK_GSS_ENV 1
+#endif
+
+#if defined(ENABLE_RXGK) && !defined(UKERNEL) && (defined(AFS_PTHREAD_ENV) || defined(KERNEL))
+/* Only enable RXGK bits for userspace pthread or non-ukernel kernel code */
+# define AFS_RXGK_ENV 1
+#endif
+
+/* A macro that can be used when printf'ing 64 bit integers, as Unix and
+ * windows use a different format string
+ */
+#ifdef AFS_NT40_ENV
+# define AFS_INT64_FMT "I64d"
+# define AFS_UINT64_FMT "I64u"
+# define AFS_SIZET_FMT "Iu"
+#else
+# define AFS_INT64_FMT "lld"
+# define AFS_UINT64_FMT "llu"
+# ifdef PRINTF_TAKES_Z_LEN
+#  define AFS_SIZET_FMT "zu"
+# else
+#  define AFS_SIZET_FMT "lu"
+# endif /* PRINTF_TAKES_Z_LEN */
+#endif /* AFS_NT40_ENV */
+#define AFS_VOLID_FMT "lu"
+
+/* Functions to safely cast afs_int32 and afs_uint32 so they can be used in
+ * printf statemements with %ld and %lu
+ */
+#ifdef AFS_NT40_ENV
+#define static_inline __inline static
+#define hdr_static_inline(x) __inline static x
+#elif defined(AFS_HPUX_ENV) || defined(AFS_USR_HPUX_ENV)
+/* The HPUX compiler can segfault on 'static __inline', so fall back to
+ * just 'static' so we can at least compile */
+#define static_inline static
+#define hdr_static_inline(x) static x
+#elif defined(AFS_AIX_ENV) || defined(AFS_USR_AIX_ENV)
+#define static_inline static
+#define hdr_static_inline(x) static x
+#elif defined(AFS_SGI_ENV) || defined(AFS_USR_SGI_ENV)
+#define static_inline static
+#define hdr_static_inline(x) x
+#elif defined(AFS_NBSD_ENV) && !defined(AFS_NBSD50_ENV) \
+      && defined(HAVE_FUNC_ATTRIBUTE_ALWAYS_INLINE)
+#define static_inline static __inline __attribute__((always_inline))
+#define hdr_static_inline(x) static __inline __attribute__((always_inline)) x
+#else
+#define static_inline static inline
+#define hdr_static_inline(x) static inline x
+#endif
+
+hdr_static_inline(long) afs_printable_int32_ld(afs_int32 d) { return (long) d; }
+
+hdr_static_inline(unsigned long) afs_printable_uint32_lu(afs_uint32 d) { return (unsigned long) d; }
+
+hdr_static_inline(long long) afs_printable_int64_ld(afs_int64 d) { return (long long) d; }
+
+hdr_static_inline(unsigned long long) afs_printable_uint64_lu(afs_uint64 d) { return (unsigned long long) d; }
+
+#ifdef AFS_64BITUSERPOINTER_ENV
+#define afs_pointer_to_int(p)      ((afs_uint32)  (afs_uint64) (p))
+#define afs_int_to_pointer(i)     ((void *) (afs_uint64) (i))
+#else
+#define afs_pointer_to_int(p)      ((afs_uint32)   (p))
+#define afs_int_to_pointer(i)      ((void *)  (i))
+#endif
+
+#ifdef HAVE_FUNC_ATTRIBUTE_UNUSED
+# define AFS_UNUSED __attribute__((unused))
+#else
+# define AFS_UNUSED
+#endif
+
+#ifdef HAVE_FUNC_ATTRIBUTE_FORMAT
+# define AFS_ATTRIBUTE_FORMAT(style,x,y) __attribute__((format(style, x, y)))
+#else
+# define AFS_ATTRIBUTE_FORMAT(style,x,y)
+#endif
+
+#ifdef HAVE_FUNC_ATTRIBUTE_NORETURN
+# define AFS_NORETURN __attribute__((__noreturn__))
+#else
+# define AFS_NORETURN
+#endif
+
+#ifdef HAVE_FUNC_ATTRIBUTE_NONNULL
+# define AFS_NONNULL(x) __attribute__((__nonnull__ x))
+#else
+# define AFS_NONNULL(x)
+#endif
+
+#if defined(AFS_LINUX26_ENV) && defined(fallthrough)
+# define AFS_FALLTHROUGH fallthrough
+#elif defined(HAVE_FUNC_ATTRIBUTE_FALLTHROUGH)
+# define AFS_FALLTHROUGH __attribute__((fallthrough))
+#else
+# define AFS_FALLTHROUGH do {} while(0)
+#endif
+
+/*
+ * Conditionally remove unreached statements under Solaris Studio.
+ */
+#if defined(__SUNPRO_C)
+# define AFS_UNREACHED(x)
+#else
+# define AFS_UNREACHED(x)  x
+#endif
+
+#endif /* OPENAFS_CONFIG_AFS_STDS_H */