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 #include <stdio.h>
  26 #include <stdarg.h>
  27 extern int LogLevel;
  28 #ifndef AFS_NT40_ENV
  29 extern int serverLogSyslog;
  30 extern int serverLogSyslogFacility;
  31 extern char *serverLogSyslogTag;
  32 #endif
  33 extern void FSLog(const char *format, ...);
  34 #define ViceLog(level, str)  if ((level) <= LogLevel) (FSLog str)
  35
  36 extern int OpenLog(const char *filename);
  37 extern int ReOpenLog(const char *fileName);
  38 extern void SetupLogSignals(void);
  39
  40
  41 /* special version of ctime that clobbers a *different static variable, so
  42  * that ViceLog can call ctime and not cause buffer confusion.
  43  */
  44 extern char *vctime(const time_t *atime);
  45
  46 /* Need a thead safe ctime for pthread builds. Use std ctime for LWP */
  47 #if defined(AFS_PTHREAD_ENV) && !defined(AFS_NT40_ENV)
  48 #ifdef AFS_SUN5_ENV
  49 #define afs_ctime(C, B, L) ctime_r(C, B, L)
  50 #else
  51 /* Cast is for platforms which do not prototype ctime_r */
  52 #define afs_ctime(C, B, L) (char*)ctime_r(C, B)
  53 #endif /* AFS_SUN5_ENV */
  54 #else /* AFS_PTHREAD_ENV && !AFS_NT40_ENV */
  55 #define afs_ctime(C, B, S) \
  56         ((void)strncpy(B, ctime(C), (S-1)), (B)[S-1] = '\0', (B))
  57 #endif  /* AFS_PTHREAD_ENV && !AFS_NT40_ENV */
  58
  59
  60 /* abort the current process. */
  61 #ifdef AFS_NT40_ENV
  62 #define afs_abort() afs_NTAbort()
  63 #else
  64 #define afs_abort() abort()
  65 #endif
  66
  67
  68 #ifdef AFS_NT40_ENV
  69 #ifndef _MFC_VER
  70 #include <winsock2.h>
  71 #endif /* _MFC_VER */
  72
  73 /* Initialize the windows sockets before calling networking routines. */
  74 extern int afs_winsockInit(void);
  75
  76 struct timezone {
  77     int  tz_minuteswest;     /* of Greenwich */
  78     int  tz_dsttime;    /* type of dst correction to apply */
  79 };
  80 #define gettimeofday afs_gettimeofday
  81 int afs_gettimeofday(struct timeval *tv, struct timezone *tz);
  82
  83 /* Unbuffer output when Un*x would do line buffering. */
  84 #define setlinebuf(S) setvbuf(S, NULL, _IONBF, 0)
  85
  86 /* regular expression parser for NT */
  87 extern char *re_comp(char *sp);
  88 extern int rc_exec(char *p);
  89
  90 /* Abort on error, possibly trapping to debugger or dumping a trace. */
  91 void afs_NTAbort(void);
  92 #endif /* NT40 */
  93
  94 typedef char b32_string_t[8];
  95 /* b64_string_t is 8 bytes, in stds.h */
  96 typedef char lb64_string_t[12];
  97
  98 #ifndef UKERNEL
  99 #include "afs/ktime.h"
 100 #endif
 101 #include "afsutil_prototypes.h"
 102
 103 #endif /* _AFSUTIL_H_ */