common/iobuf.c: Make control flow more obvious.
[gnupg.git] / common / mischelp.h
1 /* mischelp.h - Miscellaneous helper macros and functions
2  * Copyright (C) 1999, 2000, 2001, 2002, 2003,
3  *               2006, 2007, 2009  Free Software Foundation, Inc.
4  *
5  * This file is part of GnuPG.
6  *
7  * GnuPG is free software; you can redistribute it and/or modify it
8  * under the terms of either
9  *
10  *   - the GNU Lesser General Public License as published by the Free
11  *     Software Foundation; either version 3 of the License, or (at
12  *     your option) any later version.
13  *
14  * or
15  *
16  *   - the GNU General Public License as published by the Free
17  *     Software Foundation; either version 2 of the License, or (at
18  *     your option) any later version.
19  *
20  * or both in parallel, as here.
21  *
22  * GnuPG is distributed in the hope that it will be useful, but
23  * WITHOUT ANY WARRANTY; without even the implied warranty of
24  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
25  * General Public License for more details.
26  *
27  * You should have received a copies of the GNU General Public License
28  * and the GNU Lesser General Public License along with this program;
29  * if not, see <http://www.gnu.org/licenses/>.
30  */
31
32 #ifndef GNUPG_COMMON_MISCHELP_H
33 #define GNUPG_COMMON_MISCHELP_H
34
35
36 /* Check whether the files NAME1 and NAME2 are identical.  This is for
37    example achieved by comparing the inode numbers of the files.  */
38 int same_file_p (const char *name1, const char *name2);
39
40
41 #ifndef HAVE_TIMEGM
42 #include <time.h>
43 time_t timegm (struct tm *tm);
44 #endif /*!HAVE_TIMEGM*/
45
46
47 #define DIM(v)               (sizeof(v)/sizeof((v)[0]))
48 #define DIMof(type,member)   DIM(((type *)0)->member)
49
50
51 /* Replacements for macros not available with libgpg-error < 1.20.  */
52 #ifndef GPGRT_GCC_VERSION
53
54 # undef GPGRT_HAVE_PRAGMA_GCC_PUSH
55 # if __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 5 )
56 #  define GPGRT_HAVE_MACRO_FUNCTION 1  /* __FUNCTION__ macro is available.  */
57 #  define GPGRT_ATTR_NORETURN  __attribute__ ((noreturn))
58 #  if __GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 4 )
59 #    define GPGRT_HAVE_PRAGMA_GCC_PUSH 1
60 #    define GPGRT_ATTR_PRINTF(f,a) \
61                   __attribute__ ((format (__gnu_printf__,f,a)))
62 #    define GPGRT_ATTR_NR_PRINTF(f,a) \
63                   __attribute__ ((noreturn, format (__gnu_printf__,f,a)))
64 #  else
65 #    define GPGRT_ATTR_PRINTF(f, a) \
66                   __attribute__ ((format (printf,f,a)))
67 #    define GPGRT_ATTR_NR_PRINTF(f, a) \
68                   __attribute__ ((noreturn, format (printf,f,a)))
69 #  endif
70 # else
71 #  define GPGRT_ATTR_NORETURN
72 #  define GPGRT_ATTR_PRINTF( f, a )
73 #  define GPGRT_ATTR_NR_PRINTF( f, a )
74 # endif
75
76 #endif /*Older libgpg-error.  */
77
78 /* To avoid that a compiler optimizes certain memset calls away, these
79    macros may be used instead. */
80 #define wipememory2(_ptr,_set,_len) do { \
81               volatile char *_vptr=(volatile char *)(_ptr); \
82               size_t _vlen=(_len); \
83               while(_vlen) { *_vptr=(_set); _vptr++; _vlen--; } \
84                   } while(0)
85 #define wipememory(_ptr,_len) wipememory2(_ptr,0,_len)
86
87
88 /* Include hacks which are mainly required for Slowaris.  */
89 #ifdef GNUPG_COMMON_NEED_AFLOCAL
90 #ifndef HAVE_W32_SYSTEM
91 # include <sys/socket.h>
92 # include <sys/un.h>
93 #else
94 # ifdef HAVE_WINSOCK2_H
95 #  include <winsock2.h>
96 # endif
97 # include <windows.h>
98 #endif
99
100 #ifndef PF_LOCAL
101 # ifdef PF_UNIX
102 #  define PF_LOCAL PF_UNIX
103 # else
104 #  define PF_LOCAL AF_UNIX
105 # endif
106 #endif /*PF_LOCAL*/
107 #ifndef AF_LOCAL
108 # define AF_LOCAL AF_UNIX
109 #endif /*AF_UNIX*/
110
111 /* We used to avoid this macro in GnuPG and inlined the AF_LOCAL name
112    length computation directly with the little twist of adding 1 extra
113    byte.  It seems that this was needed once on an old HP/UX box and
114    there are also rumours that 4.3 Reno and DEC systems need it.  This
115    one-off buglet did not harm any current system until it came to Mac
116    OS X where the kernel (as of May 2009) exhibited a strange bug: The
117    systems basically froze in the connect call if the passed name
118    contained an invalid directory part.  Ignore the old Unices.  */
119 #ifndef SUN_LEN
120 # define SUN_LEN(ptr) ((size_t) (((struct sockaddr_un *) 0)->sun_path) \
121                        + strlen ((ptr)->sun_path))
122 #endif /*SUN_LEN*/
123 #endif /*GNUPG_COMMON_NEED_AFLOCAL*/
124
125
126 #endif /*GNUPG_COMMON_MISCHELP_H*/