[project @ 2005-01-28 23:33:57 by krasimir]
[ghc-base.git] / include / HsBase.h
index 1070aac..0ea5027 100644 (file)
 /* -----------------------------------------------------------------------------
- * $Id: HsBase.h,v 1.8 2002/07/04 12:57:39 simonmar Exp $
  *
- * (c) The University of Glasgow 2001-2002
+ * (c) The University of Glasgow 2001-2004
  *
- * Definitions for package `core' which are visible in Haskell land.
+ * Definitions for package `base' which are visible in Haskell land.
  *
  * ---------------------------------------------------------------------------*/
 
-#ifndef HSCORE_H
-#define HSCORE_H
+#ifndef __HSBASE_H__
+#define __HSBASE_H__
 
-#include "config.h"
-#include "HsFFI.h"
+#include "ghcconfig.h"
 
-// The following is required on Solaris to force the POSIX versions of
-// the various _r functions instead of the Solaris versions.
-#ifdef solaris_TARGET_OS
-#define _POSIX_PTHREAD_SEMANTICS
-#endif
+#include "HsBaseConfig.h"
+
+/* ultra-evil... */
+#undef PACKAGE_BUGREPORT
+#undef PACKAGE_NAME
+#undef PACKAGE_STRING
+#undef PACKAGE_TARNAME
+#undef PACKAGE_VERSION
+
+#include "HsFFI.h"
 
 #include <stdio.h>
 #include <stdlib.h>
+#include <math.h>
 
-#ifdef HAVE_SYS_TYPES_H
+#if HAVE_SYS_TYPES_H
 #include <sys/types.h>
 #endif
-#ifdef HAVE_UNISTD_H
+#if HAVE_UNISTD_H
 #include <unistd.h>
 #endif
-#ifdef HAVE_SYS_STAT_H
+#if HAVE_SYS_STAT_H
 #include <sys/stat.h>
 #endif
-#ifdef HAVE_FCNTL_H
+#if HAVE_FCNTL_H
 # include <fcntl.h>
 #endif
-#ifdef HAVE_TERMIOS_H
+#if HAVE_TERMIOS_H
 #include <termios.h>
 #endif
-#ifdef HAVE_SIGNAL_H
+#if HAVE_SIGNAL_H
 #include <signal.h>
+/* Ultra-ugly: OpenBSD uses broken macros for sigemptyset and sigfillset (missing casts) */
+#if __OpenBSD__
+#undef sigemptyset
+#undef sigfillset
+#endif
 #endif
-#ifdef HAVE_ERRNO_H
+#if HAVE_ERRNO_H
 #include <errno.h>
 #endif
-#ifdef HAVE_STRING_H
+#if HAVE_STRING_H
 #include <string.h>
 #endif
-#ifdef HAVE_DIRENT_H
+#if HAVE_DIRENT_H
 #include <dirent.h>
 #endif
-#ifdef HAVE_UTIME_H
+#if HAVE_UTIME_H
 #include <utime.h>
 #endif
-#if defined(HAVE_GETTIMEOFDAY)
-#  ifdef HAVE_SYS_TIME_H
+#if HAVE_SYS_UTSNAME_H
+#include <sys/utsname.h>
+#endif
+#if HAVE_GETTIMEOFDAY
+#  if HAVE_SYS_TIME_H
 #   include <sys/time.h>
 #  endif
-#elif defined(HAVE_GETCLOCK)
-# ifdef HAVE_SYS_TIMERS_H
+#elif HAVE_GETCLOCK
+# if HAVE_SYS_TIMERS_H
 #  define POSIX_4D9 1
 #  include <sys/timers.h>
 # endif
 #endif
-#if defined(HAVE_TIME_H)
-# include <time.h>
+#if HAVE_TIME_H
+#include <time.h>
 #endif
-#ifdef HAVE_SYS_TIMEB_H
+#if HAVE_SYS_TIMEB_H
 #include <sys/timeb.h>
 #endif
