backport to buster

[hcoop/debian/openafs.git] / src / util / afsutil.h

/*
 * 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 _AFSUTIL_H_
#define _AFSUTIL_H_

#include <time.h>
/* Include afs installation dir retrieval routines */
#include <afs/dirpath.h>

/* These macros are return values from extractAddr. They do not represent
 * any valid IP address and so can indicate a failure.
 */
#define	AFS_IPINVALID 		0xffffffff	/* invalid IP address */
#define AFS_IPINVALIDIGNORE	0xfffffffe	/* no input given to extractAddr */

/* logging defines
 */
#ifndef AFS_NT40_ENV
#include <sys/types.h>
#include <sys/socket.h>
#include <netinet/in.h>
#include <arpa/inet.h> /* for inet_ntoa() */
#endif

#include <stdio.h>
#include <stdarg.h>
#include <string.h>

enum logDest {
    logDest_file,
#ifdef HAVE_SYSLOG
    logDest_syslog,
#endif
};

enum logRotateStyle {
    logRotate_none = 0,
    logRotate_old,        /**< Rename log file by adding .old to the file name. */
    logRotate_timestamp,  /**< Rename log file to a timestamped file name. */
};

struct logOptions {
    int logLevel;                  /**< The initial log level. */
    enum logDest dest;             /**< Log destination */
    union {
	struct fileOptions {
	    const char *filename;  /**< Log filename (may be a named pipe). */
	    int rotateOnOpen;      /**< Rotate the log file during OpenLog. */
	    int rotateOnReset;     /**< Rotate the log file when the SIGHUP is caught. */
	    enum logRotateStyle rotateStyle; /**< Specifies how logs are renamed. */
	} fileOpts;
#ifdef HAVE_SYSLOG
	struct syslogOptions {
	    int facility;          /**< The syslog facility. */
	    char *tag;             /**< The syslog identification. */
	} syslogOpts;
#endif
    } opts;
};
#define lopt_logLevel logLevel
#define lopt_dest dest
#define lopt_filename  opts.fileOpts.filename
#define lopt_rotateOnOpen opts.fileOpts.rotateOnOpen
#define lopt_rotateOnReset opts.fileOpts.rotateOnReset
#define lopt_rotateStyle opts.fileOpts.rotateStyle
#define lopt_facility opts.syslogOpts.facility
#define lopt_tag opts.syslogOpts.tag

extern void vFSLog(const char *format, va_list args)
	AFS_ATTRIBUTE_FORMAT(__printf__, 1, 0);

extern void SetLogThreadNumProgram(int (*func) (void) );

extern void FSLog(const char *format, ...)
	AFS_ATTRIBUTE_FORMAT(__printf__, 1, 2);


extern int LogLevel; /* For logging macros only. */

#define ViceLog(level, str)  do { if ((level) <= LogLevel) (FSLog str); } while (0)
#define vViceLog(level, str) do { if ((level) <= LogLevel) (vFSLog str); } while (0)
#define ViceLogThenPanic(level, str) \
    do { ViceLog(level, str); osi_Panic str; } while(0);

extern int OpenLog(struct logOptions *opts);
extern int ReOpenLog(void);
extern void SetupLogSignals(void);
extern void CloseLog(void);
extern void SetupLogSoftSignals(void);
extern int GetLogLevel(void);
extern enum logDest GetLogDest(void);
extern const char *GetLogFilename(void);

#ifdef AFS_NT40_ENV
#ifndef _MFC_VER
#include <winsock2.h>
#endif /* _MFC_VER */

/* Initialize the windows sockets before calling networking routines. */
     extern int afs_winsockInit(void);
     extern void afs_winsockCleanup(void);

/* Unbuffer output when Un*x would do line buffering. */
#define setlinebuf(S) setvbuf(S, NULL, _IONBF, 0)

#endif /* AFS_NT40_ENV */

#ifndef HAVE_POSIX_REGEX
extern char *re_comp(const char *sp);
extern int re_exec(const char *p1);
#endif

     typedef char b32_string_t[8];
/* b64_string_t is 8 bytes, in stds.h */
     typedef char lb64_string_t[12];

/* A simple macro to help show the value of #define'd constants. e.g. If 'FOO'
 * is defined as 5, then AFS_STRINGIZE(FOO) expands to "5" */
#define AFS_STRINGIZE_(s) #s
#define AFS_STRINGIZE(s) AFS_STRINGIZE_(s)

#include <afs/ktime.h>
#include "afsutil_prototypes.h"

#endif /* _AFSUTIL_H_ */