Split off directory, random and old-time packages
[ghc-base.git] / include / HsBase.h
index 9281db0..8c9fa21 100644 (file)
@@ -9,8 +9,6 @@
 #ifndef __HSBASE_H__
 #define __HSBASE_H__
 
-#include "ghcconfig.h"
-
 #include "HsBaseConfig.h"
 
 /* ultra-evil... */
 #undef PACKAGE_TARNAME
 #undef PACKAGE_VERSION
 
+/* Needed to get the macro version of errno on some OSs (eg. Solaris).
+   We must do this, because these libs are only compiled once, but
+   must work in both single-threaded and multi-threaded programs. */
+#define _REENTRANT 1
+
 #include "HsFFI.h"
 
 #include <stdio.h>
@@ -86,7 +89,7 @@
 #if HAVE_SYS_TIMES_H
 #include <sys/times.h>
 #endif
-#if HAVE_WINSOCK_H && defined(mingw32_HOST_OS)
+#if HAVE_WINSOCK_H && defined(__MINGW32__)
 #include <winsock.h>
 #endif
 #if HAVE_LIMITS_H
 #if HAVE_WCTYPE_H
 #include <wctype.h>
 #endif
+#if HAVE_INTTYPES_H
+# include <inttypes.h>
+#elif HAVE_STDINT_H
+# include <stdint.h>
+#endif
 
-#if !defined(mingw32_HOST_OS) && !defined(irix_HOST_OS)
+#if !defined(__MINGW32__) && !defined(irix_HOST_OS)
 # if HAVE_SYS_RESOURCE_H
 #  include <sys/resource.h>
 # endif
 #endif
 
-#ifdef hpux_HOST_OS
-#include <sys/syscall.h>
-#define getrusage(a, b)  syscall(SYS_GETRUSAGE, a, b)
-#define HAVE_GETRUSAGE
+#if !HAVE_GETRUSAGE && HAVE_SYS_SYSCALL_H
+# include <sys/syscall.h>
+# if defined(SYS_GETRUSAGE)    /* hpux_HOST_OS */
+#  define getrusage(a, b)  syscall(SYS_GETRUSAGE, a, b)
+#  define HAVE_GETRUSAGE 1
+# endif
 #endif
 
 /* For System */
 
 #include "runProcess.h"
 
-#if defined(mingw32_HOST_OS)
+#if defined(__MINGW32__)
+/* in Win32Utils.c */
+extern void maperrno (void);
+extern HsWord64 getUSecOfDay(void);
+#endif
+
+#if defined(__MINGW32__)
 #include <io.h>
 #include <fcntl.h>
-#include "timeUtils.h"
 #include <shlobj.h>
 #include <share.h>
 #endif
@@ -139,7 +154,7 @@ int inputReady(int fd, int msecs, int isSock);
 /* in Signals.c */
 extern HsInt nocldstop;
 
-#if !defined(mingw32_HOST_OS)
+#if !defined(_MSC_VER) && !defined(__MINGW32__) && !defined(_WIN32)
 /* in execvpe.c */
 extern int execvpe(char *name, char *const argv[], char **envp);
 extern void pPrPr_disableITimers (void);
@@ -151,51 +166,50 @@ extern void pPrPr_disableITimers (void);
 
 #ifdef SUPPORT_LONG_LONGS
 