-#ifdef HAVE_WINDOWS_H
+#if HAVE_WINDOWS_H
 #include <windows.h>
 #endif
-#ifdef HAVE_SYS_TIMES_H
+#if HAVE_SYS_TIMES_H
 #include <sys/times.h>
 #endif
-#if defined(HAVE_WINSOCK_H) && defined(__MINGW32__)
+#if HAVE_WINSOCK_H && defined(mingw32_HOST_OS)
 #include <winsock.h>
 #endif
-#ifdef HAVE_LIMITS_H
+#if HAVE_LIMITS_H
 #include <limits.h>
 #endif
+#if HAVE_WCTYPE_H
+#include <wctype.h>
+#endif
 
-#if !defined(mingw32_TARGET_OS) && !defined(irix_TARGET_OS)
-# if defined(HAVE_SYS_RESOURCE_H)
+#if !defined(mingw32_HOST_OS) && !defined(irix_HOST_OS)
+# if HAVE_SYS_RESOURCE_H
 #  include <sys/resource.h>
 # endif
 #endif
 
-#ifdef hpux_TARGET_OS
+#ifdef hpux_HOST_OS
 #include <sys/syscall.h>
 #define getrusage(a, b)  syscall(SYS_GETRUSAGE, a, b)
 #define HAVE_GETRUSAGE
 #endif
 
 /* For System */
-#ifdef HAVE_SYS_WAIT_H
+#if HAVE_SYS_WAIT_H
 #include <sys/wait.h>
 #endif
-#ifdef HAVE_VFORK_H
+#if HAVE_VFORK_H
 #include <vfork.h>
 #endif
 #include "lockFile.h"
 #include "dirUtils.h"
-#include "errUtils.h"
 
-#if defined(__MINGW32__)
+#include "runProcess.h"
+
+#if defined(mingw32_HOST_OS)
 #include <io.h>
 #include <fcntl.h>
 #include "timeUtils.h"
+#include <shlobj.h>
+#include <share.h>
 #endif
 
-/* in ghc_errno.c */
-int *ghcErrno(void);
-
-/* in system.c */
-HsInt systemCmd(HsAddr cmd);
+#if HAVE_SYS_SELECT_H
+#include <sys/select.h>
+#endif
 
 /* in inputReady.c */
 int inputReady(int fd, int msecs, int isSock);
 
+/* in Signals.c */
+extern HsInt nocldstop;
+
+#if !defined(mingw32_HOST_OS)
+/* in execvpe.c */
+extern int execvpe(char *name, char *const argv[], char **envp);
+extern void pPrPr_disableITimers (void);
+#endif
+
 /* -----------------------------------------------------------------------------
    64-bit operations, defined in longlong.c
    -------------------------------------------------------------------------- */
@@ -182,15 +207,19 @@ StgWord64 stg_integerToWord64 (StgInt sa, StgByteArray /* Really: mp_limb_t* */
    -------------------------------------------------------------------------- */
 
 #ifndef INLINE
-#define INLINE extern inline
+# if defined(_MSC_VER)
+#  define INLINE extern __inline
+# elif defined(__HUGS__)
+#  define INLINE INLINE_ONLY
+# else
+#  define INLINE extern inline
+# endif
 #endif
 
-#if !defined(mingw32_TARGET_OS)
-INLINE int
-__hscore_sigaddset( sigset_t * set, int s )
-{ return sigaddset(set,s); }
-#endif
+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); }
@@ -199,11 +228,28 @@ INLINE int __hscore_s_ischr(m)  { return S_ISCHR(m);  }
 #ifdef S_ISSOCK
 INLINE int __hscore_s_issock(m) { return S_ISSOCK(m); }
 #endif
+#endif
 
-#ifndef mingw32_TARGET_OS
-INLINE void
+#if !defined(mingw32_HOST_OS) && !defined(_MSC_VER)
+INLINE int
 __hscore_sigemptyset( sigset_t *set )
