DEVEL15-util-snprintf-replacement-20090624
[openafs.git] / src / util / afsutil.h
1 /*
2  * Copyright 2000, International Business Machines Corporation and others.
3  * All Rights Reserved.
4  * 
5  * This software has been released under the terms of the IBM Public
6  * License.  For details, see the LICENSE file in the top-level source
7  * directory or online at http://www.openafs.org/dl/license10.html
8  */
9
10 #ifndef _AFSUTIL_H_
11 #define _AFSUTIL_H_
12
13 #include <time.h>
14 /* Include afs installation dir retrieval routines */
15 #include <afs/dirpath.h>
16
17 /* These macros are return values from extractAddr. They do not represent
18  * any valid IP address and so can indicate a failure.
19  */
20 #define AFS_IPINVALID           0xffffffff      /* invalid IP address */
21 #define AFS_IPINVALIDIGNORE     0xfffffffe      /* no input given to extractAddr */
22
23 /* logging defines
24  */
25 #ifndef AFS_NT40_ENV
26 #include <sys/types.h>
27 #include <sys/socket.h>
28 #include <netinet/in.h>
29 #include <arpa/inet.h> /* for inet_ntoa() */
30 #endif
31
32 #include <stdio.h>
33 #include <stdarg.h>
34
35 extern int LogLevel;
36 extern int mrafsStyleLogs;
37 #ifndef AFS_NT40_ENV
38 extern int serverLogSyslog;
39 extern int serverLogSyslogFacility;
40 extern char *serverLogSyslogTag;
41 #endif
42 extern void vFSLog(const char *format, va_list args);
43 extern void SetLogThreadNumProgram(int (*func) (void) );
44
45 /*@printflike@*/ extern void FSLog(const char *format, ...);
46 #define ViceLog(level, str)  do { if ((level) <= LogLevel) (FSLog str); } while (0)
47 #define vViceLog(level, str) do { if ((level) <= LogLevel) (vFSLog str); } while (0)
48
49 extern int OpenLog(const char *filename);
50 extern int ReOpenLog(const char *fileName);
51 extern void SetupLogSignals(void);
52
53 extern int
54 afs_vsnprintf( /*@out@ */ char *p, size_t avail, const char *fmt,
55               va_list ap)
56     /*@requires maxSet(p) >= (avail-1)@ */
57     /*@modifies p@ */ ;
58
59 extern /*@printflike@ */ int
60 afs_snprintf( /*@out@ */ char *p, size_t avail,
61                     const char *fmt, ...)
62     /*@requires maxSet(p) >= (avail-1)@ */
63     /*@modifies p@ */ ;
64
65 extern int
66 afs_vasnprintf (char **ret, size_t max_sz, const char *format, va_list args);
67
68 extern int
69 afs_vasprintf (char **ret, const char *format, va_list args);
70
71 extern int
72 afs_asprintf (char **ret, const char *format, ...);
73
74 extern int
75 afs_asnprintf (char **ret, size_t max_sz, const char *format, ...);
76
77 /* special version of ctime that clobbers a *different static variable, so
78  * that ViceLog can call ctime and not cause buffer confusion.
79  */
80 extern char *vctime(const time_t * atime);
81
82 /* Need a thead safe ctime for pthread builds. Use std ctime for LWP */
83 #if defined(AFS_PTHREAD_ENV) && !defined(AFS_NT40_ENV)
84 #if defined(AFS_SUN5_ENV) && !defined(_POSIX_PTHREAD_SEMANTICS) && (_POSIX_C_SOURCE - 0 < 199506L)
85 #define afs_ctime(C, B, L) ctime_r(C, B, L)
86 #else
87 /* Cast is for platforms which do not prototype ctime_r */
88 #define afs_ctime(C, B, L) (char*)ctime_r(C, B)
89 #endif /* AFS_SUN5_ENV */
90 #else /* AFS_PTHREAD_ENV && !AFS_NT40_ENV */
91 #define afs_ctime(C, B, S) \
92         ((void)strncpy(B, ctime(C), (S-1)), (B)[S-1] = '\0', (B))
93 #endif /* AFS_PTHREAD_ENV && !AFS_NT40_ENV */
94
95
96 /* abort the current process. */
97 #ifdef AFS_NT40_ENV
98 #define afs_abort() afs_NTAbort()
99 #else
100 #define afs_abort() abort()
101 #endif
102
103
104 #ifdef AFS_NT40_ENV
105 #ifndef _MFC_VER
106 #include <winsock2.h>
107 #endif /* _MFC_VER */
108
109 /* Initialize the windows sockets before calling networking routines. */
110      extern int afs_winsockInit(void);
111      extern void afs_winsockCleanup(void);
112
113      struct timezone {
114          int tz_minuteswest;    /* of Greenwich */
115          int tz_dsttime;        /* type of dst correction to apply */
116      };
117 #define gettimeofday afs_gettimeofday
118      int afs_gettimeofday(struct timeval *tv, struct timezone *tz);
119
120 /* Unbuffer output when Un*x would do line buffering. */
121 #define setlinebuf(S) setvbuf(S, NULL, _IONBF, 0)
122
123 /* regular expression parser for NT */
124      extern char *re_comp(char *sp);
125      extern int rc_exec(char *p);
126
127 /* Abort on error, possibly trapping to debugger or dumping a trace. */
128      void afs_NTAbort(void);
129 #endif /* AFS_NT40_ENV */
130
131      typedef char b32_string_t[8];
132 /* b64_string_t is 8 bytes, in stds.h */
133      typedef char lb64_string_t[12];
134
135 #ifndef HAVE_STRLCAT
136 extern size_t strlcat(char *dst, const char *src, size_t siz);
137 #endif
138
139 #ifndef HAVE_STRLCPY
140 extern size_t strlcpy(char *dst, const char *src, size_t siz);
141 #endif
142
143 #ifndef UKERNEL
144 #include "afs/ktime.h"
145 #endif
146 #include "afsutil_prototypes.h"
147
148 #endif /* _AFSUTIL_H_ */