W32CE fix.
[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 JNLIB.
6  *
7  * JNLIB is free software; you can redistribute it and/or modify it
8  * under the terms of the GNU Lesser General Public License as
9  * published by the Free Software Foundation; either version 3 of
10  * the License, or (at your option) any later version.
11  *
12  * JNLIB 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  * Lesser General Public License for more details.
16  *
17  * You should have received a copy of the GNU Lesser General Public
18  * License along with this program; if not, see <http://www.gnu.org/licenses/>.
19  */
20
21 #ifndef LIBJNLIB_MISCHELP_H
22 #define LIBJNLIB_MISCHHELP_H
23
24
25 /* Because we can't use the internal jnlib_free macro in inline
26    functions we provide a wrapper function as well.   */
27 void _jnlib_free (void *p);
28
29 /* Check whether the files NAME1 and NAME2 are identical.  This is for
30    example achieved by comparing the inode numbers of the files.  */
31 int same_file_p (const char *name1, const char *name2);
32
33
34 #ifndef HAVE_TIMEGM
35 #include <time.h>
36 time_t timegm (struct tm *tm);
37 #endif /*!HAVE_TIMEGM*/
38
39
40 #define DIM(v)               (sizeof(v)/sizeof((v)[0]))
41 #define DIMof(type,member)   DIM(((type *)0)->member)
42
43
44 #if __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 5 )
45 # define JNLIB_GCC_M_FUNCTION 1
46 # define JNLIB_GCC_A_NR              __attribute__ ((noreturn))
47 # define JNLIB_GCC_A_PRINTF( f, a )  __attribute__ ((format (printf,f,a)))
48 # define JNLIB_GCC_A_NR_PRINTF( f, a ) \
49                             __attribute__ ((noreturn, format (printf,f,a)))
50 #else
51 # define JNLIB_GCC_A_NR
52 # define JNLIB_GCC_A_PRINTF( f, a )
53 # define JNLIB_GCC_A_NR_PRINTF( f, a )
54 #endif
55
56
57 /* To avoid that a compiler optimizes certain memset calls away, these
58    macros may be used instead. */
59 #define wipememory2(_ptr,_set,_len) do { \
60               volatile char *_vptr=(volatile char *)(_ptr); \
61               size_t _vlen=(_len); \
62               while(_vlen) { *_vptr=(_set); _vptr++; _vlen--; } \
63                   } while(0)
64 #define wipememory(_ptr,_len) wipememory2(_ptr,0,_len)
65
66
67 /* Include hacks which are mainly required for Slowaris.  */
68 #ifdef JNLIB_NEED_AFLOCAL
69 #ifndef HAVE_W32_SYSTEM
70 # include <sys/socket.h>
71 # include <sys/un.h>
72 #else
73 # include <windows.h>
74 #endif
75
76 #ifndef PF_LOCAL
77 # ifdef PF_UNIX
78 #  define PF_LOCAL PF_UNIX
79 # else
80 #  define PF_LOCAL AF_UNIX
81 # endif
82 #endif /*PF_LOCAL*/
83 #ifndef AF_LOCAL
84 # define AF_LOCAL AF_UNIX
85 #endif /*AF_UNIX*/
86
87 /* We used to avoid this macro in GnuPG and inlined the AF_LOCAL name
88    length computation directly with the little twist of adding 1 extra
89    byte.  It seems that this was needed once on an old HP/UX box and
90    there are also rumours that 4.3 Reno and DEC systems need it.  This
91    one-off buglet did not harm any current system until it came to Mac
92    OS X where the kernel (as of May 2009) exhibited a strange bug: The
93    systems basically froze in the connect call if the passed name
94    contained an invalid directory part.  Ignore the old Unices.  */
95 #ifndef SUN_LEN
96 # define SUN_LEN(ptr) ((size_t) (((struct sockaddr_un *) 0)->sun_path) \
97                        + strlen ((ptr)->sun_path))
98 #endif /*SUN_LEN*/
99 #endif /*JNLIB_NEED_AFLOCAL*/
100
101
102 #endif /*LIBJNLIB_MISCHELP_H*/