-{ sigemptyset(set); }
+{ return sigemptyset(set); }
+
+INLINE int
+__hscore_sigfillset( sigset_t *set )
+{ return sigfillset(set); }
+
+INLINE int
+__hscore_sigaddset( sigset_t * set, int s )
+{ return sigaddset(set,s); }
+
+INLINE int
+__hscore_sigdelset( sigset_t * set, int s )
+{ return sigdelset(set,s); }
+
+INLINE int
+__hscore_sigismember( sigset_t * set, int s )
+{ return sigismember(set,s); }
 #endif
 
 INLINE void *
@@ -217,7 +263,7 @@ __hscore_memcpy_src_off( char *dst, char *src, int src_off, size_t sz )
 INLINE HsBool
 __hscore_supportsTextMode()
 {
-#if defined(mingw32_TARGET_OS)
+#if defined(mingw32_HOST_OS)
   return HS_BOOL_FALSE;
 #else
   return HS_BOOL_TRUE;
@@ -239,10 +285,10 @@ __hscore_seek_cur()
 INLINE HsInt
 __hscore_o_binary()
 {
-#ifdef HAVE_O_BINARY
+#if defined(_MSC_VER)
   return O_BINARY;
 #else
-  return 0;
+  return CONST_O_BINARY;
 #endif
 }
 
@@ -348,42 +394,56 @@ __hscore_seek_end( void )
   return SEEK_END;
 }
 
+INLINE int
+__hscore_ftruncate( int fd, off_t where )
+{
+#if defined(HAVE_FTRUNCATE)
+  return ftruncate(fd,where);
+#elif defined(HAVE__CHSIZE)
+  return _chsize(fd,where);
+#else
+#error at least ftruncate or _chsize functions are required to build
+#endif
+}
+
 INLINE HsInt
 __hscore_setmode( HsInt fd, HsBool toBin )
 {
-#if defined(__MINGW32__)
+#if defined(mingw32_HOST_OS) || defined(_MSC_VER)
   return setmode(fd,(toBin == HS_BOOL_TRUE) ? _O_BINARY : _O_TEXT);
 #else
   return 0;
-#endif  
+#endif
 }
 
 INLINE HsInt
-__hscore_PrelHandle_write( HsInt fd, HsBool isSock, HsAddr ptr, 
-                          HsInt off, int sz )
+__hscore_PrelHandle_write( HsInt fd, HsAddr ptr, HsInt off, int sz )
 {
-#if defined(__MINGW32__)
-  if (isSock) {
-    return send(fd,ptr + off, sz, 0);
-  }
-#endif
-  return write(fd,ptr + off, sz);
+  return write(fd,(char *)ptr + off, sz);
 }
 
 INLINE HsInt
-__hscore_PrelHandle_read( HsInt fd, HsBool isSock, HsAddr ptr, 
-                         HsInt off, int sz )
+__hscore_PrelHandle_read( HsInt fd, HsAddr ptr, HsInt off, int sz )
 {
-#if defined(__MINGW32__)
-  if (isSock) {
-    return recv(fd,ptr + off, sz, 0);
-  }
-#endif
-  return read(fd,ptr + off, sz);
+  return read(fd,(char *)ptr + off, sz);
 
 }
 
-#if defined(__MINGW32__)
+#if defined(mingw32_HOST_OS) || defined(_MSC_VER)
+INLINE HsInt
+__hscore_PrelHandle_send( HsInt fd, HsAddr 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 )
+{
+    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; }
 