-StgInt stg_gtWord64 (StgWord64, StgWord64);
-StgInt stg_geWord64 (StgWord64, StgWord64);
-StgInt stg_eqWord64 (StgWord64, StgWord64);
-StgInt stg_neWord64 (StgWord64, StgWord64);
-StgInt stg_ltWord64 (StgWord64, StgWord64);
-StgInt stg_leWord64 (StgWord64, StgWord64);
-
-StgInt stg_gtInt64 (StgInt64, StgInt64);
-StgInt stg_geInt64 (StgInt64, StgInt64);
-StgInt stg_eqInt64 (StgInt64, StgInt64);
-StgInt stg_neInt64 (StgInt64, StgInt64);
-StgInt stg_ltInt64 (StgInt64, StgInt64);
-StgInt stg_leInt64 (StgInt64, StgInt64);
-
-StgWord64 stg_remWord64  (StgWord64, StgWord64);
-StgWord64 stg_quotWord64 (StgWord64, StgWord64);
-
-StgInt64 stg_remInt64    (StgInt64, StgInt64);
-StgInt64 stg_quotInt64   (StgInt64, StgInt64);
-StgInt64 stg_negateInt64 (StgInt64);
-StgInt64 stg_plusInt64   (StgInt64, StgInt64);
-StgInt64 stg_minusInt64  (StgInt64, StgInt64);
-StgInt64 stg_timesInt64  (StgInt64, StgInt64);
-
-StgWord64 stg_and64  (StgWord64, StgWord64);
-StgWord64 stg_or64   (StgWord64, StgWord64);
-StgWord64 stg_xor64  (StgWord64, StgWord64);
-StgWord64 stg_not64  (StgWord64);
-
-StgWord64 stg_uncheckedShiftL64   (StgWord64, StgInt);
-StgWord64 stg_uncheckedShiftRL64  (StgWord64, StgInt);
-StgInt64  stg_uncheckedIShiftL64  (StgInt64, StgInt);
-StgInt64  stg_uncheckedIShiftRL64 (StgInt64, StgInt);
-StgInt64  stg_uncheckedIShiftRA64 (StgInt64, StgInt);
-
-StgInt64  stg_intToInt64    (StgInt);
-StgInt    stg_int64ToInt    (StgInt64);
-StgWord64 stg_int64ToWord64 (StgInt64);
-
-StgWord64 stg_wordToWord64  (StgWord);
-StgWord   stg_word64ToWord  (StgWord64);
-StgInt64  stg_word64ToInt64 (StgWord64);
-
-StgInt64  stg_integerToInt64 (StgInt sa, StgByteArray /* Really: mp_limb_t* */ da);
-StgWord64 stg_integerToWord64 (StgInt sa, StgByteArray /* Really: mp_limb_t* */ da);
+HsBool hs_gtWord64 (HsWord64, HsWord64);
+HsBool hs_geWord64 (HsWord64, HsWord64);
+HsBool hs_eqWord64 (HsWord64, HsWord64);
+HsBool hs_neWord64 (HsWord64, HsWord64);
+HsBool hs_ltWord64 (HsWord64, HsWord64);
+HsBool hs_leWord64 (HsWord64, HsWord64);
+
+HsBool hs_gtInt64 (HsInt64, HsInt64);
+HsBool hs_geInt64 (HsInt64, HsInt64);
+HsBool hs_eqInt64 (HsInt64, HsInt64);
+HsBool hs_neInt64 (HsInt64, HsInt64);
+HsBool hs_ltInt64 (HsInt64, HsInt64);
+HsBool hs_leInt64 (HsInt64, HsInt64);
+
+HsWord64 hs_remWord64  (HsWord64, HsWord64);
+HsWord64 hs_quotWord64 (HsWord64, HsWord64);
+
+HsInt64 hs_remInt64    (HsInt64, HsInt64);
+HsInt64 hs_quotInt64   (HsInt64, HsInt64);
+HsInt64 hs_negateInt64 (HsInt64);
+HsInt64 hs_plusInt64   (HsInt64, HsInt64);
+HsInt64 hs_minusInt64  (HsInt64, HsInt64);
+HsInt64 hs_timesInt64  (HsInt64, HsInt64);
+
+HsWord64 hs_and64  (HsWord64, HsWord64);
+HsWord64 hs_or64   (HsWord64, HsWord64);
+HsWord64 hs_xor64  (HsWord64, HsWord64);
+HsWord64 hs_not64  (HsWord64);
+
+HsWord64 hs_uncheckedShiftL64   (HsWord64, HsInt);
+HsWord64 hs_uncheckedShiftRL64  (HsWord64, HsInt);
+HsInt64  hs_uncheckedIShiftL64  (HsInt64, HsInt);
+HsInt64  hs_uncheckedIShiftRA64 (HsInt64, HsInt);
+HsInt64  hs_uncheckedIShiftRL64 (HsInt64, HsInt);
+
+HsInt64  hs_intToInt64    (HsInt);
+HsInt    hs_int64ToInt    (HsInt64);
+HsWord64 hs_int64ToWord64 (HsInt64);
+HsWord64 hs_wordToWord64  (HsWord);
+HsWord   hs_word64ToWord  (HsWord64);
+HsInt64  hs_word64ToInt64 (HsWord64);
+
+HsWord64 hs_integerToWord64 (HsInt sa, StgByteArray /* Really: mp_limb_t* */ da);
+HsInt64  hs_integerToInt64 (HsInt sa, StgByteArray /* Really: mp_limb_t* */ da);
 
 #endif /* SUPPORT_LONG_LONGS */
 
