src/include/k5-platform.h

   1 /*
   2  * k5-platform.h
   3  *
   4  * Copyright 2003, 2004, 2005, 2007, 2008, 2009 Massachusetts Institute of Technology.
   5  * All Rights Reserved.
   6  *
   7  * Export of this software from the United States of America may
   8  *   require a specific license from the United States Government.
   9  *   It is the responsibility of any person or organization contemplating
  10  *   export to obtain such a license before exporting.
  11  *
  12  * WITHIN THAT CONSTRAINT, permission to use, copy, modify, and
  13  * distribute this software and its documentation for any purpose and
  14  * without fee is hereby granted, provided that the above copyright
  15  * notice appear in all copies and that both that copyright notice and
  16  * this permission notice appear in supporting documentation, and that
  17  * the name of M.I.T. not be used in advertising or publicity pertaining
  18  * to distribution of the software without specific, written prior
  19  * permission.  Furthermore if you modify this software you must label
  20  * your software as modified software and not distribute it in such a
  21  * fashion that it might be confused with the original M.I.T. software.
  22  * M.I.T. makes no representations about the suitability of
  23  * this software for any purpose.  It is provided "as is" without express
  24  * or implied warranty.
  25  *
  26  *
  27  * Some platform-dependent definitions to sync up the C support level.
  28  * Some to a C99-ish level, some related utility code.
  29  *
  30  * Currently:
  31  * + [u]int{8,16,32}_t types
  32  * + 64-bit types and load/store code
  33  * + SIZE_MAX
  34  * + shared library init/fini hooks
  35  * + consistent getpwnam/getpwuid interfaces
  36  * + va_copy fudged if not provided
  37  * + [v]asprintf
  38  */
  39
  40 #ifndef K5_PLATFORM_H
  41 #define K5_PLATFORM_H
  42
  43 #include "autoconf.h"
  44 #include <assert.h>
  45 #include <string.h>
  46 #include <stdarg.h>
  47 #include <limits.h>
  48 #include <stdlib.h>
  49 #include <stdio.h>
  50 #include <fcntl.h>
  51 #include <errno.h>
  52
  53 #ifdef _WIN32
  54 #define CAN_COPY_VA_LIST
  55 #endif
  56
  57 #if defined(macintosh) || (defined(__MACH__) && defined(__APPLE__))
  58 #include <TargetConditionals.h>
  59 #endif
  60
  61 /* Initialization and finalization function support for libraries.
  62
  63    At top level, before the functions are defined or even declared:
  64    MAKE_INIT_FUNCTION(init_fn);
  65    MAKE_FINI_FUNCTION(fini_fn);
  66    Then:
  67    int init_fn(void) { ... }
  68    void fini_fn(void) { if (INITIALIZER_RAN(init_fn)) ... }
  69    In code, in the same file:
  70    err = CALL_INIT_FUNCTION(init_fn);
  71
  72    To trigger or verify the initializer invocation from another file,
  73    a helper function must be created.
  74
  75    This model handles both the load-time execution (Windows) and
  76    delayed execution (pthread_once) approaches, and should be able to
  77    guarantee in both cases that the init function is run once, in one
  78    thread, before other stuff in the library is done; furthermore, the
  79    finalization code should only run if the initialization code did.
  80    (Maybe I could've made the "if INITIALIZER_RAN" test implicit, via
  81    another function hidden in macros, but this is hairy enough
  82    already.)
  83
  84    The init_fn and fini_fn names should be chosen such that any
  85    exported names staring with those names, and optionally followed by
  86    additional characters, fits in with any namespace constraints on
  87    the library in question.
  88
  89
  90    There's also PROGRAM_EXITING() currently always defined as zero.
  91    If there's some trivial way to find out if the fini function is
  92    being called because the program that the library is linked into is
  93    exiting, we can just skip all the work because the resources are
  94    about to be freed up anyways.  Generally this is likely to be the
  95    same as distinguishing whether the library was loaded dynamically
  96    while the program was running, or loaded as part of program
  97    startup.  On most platforms, I don't think we can distinguish these
  98    cases easily, and it's probably not worth expending any significant
  99    effort.  (Note in particular that atexit() won't do, because if the
 100    library is explicitly loaded and unloaded, it would have to be able
 101    to deregister the atexit callback function.  Also, the system limit
 102    on atexit callbacks may be small.)
 103
 104
 105    Implementation outline:
 106
 107    Windows: MAKE_FINI_FUNCTION creates a symbol with a magic name that
 108    is sought at library build time, and code is added to invoke the
 109    function when the library is unloaded.  MAKE_INIT_FUNCTION does
 110    likewise, but the function is invoked when the library is loaded,
 111    and an extra variable is declared to hold an error code and a "yes
 112    the initializer ran" flag.  CALL_INIT_FUNCTION blows up if the flag
 113    isn't set, otherwise returns the error code.
 114
 115    UNIX: MAKE_INIT_FUNCTION creates and initializes a variable with a
 116    name derived from the function name, containing a k5_once_t
 117    (pthread_once_t or int), an error code, and a pointer to the
 118    function.  The function itself is declared static, but the
 119    associated variable has external linkage.  CALL_INIT_FUNCTION
 120    ensures thath the function is called exactly once (pthread_once or
 121    just check the flag) and returns the stored error code (or the
 122    pthread_once error).
 123
 124    (That's the basic idea.  With some debugging assert() calls and
 125    such, it's a bit more complicated.  And we also need to handle
 126    doing the pthread test at run time on systems where that works, so
 127    we use the k5_once_t stuff instead.)
 128
 129    UNIX, with compiler support: MAKE_FINI_FUNCTION declares the
 130    function as a destructor, and the run time linker support or
 131    whatever will cause it to be invoked when the library is unloaded,
 132    the program ends, etc.
 133
 134    UNIX, with linker support: MAKE_FINI_FUNCTION creates a symbol with
 135    a magic name that is sought at library build time, and linker
 136    options are used to mark it as a finalization function for the
 137    library.  The symbol must be exported.
 138
 139    UNIX, no library finalization support: The finalization function
 140    never runs, and we leak memory.  Tough.
 141
 142    DELAY_INITIALIZER will be defined by the configure script if we
 143    want to use k5_once instead of load-time initialization.  That'll
 144    be the preferred method on most systems except Windows, where we
 145    have to initialize some mutexes.
 146
 147
 148
 149
 150    For maximum flexibility in defining the macros, the function name
 151    parameter should be a simple name, not even a macro defined as
 152    another name.  The function should have a unique name, and should
 153    conform to whatever namespace is used by the library in question.
 154    (We do have export lists, but (1) they're not used for all
 155    platforms, and (2) they're not used for static libraries.)
 156
 157    If the macro expansion needs the function to have been declared, it
 158    must include a declaration.  If it is not necessary for the symbol
 159    name to be exported from the object file, the macro should declare
 160    it as "static".  Hence the signature must exactly match "void
 161    foo(void)".  (ANSI C allows a static declaration followed by a
 162    non-static one; the result is internal linkage.)  The macro
 163    expansion has to come before the function, because gcc apparently
 164    won't act on "__attribute__((constructor))" if it comes after the
 165    function definition.
 166
 167    This is going to be compiler- and environment-specific, and may
 168    require some support at library build time, and/or "asm"
 169    statements.  But through macro expansion and auxiliary functions,
 170    we should be able to handle most things except #pragma.
 171
 172    It's okay for this code to require that the library be built
 173    with the same compiler and compiler options throughout, but
 174    we shouldn't require that the library and application use the
 175    same compiler.
 176
 177    For static libraries, we don't really care about cleanup too much,
 178    since it's all memory handling and mutex allocation which will all
 179    be cleaned up when the program exits.  Thus, it's okay if gcc-built
 180    static libraries don't play nicely with cc-built executables when
 181    it comes to static constructors, just as long as it doesn't cause
 182    linking to fail.
 183
 184    For dynamic libraries on UNIX, we'll use pthread_once-type support
 185    to do delayed initialization, so if finalization can't be made to
 186    work, we'll only have memory leaks in a load/use/unload cycle.  If
 187    anyone (like, say, the OS vendor) complains about this, they can
 188    tell us how to get a shared library finalization function invoked
 189    automatically.
 190
 191    Currently there's --disable-delayed-initialization for preventing
 192    the initialization from being delayed on UNIX, but that's mainly
 193    just for testing the linker options for initialization, and will
 194    probably be removed at some point.  */
 195
 196 /* Helper macros.  */
 197
 198 # define JOIN__2_2(A,B) A ## _ ## _ ## B
 199 # define JOIN__2(A,B) JOIN__2_2(A,B)
 200
 201 /* XXX Should test USE_LINKER_INIT_OPTION early, and if it's set,
 202    always provide a function by the expected name, even if we're
 203    delaying initialization.  */
 204
 205 #if defined(DELAY_INITIALIZER)
 206
 207 /* Run the initialization code during program execution, at the latest
 208    possible moment.  This means multiple threads may be active.  */
 209 # include "k5-thread.h"
 210 typedef struct { k5_once_t once; int error, did_run; void (*fn)(void); } k5_init_t;
 211 # ifdef USE_LINKER_INIT_OPTION
 212 #  define MAYBE_DUMMY_INIT(NAME)                \
 213         void JOIN__2(NAME, auxinit) () { }
 214 # else
 215 #  define MAYBE_DUMMY_INIT(NAME)
 216 # endif
 217 # ifdef __GNUC__
 218 /* Do it in macro form so we get the file/line of the invocation if
 219    the assertion fails.  */
 220 #  define k5_call_init_function(I)                                      \
 221         (__extension__ ({                                               \
 222                 k5_init_t *k5int_i = (I);                               \
 223                 int k5int_err = k5_once(&k5int_i->once, k5int_i->fn);   \
 224                 (k5int_err                                              \
 225                  ? k5int_err                                            \
 226                  : (assert(k5int_i->did_run != 0), k5int_i->error));    \
 227             }))
 228 #  define MAYBE_DEFINE_CALLINIT_FUNCTION
 229 # else
 230 #  define MAYBE_DEFINE_CALLINIT_FUNCTION                        \
 231         static inline int k5_call_init_function(k5_init_t *i)   \
 232         {                                                       \
 233             int err;                                            \
 234             err = k5_once(&i->once, i->fn);                     \
 235             if (err)                                            \
 236                 return err;                                     \
 237             assert (i->did_run != 0);                           \
 238             return i->error;                                    \
 239         }
 240 # endif
 241 # define MAKE_INIT_FUNCTION(NAME)                               \
 242         static int NAME(void);                                  \
 243         MAYBE_DUMMY_INIT(NAME)                                  \
 244         /* forward declaration for use in initializer */        \
 245         static void JOIN__2(NAME, aux) (void);                  \
 246         static k5_init_t JOIN__2(NAME, once) =                  \
 247                 { K5_ONCE_INIT, 0, 0, JOIN__2(NAME, aux) };     \
 248         MAYBE_DEFINE_CALLINIT_FUNCTION                          \
 249         static void JOIN__2(NAME, aux) (void)                   \
 250         {                                                       \
 251             JOIN__2(NAME, once).did_run = 1;                    \
 252             JOIN__2(NAME, once).error = NAME();                 \
 253         }                                                       \
 254         /* so ';' following macro use won't get error */        \
 255         static int NAME(void)
 256 # define CALL_INIT_FUNCTION(NAME)       \
 257         k5_call_init_function(& JOIN__2(NAME, once))
 258 /* This should be called in finalization only, so we shouldn't have
 259    multiple active threads mucking around in our library at this
 260    point.  So ignore the once_t object and just look at the flag.
 261
 262    XXX Could we have problems with memory coherence between processors
 263    if we don't invoke mutex/once routines?  Probably not, the
 264    application code should already be coordinating things such that
 265    the library code is not in use by this point, and memory
 266    synchronization will be needed there.  */
 267 # define INITIALIZER_RAN(NAME)  \
 268         (JOIN__2(NAME, once).did_run && JOIN__2(NAME, once).error == 0)
 269
 270 # define PROGRAM_EXITING()              (0)
 271
 272 #elif defined(__GNUC__) && !defined(_WIN32) && defined(CONSTRUCTOR_ATTR_WORKS)
 273
 274 /* Run initializer at load time, via GCC/C++ hook magic.  */
 275
 276 # ifdef USE_LINKER_INIT_OPTION
 277      /* Both gcc and linker option??  Favor gcc.  */
 278 #  define MAYBE_DUMMY_INIT(NAME)                \
 279         void JOIN__2(NAME, auxinit) () { }
 280 # else
 281 #  define MAYBE_DUMMY_INIT(NAME)
 282 # endif
 283
 284 typedef struct { int error; unsigned char did_run; } k5_init_t;
 285 # define MAKE_INIT_FUNCTION(NAME)               \
 286         MAYBE_DUMMY_INIT(NAME)                  \
 287         static k5_init_t JOIN__2(NAME, ran)     \
 288                 = { 0, 2 };                     \
 289         static void JOIN__2(NAME, aux)(void)    \
 290             __attribute__((constructor));       \
 291         static int NAME(void);                  \
 292         static void JOIN__2(NAME, aux)(void)    \
 293         {                                       \
 294             JOIN__2(NAME, ran).error = NAME();  \
 295             JOIN__2(NAME, ran).did_run = 3;     \
 296         }                                       \
 297         static int NAME(void)
 298 # define CALL_INIT_FUNCTION(NAME)               \
 299         (JOIN__2(NAME, ran).did_run == 3        \
 300          ? JOIN__2(NAME, ran).error             \
 301          : (abort(),0))
 302 # define INITIALIZER_RAN(NAME)  (JOIN__2(NAME,ran).did_run == 3 && JOIN__2(NAME, ran).error == 0)
 303
 304 # define PROGRAM_EXITING()              (0)
 305
 306 #elif defined(USE_LINKER_INIT_OPTION) || defined(_WIN32)
 307
 308 /* Run initializer at load time, via linker magic, or in the
 309    case of WIN32, win_glue.c hard-coded knowledge.  */
 310 typedef struct { int error; unsigned char did_run; } k5_init_t;
 311 # define MAKE_INIT_FUNCTION(NAME)               \
 312         static k5_init_t JOIN__2(NAME, ran)     \
 313                 = { 0, 2 };                     \
 314         static int NAME(void);                  \
 315         void JOIN__2(NAME, auxinit)()           \
 316         {                                       \
 317             JOIN__2(NAME, ran).error = NAME();  \
 318             JOIN__2(NAME, ran).did_run = 3;     \
 319         }                                       \
 320         static int NAME(void)
 321 # define CALL_INIT_FUNCTION(NAME)               \
 322         (JOIN__2(NAME, ran).did_run == 3        \
 323          ? JOIN__2(NAME, ran).error             \
 324          : (abort(),0))
 325 # define INITIALIZER_RAN(NAME)  \
 326         (JOIN__2(NAME, ran).error == 0)
 327
 328 # define PROGRAM_EXITING()              (0)
 329
 330 #else
 331
 332 # error "Don't know how to do load-time initializers for this configuration."
 333
 334 # define PROGRAM_EXITING()              (0)
 335
 336 #endif
 337
 338
 339
 340 #if defined(USE_LINKER_FINI_OPTION) || defined(_WIN32)
 341 /* If we're told the linker option will be used, it doesn't really
 342    matter what compiler we're using.  Do it the same way
 343    regardless.  */
 344
 345 # ifdef __hpux
 346
 347      /* On HP-UX, we need this auxiliary function.  At dynamic load or
 348         unload time (but *not* program startup and termination for
 349         link-time specified libraries), the linker-indicated function
 350         is called with a handle on the library and a flag indicating
 351         whether it's being loaded or unloaded.
 352
 353         The "real" fini function doesn't need to be exported, so
 354         declare it static.
 355
 356         As usual, the final declaration is just for syntactic
 357         convenience, so the top-level invocation of this macro can be
 358         followed by a semicolon.  */
 359
 360 #  include <dl.h>
 361 #  define MAKE_FINI_FUNCTION(NAME)                                          \
 362         static void NAME(void);                                             \
 363         void JOIN__2(NAME, auxfini)(shl_t, int); /* silence gcc warnings */ \
 364         void JOIN__2(NAME, auxfini)(shl_t h, int l) { if (!l) NAME(); }     \
 365         static void NAME(void)
 366
 367 # else /* not hpux */
 368
 369 #  define MAKE_FINI_FUNCTION(NAME)      \
 370         void NAME(void)
 371
 372 # endif
 373
 374 #elif defined(__GNUC__) && defined(DESTRUCTOR_ATTR_WORKS)
 375 /* If we're using gcc, if the C++ support works, the compiler should
 376    build executables and shared libraries that support the use of
 377    static constructors and destructors.  The C compiler supports a
 378    function attribute that makes use of the same facility as C++.
 379
 380    XXX How do we know if the C++ support actually works?  */
 381 # define MAKE_FINI_FUNCTION(NAME)       \
 382         static void NAME(void) __attribute__((destructor))
 383
 384 #elif !defined(SHARED)
 385
 386 /* In this case, we just don't care about finalization.
 387
 388    The code will still define the function, but we won't do anything
 389    with it.  Annoying: This may generate unused-function warnings.  */
 390
 391 # define MAKE_FINI_FUNCTION(NAME)       \
 392         static void NAME(void)
 393
 394 #else
 395
 396 # error "Don't know how to do unload-time finalization for this configuration."
 397
 398 #endif
 399
 400
 401 /* 64-bit support: krb5_ui_8 and krb5_int64.
 402
 403    This should move to krb5.h eventually, but without the namespace
 404    pollution from the autoconf macros.  */
 405 #if defined(HAVE_STDINT_H) || defined(HAVE_INTTYPES_H)
 406 # ifdef HAVE_STDINT_H
 407 #  include <stdint.h>
 408 # endif
 409 # ifdef HAVE_INTTYPES_H
 410 #  include <inttypes.h>
 411 # endif
 412 # define INT64_TYPE int64_t
 413 # define UINT64_TYPE uint64_t
 414 #elif defined(_WIN32)
 415 # define INT64_TYPE signed __int64
 416 # define UINT64_TYPE unsigned __int64
 417 #else /* not Windows, and neither stdint.h nor inttypes.h */
 418 # define INT64_TYPE signed long long
 419 # define UINT64_TYPE unsigned long long
 420 #endif
 421
 422 #ifndef SIZE_MAX
 423 # define SIZE_MAX ((size_t)((size_t)0 - 1))
 424 #endif
 425
 426 #ifndef UINT64_MAX
 427 # define UINT64_MAX ((UINT64_TYPE)((UINT64_TYPE)0 - 1))
 428 #endif
 429
 430 #ifdef _WIN32
 431 # define SSIZE_MAX ((ssize_t)(SIZE_MAX/2))
 432 #endif
 433
 434 /* Read and write integer values as (unaligned) octet strings in
 435    specific byte orders.  Add per-platform optimizations as
 436    needed.  */
 437
 438 #if HAVE_ENDIAN_H
 439 # include <endian.h>
 440 #elif HAVE_MACHINE_ENDIAN_H
 441 # include <machine/endian.h>
 442 #endif
 443 /* Check for BIG/LITTLE_ENDIAN macros.  If exactly one is defined, use
 444    it.  If both are defined, then BYTE_ORDER should be defined and
 445    match one of them.  Try those symbols, then try again with an
 446    underscore prefix.  */
 447 #if defined(BIG_ENDIAN) && defined(LITTLE_ENDIAN)
 448 # if BYTE_ORDER == BIG_ENDIAN
 449 #  define K5_BE
 450 # endif
 451 # if BYTE_ORDER == LITTLE_ENDIAN
 452 #  define K5_LE
 453 # endif
 454 #elif defined(BIG_ENDIAN)
 455 # define K5_BE
 456 #elif defined(LITTLE_ENDIAN)
 457 # define K5_LE
 458 #elif defined(_BIG_ENDIAN) && defined(_LITTLE_ENDIAN)
 459 # if _BYTE_ORDER == _BIG_ENDIAN
 460 #  define K5_BE
 461 # endif
 462 # if _BYTE_ORDER == _LITTLE_ENDIAN
 463 #  define K5_LE
 464 # endif
 465 #elif defined(_BIG_ENDIAN)
 466 # define K5_BE
 467 #elif defined(_LITTLE_ENDIAN)
 468 # define K5_LE
 469 #endif
 470 #if !defined(K5_BE) && !defined(K5_LE)
 471 /* Look for some architectures we know about.
 472
 473    MIPS can use either byte order, but the preprocessor tells us which
 474    mode we're compiling for.  The GCC config files indicate that
 475    variants of Alpha and IA64 might be out there with both byte
 476    orders, but until we encounter the "wrong" ones in the real world,
 477    just go with the default (unless there are cpp predefines to help
 478    us there too).
 479
 480    As far as I know, only PDP11 and ARM (which we don't handle here)
 481    have strange byte orders where an 8-byte value isn't laid out as
 482    either 12345678 or 87654321.  */
 483 # if defined(__i386__) || defined(_MIPSEL) || defined(__alpha__) || defined(__ia64__)
 484 #  define K5_LE
 485 # endif
 486 # if defined(__hppa__) || defined(__rs6000__) || defined(__sparc__) || defined(_MIPSEB) || defined(__m68k__) || defined(__sparc64__) || defined(__ppc__) || defined(__ppc64__)
 487 #  define K5_BE
 488 # endif
 489 #endif
 490 #if defined(K5_BE) && defined(K5_LE)
 491 # error "oops, check the byte order macros"
 492 #endif
 493
 494 /* Optimize for GCC on platforms with known byte orders.
 495
 496    GCC's packed structures can be written to with any alignment; the
 497    compiler will use byte operations, unaligned-word operations, or
 498    normal memory ops as appropriate for the architecture.
 499
 500    This assumes the availability of uint##_t types, which should work
 501    on most of our platforms except Windows, where we're not using
 502    GCC.  */
 503 #ifdef __GNUC__
 504 # define PUT(SIZE,PTR,VAL)      (((struct { uint##SIZE##_t i; } __attribute__((packed)) *)(PTR))->i = (VAL))
 505 # define GET(SIZE,PTR)          (((const struct { uint##SIZE##_t i; } __attribute__((packed)) *)(PTR))->i)
 506 # define PUTSWAPPED(SIZE,PTR,VAL)       PUT(SIZE,PTR,SWAP##SIZE(VAL))
 507 # define GETSWAPPED(SIZE,PTR)           SWAP##SIZE(GET(SIZE,PTR))
 508 #endif
 509 /* To do: Define SWAP16, SWAP32, SWAP64 macros to byte-swap values
 510    with the indicated numbers of bits.
 511
 512    Linux: byteswap.h, bswap_16 etc.
 513    Solaris 10: none
 514    Mac OS X: machine/endian.h or byte_order.h, NXSwap{Short,Int,LongLong}
 515    NetBSD: sys/bswap.h, bswap16 etc.  */
 516
 517 #if defined(HAVE_BYTESWAP_H) && defined(HAVE_BSWAP_16)
 518 # include <byteswap.h>
 519 # define SWAP16                 bswap_16
 520 # define SWAP32                 bswap_32
 521 # ifdef HAVE_BSWAP_64
 522 #  define SWAP64                bswap_64
 523 # endif
 524 #endif
 525 #if TARGET_OS_MAC
 526 # include <architecture/byte_order.h>
 527 # if 0 /* This causes compiler warnings.  */
 528 #  define SWAP16                OSSwapInt16
 529 # else
 530 #  define SWAP16                k5_swap16
 531 static inline unsigned int k5_swap16 (unsigned int x) {
 532     x &= 0xffff;
 533     return (x >> 8) | ((x & 0xff) << 8);
 534 }
 535 # endif
 536 # define SWAP32                 OSSwapInt32
 537 # define SWAP64                 OSSwapInt64
 538 #endif
 539
 540 /* Note that on Windows at least this file can be included from C++
 541    source, so casts *from* void* are required.  */
 542 static inline void
 543 store_16_be (unsigned int val, void *vp)
 544 {
 545     unsigned char *p = (unsigned char *) vp;
 546 #if defined(__GNUC__) && defined(K5_BE) && !defined(__cplusplus)
 547     PUT(16,p,val);
 548 #elif defined(__GNUC__) && defined(K5_LE) && defined(SWAP16) && !defined(__cplusplus)
 549     PUTSWAPPED(16,p,val);
 550 #else
 551     p[0] = (val >>  8) & 0xff;
 552     p[1] = (val      ) & 0xff;
 553 #endif
 554 }
 555 static inline void
 556 store_32_be (unsigned int val, void *vp)
 557 {
 558     unsigned char *p = (unsigned char *) vp;
 559 #if defined(__GNUC__) && defined(K5_BE) && !defined(__cplusplus)
 560     PUT(32,p,val);
 561 #elif defined(__GNUC__) && defined(K5_LE) && defined(SWAP32) && !defined(__cplusplus)
 562     PUTSWAPPED(32,p,val);
 563 #else
 564     p[0] = (val >> 24) & 0xff;
 565     p[1] = (val >> 16) & 0xff;
 566     p[2] = (val >>  8) & 0xff;
 567     p[3] = (val      ) & 0xff;
 568 #endif
 569 }
 570 static inline void
 571 store_64_be (UINT64_TYPE val, void *vp)
 572 {
 573     unsigned char *p = (unsigned char *) vp;
 574 #if defined(__GNUC__) && defined(K5_BE) && !defined(__cplusplus)
 575     PUT(64,p,val);
 576 #elif defined(__GNUC__) && defined(K5_LE) && defined(SWAP64) && !defined(__cplusplus)
 577     PUTSWAPPED(64,p,val);
 578 #else
 579     p[0] = (unsigned char)((val >> 56) & 0xff);
 580     p[1] = (unsigned char)((val >> 48) & 0xff);
 581     p[2] = (unsigned char)((val >> 40) & 0xff);
 582     p[3] = (unsigned char)((val >> 32) & 0xff);
 583     p[4] = (unsigned char)((val >> 24) & 0xff);
 584     p[5] = (unsigned char)((val >> 16) & 0xff);
 585     p[6] = (unsigned char)((val >>  8) & 0xff);
 586     p[7] = (unsigned char)((val      ) & 0xff);
 587 #endif
 588 }
 589 static inline unsigned short
 590 load_16_be (const void *cvp)
 591 {
 592     const unsigned char *p = (const unsigned char *) cvp;
 593 #if defined(__GNUC__) && defined(K5_BE) && !defined(__cplusplus)
 594     return GET(16,p);
 595 #elif defined(__GNUC__) && defined(K5_LE) && defined(SWAP16) && !defined(__cplusplus)
 596     return GETSWAPPED(16,p);
 597 #else
 598     return (p[1] | (p[0] << 8));
 599 #endif
 600 }
 601 static inline unsigned int
 602 load_32_be (const void *cvp)
 603 {
 604     const unsigned char *p = (const unsigned char *) cvp;
 605 #if defined(__GNUC__) && defined(K5_BE) && !defined(__cplusplus)
 606     return GET(32,p);
 607 #elif defined(__GNUC__) && defined(K5_LE) && defined(SWAP32) && !defined(__cplusplus)
 608     return GETSWAPPED(32,p);
 609 #else
 610     return (p[3] | (p[2] << 8)
 611             | ((uint32_t) p[1] << 16)
 612             | ((uint32_t) p[0] << 24));
 613 #endif
 614 }
 615 static inline UINT64_TYPE
 616 load_64_be (const void *cvp)
 617 {
 618     const unsigned char *p = (const unsigned char *) cvp;
 619 #if defined(__GNUC__) && defined(K5_BE) && !defined(__cplusplus)
 620     return GET(64,p);
 621 #elif defined(__GNUC__) && defined(K5_LE) && defined(SWAP64) && !defined(__cplusplus)
 622     return GETSWAPPED(64,p);
 623 #else
 624     return ((UINT64_TYPE)load_32_be(p) << 32) | load_32_be(p+4);
 625 #endif
 626 }
 627 static inline void
 628 store_16_le (unsigned int val, void *vp)
 629 {
 630     unsigned char *p = (unsigned char *) vp;
 631 #if defined(__GNUC__) && defined(K5_LE) && !defined(__cplusplus)
 632     PUT(16,p,val);
 633 #elif defined(__GNUC__) && defined(K5_BE) && defined(SWAP16) && !defined(__cplusplus)
 634     PUTSWAPPED(16,p,val);
 635 #else
 636     p[1] = (val >>  8) & 0xff;
 637     p[0] = (val      ) & 0xff;
 638 #endif
 639 }
 640 static inline void
 641 store_32_le (unsigned int val, void *vp)
 642 {
 643     unsigned char *p = (unsigned char *) vp;
 644 #if defined(__GNUC__) && defined(K5_LE) && !defined(__cplusplus)
 645     PUT(32,p,val);
 646 #elif defined(__GNUC__) && defined(K5_BE) && defined(SWAP32) && !defined(__cplusplus)
 647     PUTSWAPPED(32,p,val);
 648 #else
 649     p[3] = (val >> 24) & 0xff;
 650     p[2] = (val >> 16) & 0xff;
 651     p[1] = (val >>  8) & 0xff;
 652     p[0] = (val      ) & 0xff;
 653 #endif
 654 }
 655 static inline void
 656 store_64_le (UINT64_TYPE val, void *vp)
 657 {
 658     unsigned char *p = (unsigned char *) vp;
 659 #if defined(__GNUC__) && defined(K5_LE) && !defined(__cplusplus)
 660     PUT(64,p,val);
 661 #elif defined(__GNUC__) && defined(K5_BE) && defined(SWAP64) && !defined(__cplusplus)
 662     PUTSWAPPED(64,p,val);
 663 #else
 664     p[7] = (unsigned char)((val >> 56) & 0xff);
 665     p[6] = (unsigned char)((val >> 48) & 0xff);
 666     p[5] = (unsigned char)((val >> 40) & 0xff);
 667     p[4] = (unsigned char)((val >> 32) & 0xff);
 668     p[3] = (unsigned char)((val >> 24) & 0xff);
 669     p[2] = (unsigned char)((val >> 16) & 0xff);
 670     p[1] = (unsigned char)((val >>  8) & 0xff);
 671     p[0] = (unsigned char)((val      ) & 0xff);
 672 #endif
 673 }
 674 static inline unsigned short
 675 load_16_le (const void *cvp)
 676 {
 677     const unsigned char *p = (const unsigned char *) cvp;
 678 #if defined(__GNUC__) && defined(K5_LE) && !defined(__cplusplus)
 679     return GET(16,p);
 680 #elif defined(__GNUC__) && defined(K5_BE) && defined(SWAP16) && !defined(__cplusplus)
 681     return GETSWAPPED(16,p);
 682 #else
 683     return (p[0] | (p[1] << 8));
 684 #endif
 685 }
 686 static inline unsigned int
 687 load_32_le (const void *cvp)
 688 {
 689     const unsigned char *p = (const unsigned char *) cvp;
 690 #if defined(__GNUC__) && defined(K5_LE) && !defined(__cplusplus)
 691     return GET(32,p);
 692 #elif defined(__GNUC__) && defined(K5_BE) && defined(SWAP32) && !defined(__cplusplus)
 693     return GETSWAPPED(32,p);
 694 #else
 695     return (p[0] | (p[1] << 8) | (p[2] << 16) | (p[3] << 24));
 696 #endif
 697 }
 698 static inline UINT64_TYPE
 699 load_64_le (const void *cvp)
 700 {
 701     const unsigned char *p = (const unsigned char *) cvp;
 702 #if defined(__GNUC__) && defined(K5_LE) && !defined(__cplusplus)
 703     return GET(64,p);
 704 #elif defined(__GNUC__) && defined(K5_BE) && defined(SWAP64) && !defined(__cplusplus)
 705     return GETSWAPPED(64,p);
 706 #else
 707     return ((UINT64_TYPE)load_32_le(p+4) << 32) | load_32_le(p);
 708 #endif
 709 }
 710
 711 static inline unsigned short
 712 load_16_n (const void *p)
 713 {
 714 #ifdef _WIN32
 715     unsigned __int16 n;
 716 #else
 717     uint16_t n;
 718 #endif
 719     memcpy(&n, p, 2);
 720     return n;
 721 }
 722 static inline unsigned int
 723 load_32_n (const void *p)
 724 {
 725 #ifdef _WIN32
 726     unsigned __int32 n;
 727 #else
 728     uint32_t n;
 729 #endif
 730     memcpy(&n, p, 4);
 731     return n;
 732 }
 733 static inline UINT64_TYPE
 734 load_64_n (const void *p)
 735 {
 736     UINT64_TYPE n;
 737     memcpy(&n, p, 8);
 738     return n;
 739 }
 740
 741 /* Assume for simplicity that these swaps are identical.  */
 742 static inline UINT64_TYPE
 743 k5_htonll (UINT64_TYPE val)
 744 {
 745 #ifdef K5_BE
 746     return val;
 747 #elif defined K5_LE && defined SWAP64
 748     return SWAP64 (val);
 749 #else
 750     return load_64_be ((unsigned char *)&val);
 751 #endif
 752 }
 753 static inline UINT64_TYPE
 754 k5_ntohll (UINT64_TYPE val)
 755 {
 756     return k5_htonll (val);
 757 }
 758
 759 /* Make the interfaces to getpwnam and getpwuid consistent.
 760    Model the wrappers on the POSIX thread-safe versions, but
 761    use the unsafe system versions if the safe ones don't exist
 762    or we can't figure out their interfaces.  */
 763
 764 /* int k5_getpwnam_r(const char *, blah blah) */
 765 #ifdef HAVE_GETPWNAM_R
 766 # ifndef GETPWNAM_R_4_ARGS
 767 /* POSIX */
 768 #  define k5_getpwnam_r(NAME, REC, BUF, BUFSIZE, OUT)   \
 769         (getpwnam_r(NAME,REC,BUF,BUFSIZE,OUT) == 0      \
 770          ? (*(OUT) == NULL ? -1 : 0) : -1)
 771 # else
 772 /* POSIX drafts? */
 773 #  ifdef GETPWNAM_R_RETURNS_INT
 774 #   define k5_getpwnam_r(NAME, REC, BUF, BUFSIZE, OUT)  \
 775         (getpwnam_r(NAME,REC,BUF,BUFSIZE) == 0          \
 776          ? (*(OUT) = REC, 0)                            \
 777          : (*(OUT) = NULL, -1))
 778 #  else
 779 #   define k5_getpwnam_r(NAME, REC, BUF, BUFSIZE, OUT)  \
 780         (*(OUT) = getpwnam_r(NAME,REC,BUF,BUFSIZE), *(OUT) == NULL ? -1 : 0)
 781 #  endif
 782 # endif
 783 #else /* no getpwnam_r, or can't figure out #args or return type */
 784 /* Will get warnings about unused variables.  */
 785 # define k5_getpwnam_r(NAME, REC, BUF, BUFSIZE, OUT) \
 786         (*(OUT) = getpwnam(NAME), *(OUT) == NULL ? -1 : 0)
 787 #endif
 788
 789 /* int k5_getpwuid_r(uid_t, blah blah) */
 790 #ifdef HAVE_GETPWUID_R
 791 # ifndef GETPWUID_R_4_ARGS
 792 /* POSIX */
 793 #  define k5_getpwuid_r(UID, REC, BUF, BUFSIZE, OUT)    \
 794         (getpwuid_r(UID,REC,BUF,BUFSIZE,OUT) == 0       \
 795          ? (*(OUT) == NULL ? -1 : 0) : -1)
 796 # else
 797 /* POSIX drafts?  Yes, I mean to test GETPWNAM... here.  Less junk to
 798    do at configure time.  */
 799 #  ifdef GETPWNAM_R_RETURNS_INT
 800 #   define k5_getpwuid_r(UID, REC, BUF, BUFSIZE, OUT)   \
 801         (getpwuid_r(UID,REC,BUF,BUFSIZE) == 0           \
 802          ? (*(OUT) = REC, 0)                            \
 803          : (*(OUT) = NULL, -1))
 804 #  else
 805 #   define k5_getpwuid_r(UID, REC, BUF, BUFSIZE, OUT)  \
 806         (*(OUT) = getpwuid_r(UID,REC,BUF,BUFSIZE), *(OUT) == NULL ? -1 : 0)
 807 #  endif
 808 # endif
 809 #else /* no getpwuid_r, or can't figure out #args or return type */
 810 /* Will get warnings about unused variables.  */
 811 # define k5_getpwuid_r(UID, REC, BUF, BUFSIZE, OUT) \
 812         (*(OUT) = getpwuid(UID), *(OUT) == NULL ? -1 : 0)
 813 #endif
 814
 815 /* Ensure, if possible, that the indicated file descriptor won't be
 816    kept open if we exec another process (e.g., launching a ccapi
 817    server).  If we don't know how to do it... well, just go about our
 818    business.  Probably most callers won't check the return status
 819    anyways.  */
 820
 821 #if 0
 822 static inline int
 823 set_cloexec_fd(int fd)
 824 {
 825 #if defined(F_SETFD)
 826 # ifdef FD_CLOEXEC
 827     if (fcntl(fd, F_SETFD, FD_CLOEXEC) != 0)
 828         return errno;
 829 # else
 830     if (fcntl(fd, F_SETFD, 1) != 0)
 831         return errno;
 832 # endif
 833 #endif
 834     return 0;
 835 }
 836
 837 static inline int
 838 set_cloexec_file(FILE *f)
 839 {
 840     return set_cloexec_fd(fileno(f));
 841 }
 842 #else
 843 /* Macros make the Sun compiler happier, and all variants of this do a
 844    single evaluation of the argument, and fcntl and fileno should
 845    produce reasonable error messages on type mismatches, on any system
 846    with F_SETFD.  */
 847 #ifdef F_SETFD
 848 # ifdef FD_CLOEXEC
 849 #  define set_cloexec_fd(FD)    (fcntl((FD), F_SETFD, FD_CLOEXEC) ? errno : 0)
 850 # else
 851 #  define set_cloexec_fd(FD)    (fcntl((FD), F_SETFD, 1) ? errno : 0)
 852 # endif
 853 #else
 854 # define set_cloexec_fd(FD)     ((FD),0)
 855 #endif
 856 #define set_cloexec_file(F)     set_cloexec_fd(fileno(F))
 857 #endif
 858
 859
 860
 861 /* Since the original ANSI C spec left it undefined whether or
 862    how you could copy around a va_list, C 99 added va_copy.
 863    For old implementations, let's do our best to fake it.
 864
 865    XXX Doesn't yet handle implementations with __va_copy (early draft)
 866    or GCC's __builtin_va_copy.  */
 867 #if defined(HAS_VA_COPY) || defined(va_copy)
 868 /* Do nothing.  */
 869 #elif defined(CAN_COPY_VA_LIST)
 870 #define va_copy(dest, src)      ((dest) = (src))
 871 #else
 872 /* Assume array type, but still simply copyable.
 873
 874    There is, theoretically, the possibility that va_start will
 875    allocate some storage pointed to by the va_list, and in that case
 876    we'll just lose.  If anyone cares, we could try to devise a test
 877    for that case.  */
 878 #define va_copy(dest, src)      memcmp(dest, src, sizeof(va_list))
 879 #endif
 880
 881 /* Provide strlcpy/strlcat interfaces. */
 882 #ifndef HAVE_STRLCPY
 883 #define strlcpy krb5int_strlcpy
 884 #define strlcat krb5int_strlcat
 885 extern size_t krb5int_strlcpy(char *dst, const char *src, size_t siz);
 886 extern size_t krb5int_strlcat(char *dst, const char *src, size_t siz);
 887 #endif
 888
 889 /* Provide [v]asprintf interfaces.  */
 890 #ifndef HAVE_VSNPRINTF
 891 #ifdef _WIN32
 892 static inline int
 893 vsnprintf(char *str, size_t size, const char *format, va_list args)
 894 {
 895     va_list args_copy;
 896     int length;
 897
 898     va_copy(args_copy, args);
 899     length = _vscprintf(format, args_copy);
 900     va_end(args_copy);
 901     if (size)
 902         _vsnprintf(str, size, format, args);
 903     return length;
 904 }
 905 static inline int
 906 snprintf(char *str, size_t size, const char *format, ...)
 907 {
 908     va_list args;
 909     int n;
 910
 911     va_start(args, format);
 912     n = vsnprintf(str, size, format, args);
 913     va_end(args);
 914     return n;
 915 }
 916 #else /* not win32 */
 917 #error We need an implementation of vsnprintf.
 918 #endif /* win32? */
 919 #endif /* no vsnprintf */
 920
 921 #ifndef HAVE_VASPRINTF
 922
 923 extern int krb5int_vasprintf(char **, const char *, va_list)
 924 #if !defined(__cplusplus) && (__GNUC__ > 2)
 925     __attribute__((__format__(__printf__, 2, 0)))
 926 #endif
 927     ;
 928 extern int krb5int_asprintf(char **, const char *, ...)
 929 #if !defined(__cplusplus) && (__GNUC__ > 2)
 930     __attribute__((__format__(__printf__, 2, 3)))
 931 #endif
 932     ;
 933
 934 #define vasprintf krb5int_vasprintf
 935 /* Assume HAVE_ASPRINTF iff HAVE_VASPRINTF.  */
 936 #define asprintf krb5int_asprintf
 937
 938 #elif defined(NEED_VASPRINTF_PROTO)
 939
 940 extern int vasprintf(char **, const char *, va_list)
 941 #if !defined(__cplusplus) && (__GNUC__ > 2)
 942     __attribute__((__format__(__printf__, 2, 0)))
 943 #endif
 944     ;
 945 extern int asprintf(char **, const char *, ...)
 946 #if !defined(__cplusplus) && (__GNUC__ > 2)
 947     __attribute__((__format__(__printf__, 2, 3)))
 948 #endif
 949     ;
 950
 951 #endif /* have vasprintf and prototype? */
 952
 953 /* Return true if the snprintf return value RESULT reflects a buffer
 954    overflow for the buffer size SIZE.
 955
 956    We cast the result to unsigned int for two reasons.  First, old
 957    implementations of snprintf (such as the one in Solaris 9 and
 958    prior) return -1 on a buffer overflow.  Casting the result to -1
 959    will convert that value to UINT_MAX, which should compare larger
 960    than any reasonable buffer size.  Second, comparing signed and
 961    unsigned integers will generate warnings with some compilers, and
 962    can have unpredictable results, particularly when the relative
 963    widths of the types is not known (size_t may be the same width as
 964    int or larger).
 965 */
 966 #define SNPRINTF_OVERFLOW(result, size) \
 967     ((unsigned int)(result) >= (size_t)(size))
 968
 969 #ifndef HAVE_MKSTEMP
 970 extern int krb5int_mkstemp(char *);
 971 #define mkstemp krb5int_mkstemp
 972 #endif
 973
 974 /* Fudge for future adoption of gettext or the like.  */
 975 #ifndef _
 976 #define _(X) (X)
 977 #endif
 978
 979 #endif /* K5_PLATFORM_H */