@@ -394,7 +454,7 @@ __hscore_Time_ghcTzname( void ) { return _tzname; }
 INLINE HsInt
 __hscore_mkdir( HsAddr pathName, HsInt mode )
 {
-#if defined(__MINGW32__)
+#if defined(mingw32_HOST_OS) || defined(_MSC_VER)
   return mkdir(pathName);
 #else
   return mkdir(pathName,mode);
@@ -404,41 +464,53 @@ __hscore_mkdir( HsAddr pathName, HsInt mode )
 INLINE HsInt
 __hscore_lstat( HsAddr fname, HsAddr st )
 {
-#ifdef HAVE_LSTAT
+#if HAVE_LSTAT
   return lstat((const char*)fname, (struct stat*)st);
 #else
   return stat((const char*)fname, (struct stat*)st);
 #endif
 }
 
-INLINE HsInt __hscore_path_max() { return PATH_MAX; }
+#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
 __hscore_d_name( struct dirent* d )
-{ 
-#ifndef mingw32_TARGET_OS
-  return (HsAddr)(&d->d_name);
-#else
+{
   return (HsAddr)(d->d_name);
-#endif
 }
 
 INLINE HsInt
 __hscore_end_of_dir( void )
 {
-#ifndef mingw32_TARGET_OS
-  return 0;
-#else
-  return ENOENT;
-#endif  
+  return READDIR_ERRNO_EOF;
 }
 
 INLINE void
@@ -457,7 +529,9 @@ __hscore_sizeof_stat( void )
 
 INLINE time_t __hscore_st_mtime ( struct stat* st ) { return st->st_mtime; }
 INLINE off_t  __hscore_st_size  ( struct stat* st ) { return st->st_size; }
+#if !defined(_MSC_VER)
 INLINE mode_t __hscore_st_mode  ( struct stat* st ) { return st->st_mode; }
+#endif
 
 #if HAVE_TERMIOS_H
 INLINE tcflag_t __hscore_lflag( struct termios* ts ) { return ts->c_lflag; }
@@ -466,29 +540,27 @@ INLINE void
 __hscore_poke_lflag( struct termios* ts, tcflag_t t ) { ts->c_lflag = t; }
 
 INLINE unsigned char*
-__hscore_ptr_c_cc( struct termios* ts ) 
+__hscore_ptr_c_cc( struct termios* ts )
 { return (unsigned char*) &ts->c_cc; }
-#endif
 
 INLINE HsInt
 __hscore_sizeof_termios( void )
 {
-#ifndef mingw32_TARGET_OS
+#ifndef mingw32_HOST_OS
   return sizeof(struct termios);
 #else
   return 0;
 #endif
 }
+#endif
 
+#if !defined(mingw32_HOST_OS) && !defined(_MSC_VER)
 INLINE HsInt
 __hscore_sizeof_sigset_t( void )
 {
-#ifndef mingw32_TARGET_OS
   return sizeof(sigset_t);
-#else
-  return 0;
-#endif
 }
+#endif
 
 INLINE int
 __hscore_echo( void )
@@ -587,5 +659,139 @@ __hscore_f_setfl( void )
 #endif
 }
 
+// defined in rts/RtsStartup.c.
+extern void* __hscore_get_saved_termios(int fd);
+extern void __hscore_set_saved_termios(int fd, void* ts);
+
+INLINE int __hscore_hs_fileno (FILE *f) { return fileno (f); }
+
+#if !defined(mingw32_HOST_OS) && !defined(_MSC_VER)
+INLINE int __hsposix_SIGABRT()   { return SIGABRT; }
+INLINE int __hsposix_SIGALRM()   { return SIGALRM; }
+INLINE int __hsposix_SIGBUS()    { return SIGBUS; }
+INLINE int __hsposix_SIGCHLD()   { return SIGCHLD; }
+INLINE int __hsposix_SIGCONT()   { return SIGCONT; }
+INLINE int __hsposix_SIGFPE()    { return SIGFPE; }
+INLINE int __hsposix_SIGHUP()    { return SIGHUP; }
+INLINE int __hsposix_SIGILL()    { return SIGILL; }
+INLINE int __hsposix_SIGINT()    { return SIGINT; }
+INLINE int __hsposix_SIGKILL()   { return SIGKILL; }
+INLINE int __hsposix_SIGPIPE()   { return SIGPIPE; }
+INLINE int __hsposix_SIGQUIT()   { return SIGQUIT; }
+INLINE int __hsposix_SIGSEGV()   { return SIGSEGV; }
+INLINE int __hsposix_SIGSTOP()   { return SIGSTOP; }
+INLINE int __hsposix_SIGTERM()   { return SIGTERM; }
+INLINE int __hsposix_SIGTSTP()   { return SIGTSTP; }
+INLINE int __hsposix_SIGTTIN()   { return SIGTTIN; }
+INLINE int __hsposix_SIGTTOU()   { return SIGTTOU; }
+INLINE int __hsposix_SIGUSR1()   { return SIGUSR1; }
+INLINE int __hsposix_SIGUSR2()   { return SIGUSR2; }
+#ifdef SIGPOLL
+INLINE int __hsposix_SIGPOLL()   { return SIGPOLL; }
+#endif
+INLINE int __hsposix_SIGPROF()   { return SIGPROF; }
+INLINE int __hsposix_SIGSYS()    { return SIGSYS; }
+INLINE int __hsposix_SIGTRAP()   { return SIGTRAP; }
+INLINE int __hsposix_SIGURG()    { return SIGURG; }
+INLINE int __hsposix_SIGVTALRM() { return SIGVTALRM; }
+INLINE int __hsposix_SIGXCPU()   { return SIGXCPU; }
+INLINE int __hsposix_SIGXFSZ()   { return SIGXFSZ; }
+
+INLINE int __hsposix_SIG_BLOCK()   { return SIG_BLOCK; }
+INLINE int __hsposix_SIG_UNBLOCK() { return SIG_UNBLOCK; }
+INLINE int __hsposix_SIG_SETMASK() { return SIG_SETMASK; }
+
+#endif /* mingw32_HOST_OS */
+
+INLINE int __hscore_open(char *file, int how, mode_t mode) {
+#ifdef mingw32_HOST_OS
+       if ((how & O_WRONLY) || (how & O_RDWR) || (how & O_APPEND))
+         return _sopen(file,how,_SH_DENYRW,mode);
+       else
+         return _sopen(file,how,_SH_DENYWR,mode);
+#else
+       return open(file,how,mode);
 #endif
+}
+
+// These are wrapped because on some OSs (eg. Linux) they are
+// macros which redirect to the 64-bit-off_t versions when large file
+// support is enabled.
+//
+INLINE off_t __hscore_lseek(int fd, off_t off, int whence) {
+       return (lseek(fd,off,whence));
+}
+
+INLINE int __hscore_stat(char *file, struct stat *buf) {
+       return (stat(file,buf));
+}
+
+INLINE int __hscore_fstat(int fd, struct stat *buf) {
+       return (fstat(fd,buf));
+}
+
+// select-related stuff
+
+#if !defined(mingw32_HOST_OS)
+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); }
+extern void hsFD_ZERO(fd_set *fds);
+#endif
+
+// gettimeofday()-related
+
+#if !defined(mingw32_HOST_OS)
+#define TICK_FREQ  50
+
+INLINE HsInt sizeofTimeVal(void) { return sizeof(struct timeval); }
+
+INLINE HsInt getTicksOfDay(void)
+{
+    struct timeval tv;
+    gettimeofday(&tv, (struct timezone *) NULL);
+    return (tv.tv_sec * TICK_FREQ +
+           tv.tv_usec * TICK_FREQ / 1000000);
+}
+
+INLINE void setTimevalTicks(struct timeval *p, HsInt ticks)
+{
+    p->tv_sec  = ticks / TICK_FREQ;
+    p->tv_usec = (ticks % TICK_FREQ) * (1000000 / TICK_FREQ);
+}
+#endif // !defined(mingw32_HOST_OS)
+
+// Directory-related
+
+#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
+
+/* ToDo: write a feature test that doesn't assume 'environ' to
+ *    be in scope at link-time. */
+extern char** environ;
+INLINE char **__hscore_environ() { return environ; }
+
+#endif /* __HSBASE_H__ */