defines.h revision 124208 
1/*
2 * Copyright (c) 1999-2003 Damien Miller.  All rights reserved.
3 *
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions
6 * are met:
7 * 1. Redistributions of source code must retain the above copyright
8 *    notice, this list of conditions and the following disclaimer.
9 * 2. Redistributions in binary form must reproduce the above copyright
10 *    notice, this list of conditions and the following disclaimer in the
11 *    documentation and/or other materials provided with the distribution.
12 *
13 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
14 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
15 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
16 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
17 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
18 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
19 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
20 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
21 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
22 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
23 */
24
25#ifndef _DEFINES_H
26#define _DEFINES_H
27
28/* $Id: defines.h,v 1.103 2003/09/16 01:52:19 dtucker Exp $ */
29
30
31/* Constants */
32
33#ifndef SHUT_RDWR
34enum
35{
36  SHUT_RD = 0,		/* No more receptions.  */
37  SHUT_WR,			/* No more transmissions.  */
38  SHUT_RDWR			/* No more receptions or transmissions.  */
39};
40# define SHUT_RD   SHUT_RD
41# define SHUT_WR   SHUT_WR
42# define SHUT_RDWR SHUT_RDWR
43#endif
44
45#ifndef IPTOS_LOWDELAY
46# define IPTOS_LOWDELAY          0x10
47# define IPTOS_THROUGHPUT        0x08
48# define IPTOS_RELIABILITY       0x04
49# define IPTOS_LOWCOST           0x02
50# define IPTOS_MINCOST           IPTOS_LOWCOST
51#endif /* IPTOS_LOWDELAY */
52
53#ifndef MAXPATHLEN
54# ifdef PATH_MAX
55#  define MAXPATHLEN PATH_MAX
56# else /* PATH_MAX */
57#  define MAXPATHLEN 64 /* Should be safe */
58# endif /* PATH_MAX */
59#endif /* MAXPATHLEN */
60
61#ifndef STDIN_FILENO
62# define STDIN_FILENO    0
63#endif
64#ifndef STDOUT_FILENO
65# define STDOUT_FILENO   1
66#endif
67#ifndef STDERR_FILENO
68# define STDERR_FILENO   2
69#endif
70
71#ifndef NGROUPS_MAX	/* Disable groupaccess if NGROUP_MAX is not set */
72#ifdef NGROUPS
73#define NGROUPS_MAX NGROUPS
74#else
75#define NGROUPS_MAX 0
76#endif
77#endif
78
79#ifndef O_NONBLOCK	/* Non Blocking Open */
80# define O_NONBLOCK      00004
81#endif
82
83#ifndef S_ISDIR
84# define S_ISDIR(mode)	(((mode) & (_S_IFMT)) == (_S_IFDIR))
85#endif /* S_ISDIR */
86
87#ifndef S_ISREG
88# define S_ISREG(mode)	(((mode) & (_S_IFMT)) == (_S_IFREG))
89#endif /* S_ISREG */
90
91#ifndef S_ISLNK
92# define S_ISLNK(mode)	(((mode) & S_IFMT) == S_IFLNK)
93#endif /* S_ISLNK */
94
95#ifndef S_IXUSR
96# define S_IXUSR			0000100	/* execute/search permission, */
97# define S_IXGRP			0000010	/* execute/search permission, */
98# define S_IXOTH			0000001	/* execute/search permission, */
99# define _S_IWUSR			0000200	/* write permission, */
100# define S_IWUSR			_S_IWUSR	/* write permission, owner */
101# define S_IWGRP			0000020	/* write permission, group */
102# define S_IWOTH			0000002	/* write permission, other */
103# define S_IRUSR			0000400	/* read permission, owner */
104# define S_IRGRP			0000040	/* read permission, group */
105# define S_IROTH			0000004	/* read permission, other */
106# define S_IRWXU			0000700	/* read, write, execute */
107# define S_IRWXG			0000070	/* read, write, execute */
108# define S_IRWXO			0000007	/* read, write, execute */
109#endif /* S_IXUSR */
110
111#if !defined(MAP_ANON) && defined(MAP_ANONYMOUS)
112#define MAP_ANON MAP_ANONYMOUS
113#endif
114
115#ifndef MAP_FAILED
116# define MAP_FAILED ((void *)-1)
117#endif
118
119/* *-*-nto-qnx doesn't define this constant in the system headers */
120#ifdef MISSING_NFDBITS
121# define	NFDBITS (8 * sizeof(unsigned long))
122#endif
123
124/*
125SCO Open Server 3 has INADDR_LOOPBACK defined in rpc/rpc.h but
126including rpc/rpc.h breaks Solaris 6
127*/
128#ifndef INADDR_LOOPBACK
129#define INADDR_LOOPBACK ((u_long)0x7f000001)
130#endif
131
132/* Types */
133
134/* If sys/types.h does not supply intXX_t, supply them ourselves */
135/* (or die trying) */
136
137
138#ifndef HAVE_U_INT
139typedef unsigned int u_int;
140#endif
141
142#ifndef HAVE_INTXX_T
143# if (SIZEOF_CHAR == 1)
144typedef char int8_t;
145# else
146#  error "8 bit int type not found."
147# endif
148# if (SIZEOF_SHORT_INT == 2)
149typedef short int int16_t;
150# else
151#  ifdef _UNICOS
152#   if (SIZEOF_SHORT_INT == 4)
153typedef short int16_t;
154#   else
155typedef long  int16_t;
156#   endif
157#  else
158#   error "16 bit int type not found."
159#  endif /* _UNICOS */
160# endif
161# if (SIZEOF_INT == 4)
162typedef int int32_t;
163# else
164#  ifdef _UNICOS
165typedef long  int32_t;
166#  else
167#   error "32 bit int type not found."
168#  endif /* _UNICOS */
169# endif
170#endif
171
172/* If sys/types.h does not supply u_intXX_t, supply them ourselves */
173#ifndef HAVE_U_INTXX_T
174# ifdef HAVE_UINTXX_T
175typedef uint8_t u_int8_t;
176typedef uint16_t u_int16_t;
177typedef uint32_t u_int32_t;
178# define HAVE_U_INTXX_T 1
179# else
180#  if (SIZEOF_CHAR == 1)
181typedef unsigned char u_int8_t;
182#  else
183#   error "8 bit int type not found."
184#  endif
185#  if (SIZEOF_SHORT_INT == 2)
186typedef unsigned short int u_int16_t;
187#  else
188#   ifdef _UNICOS
189#    if (SIZEOF_SHORT_INT == 4)
190typedef unsigned short u_int16_t;
191#    else
192typedef unsigned long  u_int16_t;
193#    endif
194#   else
195#    error "16 bit int type not found."
196#   endif
197#  endif
198#  if (SIZEOF_INT == 4)
199typedef unsigned int u_int32_t;
200#  else
201#   ifdef _UNICOS
202typedef unsigned long  u_int32_t;
203#   else
204#    error "32 bit int type not found."
205#   endif
206#  endif
207# endif
208#define __BIT_TYPES_DEFINED__
209#endif
210
211/* 64-bit types */
212#ifndef HAVE_INT64_T
213# if (SIZEOF_LONG_INT == 8)
214typedef long int int64_t;
215# else
216#  if (SIZEOF_LONG_LONG_INT == 8)
217typedef long long int int64_t;
218#  endif
219# endif
220#endif
221#ifndef HAVE_U_INT64_T
222# if (SIZEOF_LONG_INT == 8)
223typedef unsigned long int u_int64_t;
224# else
225#  if (SIZEOF_LONG_LONG_INT == 8)
226typedef unsigned long long int u_int64_t;
227#  endif
228# endif
229#endif
230
231#ifndef HAVE_U_CHAR
232typedef unsigned char u_char;
233# define HAVE_U_CHAR
234#endif /* HAVE_U_CHAR */
235
236#ifndef SIZE_T_MAX
237#define SIZE_T_MAX ULONG_MAX
238#endif /* SIZE_T_MAX */
239
240#ifndef HAVE_SIZE_T
241typedef unsigned int size_t;
242# define HAVE_SIZE_T
243#endif /* HAVE_SIZE_T */
244
245#ifndef HAVE_SSIZE_T
246typedef int ssize_t;
247# define HAVE_SSIZE_T
248#endif /* HAVE_SSIZE_T */
249
250#ifndef HAVE_CLOCK_T
251typedef long clock_t;
252# define HAVE_CLOCK_T
253#endif /* HAVE_CLOCK_T */
254
255#ifndef HAVE_SA_FAMILY_T
256typedef int sa_family_t;
257# define HAVE_SA_FAMILY_T
258#endif /* HAVE_SA_FAMILY_T */
259
260#ifndef HAVE_PID_T
261typedef int pid_t;
262# define HAVE_PID_T
263#endif /* HAVE_PID_T */
264
265#ifndef HAVE_SIG_ATOMIC_T
266typedef int sig_atomic_t;
267# define HAVE_SIG_ATOMIC_T
268#endif /* HAVE_SIG_ATOMIC_T */
269
270#ifndef HAVE_MODE_T
271typedef int mode_t;
272# define HAVE_MODE_T
273#endif /* HAVE_MODE_T */
274
275#if !defined(HAVE_SS_FAMILY_IN_SS) && defined(HAVE___SS_FAMILY_IN_SS)
276# define ss_family __ss_family
277#endif /* !defined(HAVE_SS_FAMILY_IN_SS) && defined(HAVE_SA_FAMILY_IN_SS) */
278
279#ifndef HAVE_SYS_UN_H
280struct	sockaddr_un {
281	short	sun_family;		/* AF_UNIX */
282	char	sun_path[108];		/* path name (gag) */
283};
284#endif /* HAVE_SYS_UN_H */
285
286#if defined(BROKEN_SYS_TERMIO_H) && !defined(_STRUCT_WINSIZE)
287#define _STRUCT_WINSIZE
288struct winsize {
289      unsigned short ws_row;          /* rows, in characters */
290      unsigned short ws_col;          /* columns, in character */
291      unsigned short ws_xpixel;       /* horizontal size, pixels */
292      unsigned short ws_ypixel;       /* vertical size, pixels */
293};
294#endif
295
296/* *-*-nto-qnx does not define this type in the system headers */
297#ifdef MISSING_FD_MASK
298 typedef unsigned long int	fd_mask;
299#endif
300
301/* Paths */
302
303#ifndef _PATH_BSHELL
304# define _PATH_BSHELL "/bin/sh"
305#endif
306#ifndef _PATH_CSHELL
307# define _PATH_CSHELL "/bin/csh"
308#endif
309#ifndef _PATH_SHELLS
310# define _PATH_SHELLS "/etc/shells"
311#endif
312
313#ifdef USER_PATH
314# ifdef _PATH_STDPATH
315#  undef _PATH_STDPATH
316# endif
317# define _PATH_STDPATH USER_PATH
318#endif
319
320#ifndef _PATH_STDPATH
321# define _PATH_STDPATH "/usr/bin:/bin:/usr/sbin:/sbin"
322#endif
323
324#ifndef SUPERUSER_PATH
325# define SUPERUSER_PATH	_PATH_STDPATH
326#endif
327
328#ifndef _PATH_DEVNULL
329# define _PATH_DEVNULL "/dev/null"
330#endif
331
332#ifndef MAIL_DIRECTORY
333# define MAIL_DIRECTORY "/var/spool/mail"
334#endif
335
336#ifndef MAILDIR
337# define MAILDIR MAIL_DIRECTORY
338#endif
339
340#if !defined(_PATH_MAILDIR) && defined(MAILDIR)
341# define _PATH_MAILDIR MAILDIR
342#endif /* !defined(_PATH_MAILDIR) && defined(MAILDIR) */
343
344#ifndef _PATH_NOLOGIN
345# define _PATH_NOLOGIN "/etc/nologin"
346#endif
347
348/* Define this to be the path of the xauth program. */
349#ifdef XAUTH_PATH
350#define _PATH_XAUTH XAUTH_PATH
351#endif /* XAUTH_PATH */
352
353/* derived from XF4/xc/lib/dps/Xlibnet.h */
354#ifndef X_UNIX_PATH
355#  ifdef __hpux
356#    define X_UNIX_PATH "/var/spool/sockets/X11/%u"
357#  else
358#    define X_UNIX_PATH "/tmp/.X11-unix/X%u"
359#  endif
360#endif /* X_UNIX_PATH */
361#define _PATH_UNIX_X X_UNIX_PATH
362
363#ifndef _PATH_TTY
364# define _PATH_TTY "/dev/tty"
365#endif
366
367/* Macros */
368
369#if defined(HAVE_LOGIN_GETCAPBOOL) && defined(HAVE_LOGIN_CAP_H)
370# define HAVE_LOGIN_CAP
371#endif
372
373#ifndef MAX
374# define MAX(a,b) (((a)>(b))?(a):(b))
375# define MIN(a,b) (((a)<(b))?(a):(b))
376#endif
377
378#ifndef roundup
379# define roundup(x, y)   ((((x)+((y)-1))/(y))*(y))
380#endif
381
382#ifndef timersub
383#define timersub(a, b, result)					\
384   do {								\
385      (result)->tv_sec = (a)->tv_sec - (b)->tv_sec;		\
386      (result)->tv_usec = (a)->tv_usec - (b)->tv_usec;		\
387      if ((result)->tv_usec < 0) {				\
388	 --(result)->tv_sec;					\
389	 (result)->tv_usec += 1000000;				\
390      }								\
391   } while (0)
392#endif
393
394#ifndef TIMEVAL_TO_TIMESPEC
395#define	TIMEVAL_TO_TIMESPEC(tv, ts) {					\
396	(ts)->tv_sec = (tv)->tv_sec;					\
397	(ts)->tv_nsec = (tv)->tv_usec * 1000;				\
398}
399#endif
400
401#ifndef TIMESPEC_TO_TIMEVAL
402#define	TIMESPEC_TO_TIMEVAL(tv, ts) {					\
403	(tv)->tv_sec = (ts)->tv_sec;					\
404	(tv)->tv_usec = (ts)->tv_nsec / 1000;				\
405}
406#endif
407
408#ifndef __P
409# define __P(x) x
410#endif
411
412#if !defined(IN6_IS_ADDR_V4MAPPED)
413# define IN6_IS_ADDR_V4MAPPED(a) \
414	((((u_int32_t *) (a))[0] == 0) && (((u_int32_t *) (a))[1] == 0) && \
415	 (((u_int32_t *) (a))[2] == htonl (0xffff)))
416#endif /* !defined(IN6_IS_ADDR_V4MAPPED) */
417
418#if !defined(__GNUC__) || (__GNUC__ < 2)
419# define __attribute__(x)
420#endif /* !defined(__GNUC__) || (__GNUC__ < 2) */
421
422/* *-*-nto-qnx doesn't define this macro in the system headers */
423#ifdef MISSING_HOWMANY
424# define howmany(x,y)	(((x)+((y)-1))/(y))
425#endif
426
427#ifndef OSSH_ALIGNBYTES
428#define OSSH_ALIGNBYTES	(sizeof(int) - 1)
429#endif
430#ifndef __CMSG_ALIGN
431#define	__CMSG_ALIGN(p) (((u_int)(p) + OSSH_ALIGNBYTES) &~ OSSH_ALIGNBYTES)
432#endif
433
434/* Length of the contents of a control message of length len */
435#ifndef CMSG_LEN
436#define	CMSG_LEN(len)	(__CMSG_ALIGN(sizeof(struct cmsghdr)) + (len))
437#endif
438
439/* Length of the space taken up by a padded control message of length len */
440#ifndef CMSG_SPACE
441#define	CMSG_SPACE(len)	(__CMSG_ALIGN(sizeof(struct cmsghdr)) + __CMSG_ALIGN(len))
442#endif
443
444/* given pointer to struct cmsghdr, return pointer to data */
445#ifndef CMSG_DATA
446#define CMSG_DATA(cmsg) ((u_char *)(cmsg) + __CMSG_ALIGN(sizeof(struct cmsghdr)))
447#endif /* CMSG_DATA */
448
449/*
450 * RFC 2292 requires to check msg_controllen, in case that the kernel returns
451 * an empty list for some reasons.
452 */
453#ifndef CMSG_FIRSTHDR
454#define CMSG_FIRSTHDR(mhdr) \
455	((mhdr)->msg_controllen >= sizeof(struct cmsghdr) ? \
456	 (struct cmsghdr *)(mhdr)->msg_control : \
457	 (struct cmsghdr *)NULL)
458#endif /* CMSG_FIRSTHDR */
459
460
461/* Function replacement / compatibility hacks */
462
463#if !defined(HAVE_GETADDRINFO) && (defined(HAVE_OGETADDRINFO) || defined(HAVE_NGETADDRINFO))
464# define HAVE_GETADDRINFO
465#endif
466
467#ifndef HAVE_GETOPT_OPTRESET
468# undef getopt
469# undef opterr
470# undef optind
471# undef optopt
472# undef optreset
473# undef optarg
474# define getopt(ac, av, o)  BSDgetopt(ac, av, o)
475# define opterr             BSDopterr
476# define optind             BSDoptind
477# define optopt             BSDoptopt
478# define optreset           BSDoptreset
479# define optarg             BSDoptarg
480#endif
481
482/* In older versions of libpam, pam_strerror takes a single argument */
483#ifdef HAVE_OLD_PAM
484# define PAM_STRERROR(a,b) pam_strerror((b))
485#else
486# define PAM_STRERROR(a,b) pam_strerror((a),(b))
487#endif
488
489#ifdef PAM_SUN_CODEBASE
490# define PAM_MSG_MEMBER(msg, n, member) ((*(msg))[(n)].member)
491#else
492# define PAM_MSG_MEMBER(msg, n, member) ((msg)[(n)]->member)
493#endif
494
495#if defined(BROKEN_GETADDRINFO) && defined(HAVE_GETADDRINFO)
496# undef HAVE_GETADDRINFO
497#endif
498#if defined(BROKEN_GETADDRINFO) && defined(HAVE_FREEADDRINFO)
499# undef HAVE_FREEADDRINFO
500#endif
501#if defined(BROKEN_GETADDRINFO) && defined(HAVE_GAI_STRERROR)
502# undef HAVE_GAI_STRERROR
503#endif
504
505#if !defined(HAVE_MEMMOVE) && defined(HAVE_BCOPY)
506# define memmove(s1, s2, n) bcopy((s2), (s1), (n))
507#endif /* !defined(HAVE_MEMMOVE) && defined(HAVE_BCOPY) */
508
509#if defined(HAVE_VHANGUP) && !defined(HAVE_DEV_PTMX)
510#  define USE_VHANGUP
511#endif /* defined(HAVE_VHANGUP) && !defined(HAVE_DEV_PTMX) */
512
513#ifndef GETPGRP_VOID
514# define getpgrp() getpgrp(0)
515#endif
516
517/* OPENSSL_free() is Free() in versions before OpenSSL 0.9.6 */
518#if !defined(OPENSSL_VERSION_NUMBER) || (OPENSSL_VERSION_NUMBER < 0x0090600f)
519# define OPENSSL_free(x) Free(x)
520#endif
521
522#if !defined(HAVE___func__) && defined(HAVE___FUNCTION__)
523#  define __func__ __FUNCTION__
524#elif !defined(HAVE___func__)
525#  define __func__ ""
526#endif
527
528#if defined(KRB5) && !defined(HEIMDAL)
529#  define krb5_get_err_text(context,code) error_message(code)
530#endif
531
532/*
533 * Define this to use pipes instead of socketpairs for communicating with the
534 * client program.  Socketpairs do not seem to work on all systems.
535 *
536 * configure.ac sets this for a few OS's which are known to have problems
537 * but you may need to set it yourself
538 */
539/* #define USE_PIPES 1 */
540
541/**
542 ** login recorder definitions
543 **/
544
545/* FIXME: put default paths back in */
546#ifndef UTMP_FILE
547#  ifdef _PATH_UTMP
548#    define UTMP_FILE _PATH_UTMP
549#  else
550#    ifdef CONF_UTMP_FILE
551#      define UTMP_FILE CONF_UTMP_FILE
552#    endif
553#  endif
554#endif
555#ifndef WTMP_FILE
556#  ifdef _PATH_WTMP
557#    define WTMP_FILE _PATH_WTMP
558#  else
559#    ifdef CONF_WTMP_FILE
560#      define WTMP_FILE CONF_WTMP_FILE
561#    endif
562#  endif
563#endif
564/* pick up the user's location for lastlog if given */
565#ifndef LASTLOG_FILE
566#  ifdef _PATH_LASTLOG
567#    define LASTLOG_FILE _PATH_LASTLOG
568#  else
569#    ifdef CONF_LASTLOG_FILE
570#      define LASTLOG_FILE CONF_LASTLOG_FILE
571#    endif
572#  endif
573#endif
574
575
576/* The login() library function in libutil is first choice */
577#if defined(HAVE_LOGIN) && !defined(DISABLE_LOGIN)
578#  define USE_LOGIN
579
580#else
581/* Simply select your favourite login types. */
582/* Can't do if-else because some systems use several... <sigh> */
583#  if defined(UTMPX_FILE) && !defined(DISABLE_UTMPX)
584#    define USE_UTMPX
585#  endif
586#  if defined(UTMP_FILE) && !defined(DISABLE_UTMP)
587#    define USE_UTMP
588#  endif
589#  if defined(WTMPX_FILE) && !defined(DISABLE_WTMPX)
590#    define USE_WTMPX
591#  endif
592#  if defined(WTMP_FILE) && !defined(DISABLE_WTMP)
593#    define USE_WTMP
594#  endif
595
596#endif
597
598/* I hope that the presence of LASTLOG_FILE is enough to detect this */
599#if defined(LASTLOG_FILE) && !defined(DISABLE_LASTLOG)
600#  define USE_LASTLOG
601#endif
602
603/** end of login recorder definitions */
604
605#endif /* _DEFINES_H */
606