@@ -210,10 +224,8 @@ StgWord64 stg_integerToWord64 (StgInt sa, StgByteArray /* Really: mp_limb_t* */
 #ifndef INLINE
 # if defined(_MSC_VER)
 #  define INLINE extern __inline
-# elif defined(__HUGS__)
-#  define INLINE INLINE_ONLY
 # else
-#  define INLINE extern inline
+#  define INLINE static inline
 # endif
 #endif
 
@@ -221,17 +233,17 @@ INLINE int __hscore_get_errno(void) { return errno; }
 INLINE void __hscore_set_errno(int e) { errno = e; }
 
 #if !defined(_MSC_VER)
-INLINE int __hscore_s_isreg(m)  { return S_ISREG(m);  }
-INLINE int __hscore_s_isdir(m)  { return S_ISDIR(m);  }
-INLINE int __hscore_s_isfifo(m) { return S_ISFIFO(m); }
-INLINE int __hscore_s_isblk(m)  { return S_ISBLK(m);  }
-INLINE int __hscore_s_ischr(m)  { return S_ISCHR(m);  }
+INLINE int __hscore_s_isreg(mode_t m)  { return S_ISREG(m);  }
+INLINE int __hscore_s_isdir(mode_t m)  { return S_ISDIR(m);  }
+INLINE int __hscore_s_isfifo(mode_t m) { return S_ISFIFO(m); }
+INLINE int __hscore_s_isblk(mode_t m)  { return S_ISBLK(m);  }
+INLINE int __hscore_s_ischr(mode_t m)  { return S_ISCHR(m);  }
 #ifdef S_ISSOCK
-INLINE int __hscore_s_issock(m) { return S_ISSOCK(m); }
+INLINE int __hscore_s_issock(mode_t m) { return S_ISSOCK(m); }
 #endif
 #endif
 
-#if !defined(mingw32_HOST_OS) && !defined(_MSC_VER)
+#if !defined(_MSC_VER) && !defined(__MINGW32__) && !defined(_WIN32)
 INLINE int
 __hscore_sigemptyset( sigset_t *set )
 { return sigemptyset(set); }
@@ -264,7 +276,7 @@ __hscore_memcpy_src_off( char *dst, char *src, int src_off, size_t sz )
 INLINE HsBool
 __hscore_supportsTextMode()
 {
-#if defined(mingw32_HOST_OS)
+#if defined(_MSC_VER) || defined(__MINGW32__) || defined(_WIN32)
   return HS_BOOL_FALSE;
 #else
   return HS_BOOL_TRUE;
@@ -277,13 +289,13 @@ __hscore_bufsiz()
   return BUFSIZ;
 }
 
-INLINE HsInt
+INLINE int
 __hscore_seek_cur()
 {
   return SEEK_CUR;
 }
 
-INLINE HsInt
+INLINE int
 __hscore_o_binary()
 {
 #if defined(_MSC_VER)
@@ -383,13 +395,13 @@ __hscore_o_nonblock( void )
 #endif
 }
 
-INLINE HsInt
+INLINE int
 __hscore_seek_set( void )
 {
   return SEEK_SET;
 }
 
-INLINE HsInt
+INLINE int
 __hscore_seek_end( void )
 {
   return SEEK_END;
@@ -407,115 +419,81 @@ __hscore_ftruncate( int fd, off_t where )
 #endif
 }
 
-INLINE HsInt
-__hscore_setmode( HsInt fd, HsBool toBin )
+INLINE int
+__hscore_setmode( int fd, HsBool toBin )
 {
-#if defined(mingw32_HOST_OS) || defined(_MSC_VER)
+#if defined(_MSC_VER) || defined(__MINGW32__) || defined(_WIN32)
   return setmode(fd,(toBin == HS_BOOL_TRUE) ? _O_BINARY : _O_TEXT);
 #else
   return 0;
 #endif
 }
 
-INLINE HsInt
-__hscore_PrelHandle_write( HsInt fd, HsAddr ptr, HsInt off, int sz )
+#if __GLASGOW_HASKELL__
+
+INLINE int
+__hscore_PrelHandle_write( int fd, void *ptr, HsInt off, int sz )
 {
   return write(fd,(char *)ptr + off, sz);
 }
 
-INLINE HsInt
-__hscore_PrelHandle_read( HsInt fd, HsAddr ptr, HsInt off, int sz )
+INLINE int
+__hscore_PrelHandle_read( int fd, void *ptr, HsInt off, int sz )
 {
   return read(fd,(char *)ptr + off, sz);
 
 }
 
-#if defined(mingw32_HOST_OS) || defined(_MSC_VER)
-INLINE HsInt
-__hscore_PrelHandle_send( HsInt fd, HsAddr ptr, HsInt off, int sz )
+#if defined(_MSC_VER) || defined(__MINGW32__) || defined(_WIN32)
+INLINE int
+__hscore_PrelHandle_send( int fd, void *ptr, HsInt off, int sz )
 {
     return send(fd,(char *)ptr + off, sz, 0);
 }
 
-INLINE HsInt
-__hscore_PrelHandle_recv( HsInt fd, HsAddr ptr, HsInt off, int sz )
+INLINE int
+__hscore_PrelHandle_recv( int fd, void *ptr, HsInt off, int sz )
 {
     return recv(fd,(char *)ptr + off, sz, 0);
 }
 #endif
 
-#if defined(mingw32_HOST_OS) || defined(_MSC_VER)
-INLINE long *
-__hscore_Time_ghcTimezone( void ) { return &_timezone; }
-
-INLINE char **
-__hscore_Time_ghcTzname( void ) { return _tzname; }
-#endif
+#endif /* __GLASGOW_HASKELL__ */
 
-INLINE HsInt
-__hscore_mkdir( HsAddr pathName, HsInt mode )
+INLINE int
+__hscore_mkdir( char *pathName, int mode )
 {
-#if defined(mingw32_HOST_OS) || defined(_MSC_VER)
+#if defined(_MSC_VER) || defined(__MINGW32__) || defined(_WIN32)
   return mkdir(pathName);
 #else
   return mkdir(pathName,mode);
 #endif
 }
 
-INLINE HsInt
-__hscore_lstat( HsAddr fname, HsAddr st )
+INLINE int
+__hscore_lstat( const char *fname, struct stat *st )
 {
 #if HAVE_LSTAT
-  return lstat((const char*)fname, (struct stat*)st);
+  return lstat(fname, st);
 #else
-  return stat((const char*)fname, (struct stat*)st);
+  return stat(fname, st);
 #endif
 }
 
-#ifdef PATH_MAX
-/* A size that will contain many path names, but not necessarily all
- * (PATH_MAX is not defined on systems with unlimited path length,
- * e.g. the Hurd).
- */
-INLINE HsInt __hscore_long_path_size() { return PATH_MAX; }
-#else
-INLINE HsInt __hscore_long_path_size() { return 4096; }
-#endif
-
-#ifdef R_OK
-INLINE mode_t __hscore_R_OK() { return R_OK; }
-#endif
-#ifdef W_OK
-INLINE mode_t __hscore_W_OK() { return W_OK; }
-#endif
-#ifdef X_OK
-INLINE mode_t __hscore_X_OK() { return X_OK; }
-#endif
-
-#ifdef S_IRUSR
-INLINE mode_t __hscore_S_IRUSR() { return S_IRUSR; }
-#endif
-#ifdef S_IWUSR
-INLINE mode_t __hscore_S_IWUSR() { return S_IWUSR; }
-#endif
-#ifdef S_IXUSR
-INLINE mode_t __hscore_S_IXUSR() { return S_IXUSR; }
-#endif
-
-INLINE HsAddr
+INLINE char *
 __hscore_d_name( struct dirent* d )
 {
-  return (HsAddr)(d->d_name);
+  return (d->d_name);
 }
 
-INLINE HsInt
+INLINE int
 __hscore_end_of_dir( void )
 {
   return READDIR_ERRNO_EOF;
 }
 
 INLINE void
-__hscore_free_dirent(HsAddr dEnt)
+__hscore_free_dirent(struct dirent *dEnt)
 {
 #if HAVE_READDIR_R
   free(dEnt);
@@ -547,7 +525,7 @@ __hscore_ptr_c_cc( struct termios* ts )
 INLINE HsInt
 __hscore_sizeof_termios( void )
 {
-#ifndef mingw32_HOST_OS
+#ifndef __MINGW32__
   return sizeof(struct termios);
 #else
   return 0;
@@ -555,7 +533,7 @@ __hscore_sizeof_termios( void )
 }
 #endif
 
-#if !defined(mingw32_HOST_OS) && !defined(_MSC_VER)
+#if !defined(_MSC_VER) && !defined(__MINGW32__) && !defined(_WIN32)
 INLINE HsInt
 __hscore_sizeof_sigset_t( void )
 {
@@ -667,7 +645,7 @@ extern void __hscore_set_saved_termios(int fd, void* ts);
 INLINE int __hscore_hs_fileno (FILE *f) { return fileno (f); }
 
 INLINE int __hscore_open(char *file, int how, mode_t mode) {
-#ifdef mingw32_HOST_OS
+#ifdef __MINGW32__
        if ((how & O_WRONLY) || (how & O_RDWR) || (how & O_APPEND))
          return _sopen(file,how,_SH_DENYRW,mode);
        else
@@ -695,63 +673,39 @@ INLINE int __hscore_fstat(int fd, struct stat *buf) {
 
 // select-related stuff
 
-#if !defined(mingw32_HOST_OS)
+#if !defined(__MINGW32__)
+INLINE int  hsFD_SETSIZE(void) { return FD_SETSIZE; }
 INLINE void hsFD_CLR(int fd, fd_set *fds) { FD_CLR(fd, fds); }
 INLINE int  hsFD_ISSET(int fd, fd_set *fds) { return FD_ISSET(fd, fds); }
 INLINE void hsFD_SET(int fd, fd_set *fds) { FD_SET(fd, fds); }
-INLINE int  sizeof_fd_set(void) { return sizeof(fd_set); }
+INLINE HsInt sizeof_fd_set(void) { return sizeof(fd_set); }
 extern void hsFD_ZERO(fd_set *fds);
 #endif
 
 // gettimeofday()-related
 
-#if !defined(mingw32_HOST_OS)
-#define TICK_FREQ  50
+#if !defined(__MINGW32__)
 
 INLINE HsInt sizeofTimeVal(void) { return sizeof(struct timeval); }
 
-INLINE HsInt getTicksOfDay(void)
+INLINE HsWord64 getUSecOfDay(void)
 {
     struct timeval tv;
     gettimeofday(&tv, (struct timezone *) NULL);
-    return (tv.tv_sec * TICK_FREQ +
-           tv.tv_usec * TICK_FREQ / 1000000);
+    // Don't forget to cast *before* doing the arithmetic, otherwise
+    // the arithmetic happens at the type of tv_sec, which is probably
+    // only 'int'.
+    return ((HsWord64)tv.tv_sec * 1000000 + (HsWord64)tv.tv_usec);
 }
 
-INLINE void setTimevalTicks(struct timeval *p, HsInt ticks)
+INLINE void setTimevalTicks(struct timeval *p, HsWord64 usecs)
 {
-    p->tv_sec  = ticks / TICK_FREQ;
-    p->tv_usec = (ticks % TICK_FREQ) * (1000000 / TICK_FREQ);
+    p->tv_sec  = usecs / 1000000;
+    p->tv_usec = usecs % 1000000;
 }
-#endif /* !defined(mingw32_HOST_OS) */
-
-// Directory-related
+#endif /* !defined(__MINGW32__) */
 
-#if defined(mingw32_HOST_OS)
-
-/* Make sure we've got the reqd CSIDL_ constants in scope;
- * w32api header files are lagging a bit in defining the full set.
- */
-#if !defined(CSIDL_APPDATA)
-#define CSIDL_APPDATA 0x001a
-#endif
-#if !defined(CSIDL_PERSONAL)
-#define CSIDL_PERSONAL 0x0005
-#endif
-#if !defined(CSIDL_PROFILE)
-#define CSIDL_PROFILE 0x0028
-#endif
-#if !defined(CSIDL_WINDOWS)
-#define CSIDL_WINDOWS 0x0024
-#endif
-
-INLINE int __hscore_CSIDL_PROFILE()  { return CSIDL_PROFILE;  }
-INLINE int __hscore_CSIDL_APPDATA()  { return CSIDL_APPDATA;  }
-INLINE int __hscore_CSIDL_WINDOWS()  { return CSIDL_WINDOWS;  }
-INLINE int __hscore_CSIDL_PERSONAL() { return CSIDL_PERSONAL; }
-#endif
-
-#if defined(mingw32_HOST_OS)
+#if defined(__MINGW32__)
 INLINE unsigned int __hscore_get_osver(void) { return _osver; }
 #endif
 
@@ -760,5 +714,11 @@ INLINE unsigned int __hscore_get_osver(void) { return _osver; }
 extern char** environ;
 INLINE char **__hscore_environ() { return environ; }
 
+/* lossless conversions between pointers and integral types */
+INLINE void *    __hscore_from_uintptr(uintptr_t n) { return (void *)n; }
+INLINE void *    __hscore_from_intptr (intptr_t n)  { return (void *)n; }
+INLINE uintptr_t __hscore_to_uintptr  (void *p)     { return (uintptr_t)p; }
+INLINE intptr_t  __hscore_to_intptr   (void *p)     { return (intptr_t)p; }
+
 #endif /* __HSBASE_H__ */