lib/roken/roken-common.h

   1 /*
   2  * Copyright (c) 1995 - 2005 Kungliga Tekniska Högskolan
   3  * (Royal Institute of Technology, Stockholm, Sweden).
   4  * All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  *
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  *
  13  * 2. Redistributions in binary form must reproduce the above copyright
  14  *    notice, this list of conditions and the following disclaimer in the
  15  *    documentation and/or other materials provided with the distribution.
  16  *
  17  * 3. Neither the name of the Institute nor the names of its contributors
  18  *    may be used to endorse or promote products derived from this software
  19  *    without specific prior written permission.
  20  *
  21  * THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
  22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  24  * ARE DISCLAIMED.  IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
  25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  31  * SUCH DAMAGE.
  32  */
  33
  34 /* $Id$ */
  35
  36 #ifndef __ROKEN_COMMON_H__
  37 #define __ROKEN_COMMON_H__
  38
  39 #ifndef ROKEN_LIB_FUNCTION
  40 #ifdef _WIN32
  41 #define ROKEN_LIB_FUNCTION
  42 #define ROKEN_LIB_CALL     __cdecl
  43 #else
  44 #define ROKEN_LIB_FUNCTION
  45 #define ROKEN_LIB_CALL
  46 #endif
  47 #endif
  48
  49 #ifdef __cplusplus
  50 #define ROKEN_CPP_START extern "C" {
  51 #define ROKEN_CPP_END   }
  52 #else
  53 #define ROKEN_CPP_START
  54 #define ROKEN_CPP_END
  55 #endif
  56
  57 #ifndef INADDR_NONE
  58 #define INADDR_NONE 0xffffffff
  59 #endif
  60
  61 #ifndef INADDR_LOOPBACK
  62 #define INADDR_LOOPBACK 0x7f000001
  63 #endif
  64
  65 #ifndef SOMAXCONN
  66 #define SOMAXCONN 5
  67 #endif
  68
  69 #ifndef STDIN_FILENO
  70 #define STDIN_FILENO 0
  71 #endif
  72
  73 #ifndef STDOUT_FILENO
  74 #define STDOUT_FILENO 1
  75 #endif
  76
  77 #ifndef STDERR_FILENO
  78 #define STDERR_FILENO 2
  79 #endif
  80
  81 #ifndef max
  82 #define max(a,b) (((a)>(b))?(a):(b))
  83 #endif
  84
  85 #ifndef min
  86 #define min(a,b) (((a)<(b))?(a):(b))
  87 #endif
  88
  89 #ifndef TRUE
  90 #define TRUE 1
  91 #endif
  92
  93 #ifndef FALSE
  94 #define FALSE 0
  95 #endif
  96
  97 #ifndef LOG_DAEMON
  98 #define openlog(id,option,facility) openlog((id),(option))
  99 #define LOG_DAEMON      0
 100 #endif
 101 #ifndef LOG_ODELAY
 102 #define LOG_ODELAY 0
 103 #endif
 104 #ifndef LOG_NDELAY
 105 #define LOG_NDELAY 0x08
 106 #endif
 107 #ifndef LOG_CONS
 108 #define LOG_CONS 0
 109 #endif
 110 #ifndef LOG_AUTH
 111 #define LOG_AUTH 0
 112 #endif
 113 #ifndef LOG_AUTHPRIV
 114 #define LOG_AUTHPRIV LOG_AUTH
 115 #endif
 116
 117 #ifndef F_OK
 118 #define F_OK 0
 119 #endif
 120
 121 #ifndef O_ACCMODE
 122 #define O_ACCMODE       003
 123 #endif
 124
 125 #ifndef O_NOFOLLOW
 126 #define O_NOFOLLOW 0
 127 #endif
 128
 129 #ifdef _WIN32
 130
 131 #define _PATH_DEVNULL "\\\\.\\NUL"
 132
 133 #else
 134
 135 #ifndef _PATH_DEV
 136 #define _PATH_DEV "/dev/"
 137 #endif
 138
 139 #ifndef _PATH_DEVNULL
 140 #define _PATH_DEVNULL "/dev/null"
 141 #endif
 142
 143 #ifndef _PATH_HEQUIV
 144 #define _PATH_HEQUIV "/etc/hosts.equiv"
 145 #endif
 146
 147 #ifndef _PATH_VARRUN
 148 #define _PATH_VARRUN "/var/run/"
 149 #endif
 150
 151 #ifndef _PATH_BSHELL
 152 #define _PATH_BSHELL "/bin/sh"
 153 #endif
 154
 155 #ifndef MAXPATHLEN
 156 #define MAXPATHLEN (1024+4)
 157 #endif
 158
 159 #endif  /* !_WIN32 */
 160
 161 #ifndef PATH_MAX
 162 #ifdef MAX_PATH
 163 #define PATH_MAX MAX_PATH
 164 #else
 165 #define PATH_MAX 4096
 166 #endif
 167 #endif
 168
 169 #ifndef RETSIGTYPE
 170 #define RETSIGTYPE void
 171 #endif
 172
 173 #ifndef SIG_ERR
 174 #define SIG_ERR ((RETSIGTYPE (*)(int))-1)
 175 #endif
 176
 177 /*
 178  * error code for getipnodeby{name,addr}
 179  */
 180
 181 #ifndef HOST_NOT_FOUND
 182 #define HOST_NOT_FOUND 1
 183 #endif
 184
 185 #ifndef TRY_AGAIN
 186 #define TRY_AGAIN 2
 187 #endif
 188
 189 #ifndef NO_RECOVERY
 190 #define NO_RECOVERY 3
 191 #endif
 192
 193 #ifndef NO_DATA
 194 #define NO_DATA 4
 195 #endif
 196
 197 #ifndef NO_ADDRESS
 198 #define NO_ADDRESS NO_DATA
 199 #endif
 200
 201 /*
 202  * error code for getaddrinfo
 203  */
 204
 205 #ifndef EAI_NOERROR
 206 #define EAI_NOERROR     0       /* no error */
 207 #endif
 208
 209 #ifndef EAI_NONAME
 210
 211 #define EAI_ADDRFAMILY  1       /* address family for nodename not supported */
 212 #define EAI_AGAIN       2       /* temporary failure in name resolution */
 213 #define EAI_BADFLAGS    3       /* invalid value for ai_flags */
 214 #define EAI_FAIL        4       /* non-recoverable failure in name resolution */
 215 #define EAI_FAMILY      5       /* ai_family not supported */
 216 #define EAI_MEMORY      6       /* memory allocation failure */
 217 #define EAI_NODATA      7       /* no address associated with nodename */
 218 #define EAI_NONAME      8       /* nodename nor servname provided, or not known */
 219 #define EAI_SERVICE     9       /* servname not supported for ai_socktype */
 220 #define EAI_SOCKTYPE   10       /* ai_socktype not supported */
 221 #define EAI_SYSTEM     11       /* system error returned in errno */
 222
 223 #endif /* EAI_NONAME */
 224
 225 /* flags for getaddrinfo() */
 226
 227 #ifndef AI_PASSIVE
 228 #define AI_PASSIVE      0x01
 229 #define AI_CANONNAME    0x02
 230 #endif /* AI_PASSIVE */
 231
 232 #ifndef AI_NUMERICHOST
 233 #define AI_NUMERICHOST  0x04
 234 #endif
 235
 236 #ifndef AI_NUMERICSERV
 237 #define AI_NUMERICSERV  0x08
 238 #endif
 239
 240 /* flags for getnameinfo() */
 241
 242 #ifndef NI_DGRAM
 243 #define NI_DGRAM        0x01
 244 #define NI_NAMEREQD     0x02
 245 #define NI_NOFQDN       0x04
 246 #define NI_NUMERICHOST  0x08
 247 #define NI_NUMERICSERV  0x10
 248 #endif
 249
 250 /*
 251  * constants for getnameinfo
 252  */
 253
 254 #ifndef NI_MAXHOST
 255 #define NI_MAXHOST  1025
 256 #define NI_MAXSERV    32
 257 #endif
 258
 259 /*
 260  * constants for inet_ntop
 261  */
 262
 263 #ifndef INET_ADDRSTRLEN
 264 #define INET_ADDRSTRLEN    16
 265 #endif
 266
 267 #ifndef INET6_ADDRSTRLEN
 268 #define INET6_ADDRSTRLEN   46
 269 #endif
 270
 271 /*
 272  * for shutdown(2)
 273  */
 274
 275 #ifndef SHUT_RD
 276 #define SHUT_RD 0
 277 #endif
 278
 279 #ifndef SHUT_WR
 280 #define SHUT_WR 1
 281 #endif
 282
 283 #ifndef SHUT_RDWR
 284 #define SHUT_RDWR 2
 285 #endif
 286
 287 #ifndef HAVE___ATTRIBUTE__
 288 #define __attribute__(x)
 289 #endif
 290
 291 ROKEN_CPP_START
 292
 293 #ifndef IRIX4 /* fix for compiler bug */
 294 #ifndef _WIN32
 295 #ifdef RETSIGTYPE
 296 typedef RETSIGTYPE (*SigAction)(int);
 297 SigAction signal(int iSig, SigAction pAction); /* BSD compatible */
 298 #endif
 299 #endif
 300 #endif
 301
 302 #define SE_E_UNSPECIFIED (-1)
 303 #define SE_E_FORKFAILED  (-2)
 304 #define SE_E_WAITPIDFAILED (-3)
 305 #define SE_E_EXECTIMEOUT (-4)
 306 #define SE_E_NOEXEC   126
 307 #define SE_E_NOTFOUND 127
 308
 309 #define SE_PROCSTATUS(st) (((st) >= 0 && (st) < 126)? st: -1)
 310 #define SE_PROCSIGNAL(st) (((st) >= 128)? (st) - 128: -1)
 311 #define SE_IS_ERROR(st) ((st) < 0 || (st) >= 126)
 312
 313
 314 #define simple_execve rk_simple_execve
 315 ROKEN_LIB_FUNCTION int ROKEN_LIB_CALL
 316 simple_execve(const char*, char*const[], char*const[]);
 317
 318 #define simple_execve_timed rk_simple_execve_timed
 319 ROKEN_LIB_FUNCTION int ROKEN_LIB_CALL
 320 simple_execve_timed(const char *, char *const[],
 321                     char *const [], time_t (*)(void *),
 322                     void *, time_t);
 323
 324 #define simple_execvp rk_simple_execvp
 325 ROKEN_LIB_FUNCTION int ROKEN_LIB_CALL
 326 simple_execvp(const char*, char *const[]);
 327
 328 #define simple_execvp_timed rk_simple_execvp_timed
 329 ROKEN_LIB_FUNCTION int ROKEN_LIB_CALL
 330 simple_execvp_timed(const char *, char *const[],
 331                     time_t (*)(void *), void *, time_t);
 332
 333 #define simple_execlp rk_simple_execlp
 334 ROKEN_LIB_FUNCTION int ROKEN_LIB_CALL
 335 simple_execlp(const char*, ...);
 336
 337 #define simple_execle rk_simple_execle
 338 ROKEN_LIB_FUNCTION int ROKEN_LIB_CALL
 339 simple_execle(const char*, ...);
 340
 341 #define wait_for_process rk_wait_for_process
 342 ROKEN_LIB_FUNCTION int ROKEN_LIB_CALL
 343 wait_for_process(pid_t);
 344
 345 #define wait_for_process_timed rk_wait_for_process_timed
 346 ROKEN_LIB_FUNCTION int ROKEN_LIB_CALL
 347 wait_for_process_timed(pid_t, time_t (*)(void *),
 348                        void *, time_t);
 349
 350 #define pipe_execv rk_pipe_execv
 351 ROKEN_LIB_FUNCTION int ROKEN_LIB_CALL
 352 pipe_execv(FILE**, FILE**, FILE**, const char*, ...);
 353
 354 #define print_version rk_print_version
 355 ROKEN_LIB_FUNCTION void ROKEN_LIB_CALL
 356 print_version(const char *);
 357
 358 #define eread rk_eread
 359 ROKEN_LIB_FUNCTION ssize_t ROKEN_LIB_CALL
 360 eread (int fd, void *buf, size_t nbytes);
 361
 362 #define ewrite rk_ewrite
 363 ROKEN_LIB_FUNCTION ssize_t ROKEN_LIB_CALL
 364 ewrite (int fd, const void *buf, size_t nbytes);
 365
 366 struct hostent;
 367
 368 #define hostent_find_fqdn rk_hostent_find_fqdn
 369 ROKEN_LIB_FUNCTION const char * ROKEN_LIB_CALL
 370 hostent_find_fqdn (const struct hostent *);
 371
 372 #define esetenv rk_esetenv
 373 ROKEN_LIB_FUNCTION void ROKEN_LIB_CALL
 374 esetenv(const char *, const char *, int);
 375
 376 #define socket_set_address_and_port rk_socket_set_address_and_port
 377 ROKEN_LIB_FUNCTION void ROKEN_LIB_CALL
 378 socket_set_address_and_port (struct sockaddr *, const void *, int);
 379
 380 #define socket_addr_size rk_socket_addr_size
 381 ROKEN_LIB_FUNCTION size_t ROKEN_LIB_CALL
 382 socket_addr_size (const struct sockaddr *);
 383
 384 #define socket_set_any rk_socket_set_any
 385 ROKEN_LIB_FUNCTION void ROKEN_LIB_CALL
 386 socket_set_any (struct sockaddr *, int);
 387
 388 #define socket_sockaddr_size rk_socket_sockaddr_size
 389 ROKEN_LIB_FUNCTION size_t ROKEN_LIB_CALL
 390 socket_sockaddr_size (const struct sockaddr *);
 391
 392 #define socket_get_address rk_socket_get_address
 393 ROKEN_LIB_FUNCTION void * ROKEN_LIB_CALL
 394 socket_get_address (const struct sockaddr *);
 395
 396 #define socket_get_port rk_socket_get_port
 397 ROKEN_LIB_FUNCTION int ROKEN_LIB_CALL
 398 socket_get_port (const struct sockaddr *);
 399
 400 #define socket_set_port rk_socket_set_port
 401 ROKEN_LIB_FUNCTION void ROKEN_LIB_CALL
 402 socket_set_port (struct sockaddr *, int);
 403
 404 #define socket_set_portrange rk_socket_set_portrange
 405 ROKEN_LIB_FUNCTION void ROKEN_LIB_CALL
 406 socket_set_portrange (rk_socket_t, int, int);
 407
 408 #define socket_set_debug rk_socket_set_debug
 409 ROKEN_LIB_FUNCTION void ROKEN_LIB_CALL
 410 socket_set_debug (rk_socket_t);
 411
 412 #define socket_set_tos rk_socket_set_tos
 413 ROKEN_LIB_FUNCTION void ROKEN_LIB_CALL
 414 socket_set_tos (rk_socket_t, int);
 415
 416 #define socket_set_nonblocking rk_socket_set_nonblocking
 417 ROKEN_LIB_FUNCTION void ROKEN_LIB_CALL
 418 socket_set_nonblocking(rk_socket_t, int);
 419
 420 #define socket_set_reuseaddr rk_socket_set_reuseaddr
 421 ROKEN_LIB_FUNCTION void ROKEN_LIB_CALL
 422 socket_set_reuseaddr (rk_socket_t, int);
 423
 424 #define socket_set_ipv6only rk_socket_set_ipv6only
 425 ROKEN_LIB_FUNCTION void ROKEN_LIB_CALL
 426 socket_set_ipv6only (rk_socket_t, int);
 427
 428 #define socket_to_fd rk_socket_to_fd
 429 ROKEN_LIB_FUNCTION int ROKEN_LIB_CALL
 430 socket_to_fd(rk_socket_t, int);
 431
 432 #define vstrcollect rk_vstrcollect
 433 ROKEN_LIB_FUNCTION char ** ROKEN_LIB_CALL
 434 vstrcollect(va_list *ap);
 435
 436 #define strcollect rk_strcollect
 437 ROKEN_LIB_FUNCTION char ** ROKEN_LIB_CALL
 438 strcollect(char *first, ...);
 439
 440 #define timevalfix rk_timevalfix
 441 ROKEN_LIB_FUNCTION void ROKEN_LIB_CALL
 442 timevalfix(struct timeval *t1);
 443
 444 #define timevaladd rk_timevaladd
 445 ROKEN_LIB_FUNCTION void ROKEN_LIB_CALL
 446 timevaladd(struct timeval *t1, const struct timeval *t2);
 447
 448 #define timevalsub rk_timevalsub
 449 ROKEN_LIB_FUNCTION void ROKEN_LIB_CALL
 450 timevalsub(struct timeval *t1, const struct timeval *t2);
 451
 452 #define pid_file_write rk_pid_file_write
 453 ROKEN_LIB_FUNCTION char * ROKEN_LIB_CALL
 454 pid_file_write (const char *progname);
 455
 456 #define pid_file_delete rk_pid_file_delete
 457 ROKEN_LIB_FUNCTION void ROKEN_LIB_CALL
 458 pid_file_delete (char **);
 459
 460 #define read_environment rk_read_environment
 461 ROKEN_LIB_FUNCTION int ROKEN_LIB_CALL
 462 read_environment(const char *file, char ***env);
 463
 464 #define free_environment rk_free_environment
 465 ROKEN_LIB_FUNCTION void ROKEN_LIB_CALL
 466 free_environment(char **);
 467
 468 #define warnerr rk_warnerr
 469 ROKEN_LIB_FUNCTION void ROKEN_LIB_CALL
 470 rk_warnerr(int doerrno, const char *fmt, va_list ap)
 471     __attribute__ ((format (printf, 2, 0)));
 472
 473 ROKEN_LIB_FUNCTION void * ROKEN_LIB_CALL
 474 rk_realloc(void *, size_t);
 475
 476 struct rk_strpool;
 477
 478 ROKEN_LIB_FUNCTION char * ROKEN_LIB_CALL
 479 rk_strpoolcollect(struct rk_strpool *);
 480
 481 ROKEN_LIB_FUNCTION struct rk_strpool * ROKEN_LIB_CALL
 482 rk_strpoolprintf(struct rk_strpool *, const char *, ...)
 483     __attribute__ ((format (printf, 2, 3)));
 484
 485 ROKEN_LIB_FUNCTION void ROKEN_LIB_CALL
 486 rk_strpoolfree(struct rk_strpool *);
 487
 488 ROKEN_LIB_FUNCTION void ROKEN_LIB_CALL
 489 rk_dumpdata (const char *, const void *, size_t);
 490
 491 ROKEN_LIB_FUNCTION int ROKEN_LIB_CALL
 492 rk_undumpdata (const char *, void **, size_t *);
 493
 494 ROKEN_LIB_FUNCTION void ROKEN_LIB_CALL
 495 rk_xfree (void *);
 496
 497 ROKEN_LIB_FUNCTION void ROKEN_LIB_CALL
 498 rk_cloexec(int);
 499
 500 ROKEN_LIB_FUNCTION void ROKEN_LIB_CALL
 501 rk_cloexec_file(FILE *);
 502
 503 ROKEN_LIB_FUNCTION void ROKEN_LIB_CALL
 504 rk_cloexec_dir(DIR *);
 505
 506 ROKEN_LIB_FUNCTION void ROKEN_LIB_CALL
 507 rk_cloexec_socket(rk_socket_t);
 508
 509 ROKEN_LIB_FUNCTION int ROKEN_LIB_CALL
 510 ct_memcmp(const volatile void * volatile,
 511           const volatile void * volatile,
 512           size_t);
 513
 514 void ROKEN_LIB_FUNCTION
 515 rk_random_init(void);
 516
 517 ROKEN_LIB_FUNCTION int ROKEN_LIB_CALL
 518 rk_mkdir(const char *, mode_t);
 519
 520 ROKEN_CPP_END
 521
 522 #endif /* __ROKEN_COMMON_H__ */