libguile/_scm.h

   1 /* classes: h_files */
   2
   3 #ifndef SCM__SCM_H
   4 #define SCM__SCM_H
   5
   6 /* Copyright (C) 1995,1996,2000,2001, 2002, 2006, 2008, 2009, 2010, 2011 Free Software Foundation, Inc.
   7  *
   8  * This library is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU Lesser General Public License
  10  * as published by the Free Software Foundation; either version 3 of
  11  * the License, or (at your option) any later version.
  12  *
  13  * This library is distributed in the hope that it will be useful, but
  14  * WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * Lesser General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU Lesser General Public
  19  * License along with this library; if not, write to the Free Software
  20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  21  * 02110-1301 USA
  22  */
  23
  24 \f
  25
  26 /**********************************************************************
  27  This file is Guile's central private header.
  28
  29  When included by other files, this file should preceed any include
  30  other than __scm.h.  See __scm.h for details regarding the purpose of
  31  and differences between _scm.h and __scm.h.
  32  **********************************************************************/
  33
  34 #if defined(__ia64) && !defined(__ia64__)
  35 # define __ia64__
  36 #endif
  37
  38 #if HAVE_CONFIG_H
  39 #  include <config.h>
  40 #endif
  41
  42 /* The size of `scm_t_bits'.  */
  43 #define SIZEOF_SCM_T_BITS SIZEOF_VOID_P
  44
  45 /* Undefine HAVE_STRUCT_TIMESPEC, because the libguile C code doesn't
  46    need it anymore, and because on MinGW:
  47
  48    - the definition of struct timespec is provided (if at all) by
  49      pthread.h
  50
  51    - pthread.h will _not_ define struct timespec if
  52      HAVE_STRUCT_TIMESPEC is 1, because then it thinks that it doesn't
  53      need to.
  54
  55    The libguile C code doesn't need HAVE_STRUCT_TIMESPEC anymore,
  56    because the value of HAVE_STRUCT_TIMESPEC has already been
  57    incorporated in how scm_t_timespec is defined (in scmconfig.h), and
  58    the rest of the libguile C code now just uses scm_t_timespec.
  59  */
  60 #ifdef HAVE_STRUCT_TIMESPEC
  61 #undef HAVE_STRUCT_TIMESPEC
  62 #endif
  63
  64 #include <errno.h>
  65 #include <verify.h>
  66 #include <alignof.h>
  67 #include "libguile/__scm.h"
  68
  69 /* Include headers for those files central to the implementation.  The
  70    rest should be explicitly #included in the C files themselves.  */
  71 #include "libguile/error.h"     /* Everyone signals errors.  */
  72 #include "libguile/print.h"     /* Everyone needs to print.  */
  73 #include "libguile/pairs.h"     /* Everyone conses.  */
  74 #include "libguile/list.h"      /* Everyone makes lists.  */
  75 #include "libguile/gc.h"        /* Everyone allocates.  */
  76 #include "libguile/gsubr.h"     /* Everyone defines global functions.  */
  77 #include "libguile/procs.h"     /* Same.  */
  78 #include "libguile/numbers.h"   /* Everyone deals with fixnums.  */
  79 #include "libguile/symbols.h"   /* For length, chars, values, miscellany.  */
  80 #include "libguile/boolean.h"   /* Everyone wonders about the truth.  */
  81 #include "libguile/threads.h"   /* You are not alone. */
  82 #include "libguile/snarf.h"     /* Everyone snarfs. */
  83 #include "libguile/foreign.h"   /* Snarfing needs the foreign data structures. */
  84 #include "libguile/programs.h"  /* ... and program.h. */
  85 #include "libguile/variable.h"
  86 #include "libguile/modules.h"
  87 #include "libguile/inline.h"
  88 #include "libguile/strings.h"
  89
  90 /* ASYNC_TICK after finding EINTR in order to handle pending signals, if
  91    any. See comment in scm_syserror. */
  92 #ifndef SCM_SYSCALL
  93 #ifdef vms
  94 # ifndef __GNUC__
  95 #  include <ssdef.h>
  96 #   define SCM_SYSCALL(line)                                    \
  97   do                                                            \
  98     {                                                           \
  99       errno = 0;                                                \
 100       line;                                                     \
 101       if (EVMSERR==errno && (vaxc$errno>>3)==(SS$_CONTROLC>>3)) \
 102         {                                                       \
 103           SCM_ASYNC_TICK;                                       \
 104           continue;                                             \
 105         }                                                       \
 106     }                                                           \
 107   while(0)
 108 # endif /* ndef __GNUC__ */
 109 #endif /* def vms */
 110 #endif /* ndef SCM_SYSCALL  */
 111
 112 #ifndef SCM_SYSCALL
 113 # ifdef EINTR
 114 #  if (EINTR > 0)
 115 #   define SCM_SYSCALL(line)                    \
 116   do                                            \
 117     {                                           \
 118       errno = 0;                                \
 119       line;                                     \
 120       if (errno == EINTR)                       \
 121         {                                       \
 122           SCM_ASYNC_TICK;                       \
 123           continue;                             \
 124         }                                       \
 125     }                                           \
 126   while(0)
 127 #  endif /*  (EINTR > 0) */
 128 # endif /* def EINTR */
 129 #endif /* ndef SCM_SYSCALL */
 130
 131 #ifndef SCM_SYSCALL
 132 # define SCM_SYSCALL(line) line;
 133 #endif /* ndef SCM_SYSCALL */
 134
 135 \f
 136
 137 #ifndef min
 138 #define min(A, B) ((A) <= (B) ? (A) : (B))
 139 #endif
 140 #ifndef max
 141 #define max(A, B) ((A) >= (B) ? (A) : (B))
 142 #endif
 143
 144 /* Return the first integer greater than or equal to LEN such that
 145    LEN % ALIGN == 0.  Return LEN if ALIGN is zero.  */
 146 #define ROUND_UP(len, align)                                    \
 147   ((align) ? (((len) - 1UL) | ((align) - 1UL)) + 1UL : (len))
 148
 149
 150 #if defined GUILE_USE_64_CALLS && GUILE_USE_64_CALLS && defined(HAVE_STAT64)
 151 #define CHOOSE_LARGEFILE(foo,foo64)     foo64
 152 #else
 153 #define CHOOSE_LARGEFILE(foo,foo64)     foo
 154 #endif
 155
 156 /* These names are a bit long, but they make it clear what they represent. */
 157 #if SCM_HAVE_STRUCT_DIRENT64 == 1
 158 # define dirent_or_dirent64             CHOOSE_LARGEFILE(dirent,dirent64)
 159 #else
 160 # define dirent_or_dirent64             dirent
 161 #endif
 162 #define fstat_or_fstat64                CHOOSE_LARGEFILE(fstat,fstat64)
 163 #define ftruncate_or_ftruncate64        CHOOSE_LARGEFILE(ftruncate,ftruncate64)
 164 #define lseek_or_lseek64                CHOOSE_LARGEFILE(lseek,lseek64)
 165 #define lstat_or_lstat64                CHOOSE_LARGEFILE(lstat,lstat64)
 166 #define off_t_or_off64_t                CHOOSE_LARGEFILE(off_t,off64_t)
 167 #define open_or_open64                  CHOOSE_LARGEFILE(open,open64)
 168 #define readdir_or_readdir64            CHOOSE_LARGEFILE(readdir,readdir64)
 169 #if SCM_HAVE_READDIR64_R == 1
 170 # define readdir_r_or_readdir64_r       CHOOSE_LARGEFILE(readdir_r,readdir64_r)
 171 #else
 172 # define readdir_r_or_readdir64_r       readdir_r
 173 #endif
 174 #define stat_or_stat64                  CHOOSE_LARGEFILE(stat,stat64)
 175 #define truncate_or_truncate64          CHOOSE_LARGEFILE(truncate,truncate64)
 176 #define scm_from_off_t_or_off64_t       CHOOSE_LARGEFILE(scm_from_off_t,scm_from_int64)
 177 #define scm_from_ino_t_or_ino64_t       CHOOSE_LARGEFILE(scm_from_ulong,scm_from_uint64)
 178 #define scm_from_blkcnt_t_or_blkcnt64_t CHOOSE_LARGEFILE(scm_from_ulong,scm_from_uint64)
 179 #define scm_to_off_t_or_off64_t         CHOOSE_LARGEFILE(scm_to_off_t,scm_to_int64)
 180
 181 #if SIZEOF_OFF_T == 4
 182 #  define scm_to_off_t    scm_to_int32
 183 #  define scm_from_off_t  scm_from_int32
 184 #elif SIZEOF_OFF_T == 8
 185 #  define scm_to_off_t    scm_to_int64
 186 #  define scm_from_off_t  scm_from_int64
 187 #else
 188 #  error sizeof(off_t) is not 4 or 8.
 189 #endif
 190 #define scm_to_off64_t    scm_to_int64
 191 #define scm_from_off64_t  scm_from_int64
 192
 193
 194 \f
 195
 196 #if defined (vms)
 197 /* VMS: Implement SCM_I_SETJMP in terms of setjump.  */
 198 extern int setjump(scm_i_jmp_buf env);
 199 extern int longjump(scm_i_jmp_buf env, int ret);
 200 #define SCM_I_SETJMP setjump
 201 #define SCM_I_LONGJMP longjump
 202
 203 #elif defined (_CRAY1)
 204 /* Cray: Implement SCM_I_SETJMP in terms of setjump.  */
 205 extern int setjump(scm_i_jmp_buf env);
 206 extern int longjump(scm_i_jmp_buf env, int ret);
 207 #define SCM_I_SETJMP setjump
 208 #define SCM_I_LONGJMP longjump
 209
 210 #elif defined (__ia64__)
 211 /* IA64: Implement SCM_I_SETJMP in terms of getcontext. */
 212 # define SCM_I_SETJMP(JB)                               \
 213   ( (JB).fresh = 1,                                     \
 214     getcontext (&((JB).ctx)),                           \
 215     ((JB).fresh ? ((JB).fresh = 0, 0) : 1) )
 216 # define SCM_I_LONGJMP(JB,VAL) scm_ia64_longjmp (&(JB), VAL)
 217 void scm_ia64_longjmp (scm_i_jmp_buf *, int);
 218
 219 #else
 220 /* All other systems just use setjmp and longjmp.  */
 221
 222 #define SCM_I_SETJMP setjmp
 223 #define SCM_I_LONGJMP longjmp
 224 #endif
 225
 226 \f
 227
 228 #define SCM_ASYNC_TICK                                                  \
 229   do                                                                    \
 230     {                                                                   \
 231       if (SCM_UNLIKELY (SCM_I_CURRENT_THREAD->pending_asyncs))          \
 232         scm_async_tick ();                                              \
 233     }                                                                   \
 234   while (0)
 235
 236 #define SCM_ASYNC_TICK_WITH_CODE(thr, stmt)                             \
 237   do                                                                    \
 238     {                                                                   \
 239       if (SCM_UNLIKELY (thr->pending_asyncs))                           \
 240         {                                                               \
 241           stmt;                                                         \
 242           scm_async_tick ();                                            \
 243         }                                                               \
 244     }                                                                   \
 245   while (0)
 246
 247
 248 \f
 249
 250 /* The endianness marker in objcode.  */
 251 #ifdef WORDS_BIGENDIAN
 252 # define SCM_OBJCODE_ENDIANNESS "BE"
 253 #else
 254 # define SCM_OBJCODE_ENDIANNESS "LE"
 255 #endif
 256
 257 #define _SCM_CPP_STRINGIFY(x)  # x
 258 #define SCM_CPP_STRINGIFY(x)   _SCM_CPP_STRINGIFY (x)
 259
 260 /* The word size marker in objcode.  */
 261 #define SCM_OBJCODE_WORD_SIZE  SCM_CPP_STRINGIFY (SIZEOF_VOID_P)
 262
 263 /* Major and minor versions must be single characters. */
 264 #define SCM_OBJCODE_MAJOR_VERSION 3
 265 #define SCM_OBJCODE_MINOR_VERSION 0
 266 #define SCM_OBJCODE_MAJOR_VERSION_STRING        \
 267   SCM_CPP_STRINGIFY(SCM_OBJCODE_MAJOR_VERSION)
 268 #define SCM_OBJCODE_MINOR_VERSION_STRING        \
 269   SCM_CPP_STRINGIFY(SCM_OBJCODE_MINOR_VERSION)
 270 #define SCM_OBJCODE_VERSION_STRING                                      \
 271   SCM_OBJCODE_MAJOR_VERSION_STRING "." SCM_OBJCODE_MINOR_VERSION_STRING
 272 #define SCM_OBJCODE_MACHINE_VERSION_STRING                              \
 273   SCM_OBJCODE_ENDIANNESS "-" SCM_OBJCODE_WORD_SIZE "-" SCM_OBJCODE_VERSION_STRING
 274
 275 /* The objcode magic header.  */
 276 #define SCM_OBJCODE_COOKIE                              \
 277   "GOOF----" SCM_OBJCODE_MACHINE_VERSION_STRING
 278 #define SCM_OBJCODE_ENDIANNESS_OFFSET 8
 279 #define SCM_OBJCODE_WORD_SIZE_OFFSET 11
 280
 281
 282 #endif  /* SCM__SCM_H */
 283
 284 /*
 285   Local Variables:
 286   c-file-style: "gnu"
 287   End:
 288 */