[project @ 2004-09-29 22:48:06 by krasimir]
[ghc-base.git] / include / HsBase.h
1 /* -----------------------------------------------------------------------------
2  *
3  * (c) The University of Glasgow 2001-2004
4  *
5  * Definitions for package `base' which are visible in Haskell land.
6  *
7  * ---------------------------------------------------------------------------*/
8
9 #ifndef __HSBASE_H__
10 #define __HSBASE_H__
11
12 #include "ghcconfig.h"
13 #include "HsBaseConfig.h"
14 #include "HsFFI.h"
15
16 #include <stdio.h>
17 #include <stdlib.h>
18 #include <math.h>
19
20 #if HAVE_SYS_TYPES_H
21 #include <sys/types.h>
22 #endif
23 #if HAVE_UNISTD_H
24 #include <unistd.h>
25 #endif
26 #if HAVE_SYS_STAT_H
27 #include <sys/stat.h>
28 #endif
29 #if HAVE_FCNTL_H
30 # include <fcntl.h>
31 #endif
32 #if HAVE_TERMIOS_H
33 #include <termios.h>
34 #endif
35 #if HAVE_SIGNAL_H
36 #include <signal.h>
37 /* Ultra-ugly: OpenBSD uses broken macros for sigemptyset and sigfillset (missing casts) */
38 #if __OpenBSD__
39 #undef sigemptyset
40 #undef sigfillset
41 #endif
42 #endif
43 #if HAVE_ERRNO_H
44 #include <errno.h>
45 #endif
46 #if HAVE_STRING_H
47 #include <string.h>
48 #endif
49 #if HAVE_DIRENT_H
50 #include <dirent.h>
51 #endif
52 #if HAVE_UTIME_H
53 #include <utime.h>
54 #endif
55 #if HAVE_SYS_UTSNAME_H
56 #include <sys/utsname.h>
57 #endif
58 #if HAVE_GETTIMEOFDAY
59 #  if HAVE_SYS_TIME_H
60 #   include <sys/time.h>
61 #  endif
62 #elif HAVE_GETCLOCK
63 # if HAVE_SYS_TIMERS_H
64 #  define POSIX_4D9 1
65 #  include <sys/timers.h>
66 # endif
67 #endif
68 #if HAVE_TIME_H
69 #include <time.h>
70 #endif
71 #if HAVE_SYS_TIMEB_H
72 #include <sys/timeb.h>
73 #endif
74 #if HAVE_WINDOWS_H
75 #include <windows.h>
76 #endif
77 #if HAVE_SYS_TIMES_H
78 #include <sys/times.h>
79 #endif
80 #if HAVE_WINSOCK_H && defined(mingw32_TARGET_OS)
81 #include <winsock.h>
82 #endif
83 #if HAVE_LIMITS_H
84 #include <limits.h>
85 #endif
86 #if HAVE_WCTYPE_H
87 #include <wctype.h>
88 #endif
89
90 #if !defined(mingw32_TARGET_OS) && !defined(irix_TARGET_OS)
91 # if HAVE_SYS_RESOURCE_H
92 #  include <sys/resource.h>
93 # endif
94 #endif
95
96 #ifdef hpux_TARGET_OS
97 #include <sys/syscall.h>
98 #define getrusage(a, b)  syscall(SYS_GETRUSAGE, a, b)
99 #define HAVE_GETRUSAGE
100 #endif
101
102 /* For System */
103 #if HAVE_SYS_WAIT_H
104 #include <sys/wait.h>
105 #endif
106 #if HAVE_VFORK_H
107 #include <vfork.h>
108 #endif
109 #include "lockFile.h"
110 #include "dirUtils.h"
111
112 #include "runProcess.h"
113
114 #if defined(mingw32_TARGET_OS)
115 #include <io.h>
116 #include <fcntl.h>
117 #include "timeUtils.h"
118 #include <shlobj.h>
119 #endif
120
121 /* in inputReady.c */
122 int inputReady(int fd, int msecs, int isSock);
123
124 /* in writeError.c */
125 void writeErrString__(HsAddr msg, HsInt len);
126
127 /* in Signals.c */
128 extern HsInt nocldstop;
129
130 #if !defined(mingw32_TARGET_OS)
131 /* in execvpe.c */
132 extern int execvpe(char *name, char *const argv[], char **envp);
133 extern void pPrPr_disableITimers (void);
134 #endif
135
136 /* -----------------------------------------------------------------------------
137    64-bit operations, defined in longlong.c
138    -------------------------------------------------------------------------- */
139
140 #ifdef SUPPORT_LONG_LONGS
141
142 StgInt stg_gtWord64 (StgWord64, StgWord64);
143 StgInt stg_geWord64 (StgWord64, StgWord64);
144 StgInt stg_eqWord64 (StgWord64, StgWord64);
145 StgInt stg_neWord64 (StgWord64, StgWord64);
146 StgInt stg_ltWord64 (StgWord64, StgWord64);
147 StgInt stg_leWord64 (StgWord64, StgWord64);
148
149 StgInt stg_gtInt64 (StgInt64, StgInt64);
150 StgInt stg_geInt64 (StgInt64, StgInt64);
151 StgInt stg_eqInt64 (StgInt64, StgInt64);
152 StgInt stg_neInt64 (StgInt64, StgInt64);
153 StgInt stg_ltInt64 (StgInt64, StgInt64);
154 StgInt stg_leInt64 (StgInt64, StgInt64);
155
156 StgWord64 stg_remWord64  (StgWord64, StgWord64);
157 StgWord64 stg_quotWord64 (StgWord64, StgWord64);
158
159 StgInt64 stg_remInt64    (StgInt64, StgInt64);
160 StgInt64 stg_quotInt64   (StgInt64, StgInt64);
161 StgInt64 stg_negateInt64 (StgInt64);
162 StgInt64 stg_plusInt64   (StgInt64, StgInt64);
163 StgInt64 stg_minusInt64  (StgInt64, StgInt64);
164 StgInt64 stg_timesInt64  (StgInt64, StgInt64);
165
166 StgWord64 stg_and64  (StgWord64, StgWord64);
167 StgWord64 stg_or64   (StgWord64, StgWord64);
168 StgWord64 stg_xor64  (StgWord64, StgWord64);
169 StgWord64 stg_not64  (StgWord64);
170
171 StgWord64 stg_uncheckedShiftL64   (StgWord64, StgInt);
172 StgWord64 stg_uncheckedShiftRL64  (StgWord64, StgInt);
173 StgInt64  stg_uncheckedIShiftL64  (StgInt64, StgInt);
174 StgInt64  stg_uncheckedIShiftRL64 (StgInt64, StgInt);
175 StgInt64  stg_uncheckedIShiftRA64 (StgInt64, StgInt);
176
177 StgInt64  stg_intToInt64    (StgInt);
178 StgInt    stg_int64ToInt    (StgInt64);
179 StgWord64 stg_int64ToWord64 (StgInt64);
180
181 StgWord64 stg_wordToWord64  (StgWord);
182 StgWord   stg_word64ToWord  (StgWord64);
183 StgInt64  stg_word64ToInt64 (StgWord64);
184
185 StgInt64  stg_integerToInt64 (StgInt sa, StgByteArray /* Really: mp_limb_t* */ da);
186 StgWord64 stg_integerToWord64 (StgInt sa, StgByteArray /* Really: mp_limb_t* */ da);
187
188 #endif /* SUPPORT_LONG_LONGS */
189
190 /* -----------------------------------------------------------------------------
191    INLINE functions.
192
193    These functions are given as inlines here for when compiling via C,
194    but we also generate static versions into the cbits library for
195    when compiling to native code.
196    -------------------------------------------------------------------------- */
197
198 #ifndef INLINE
199 # if defined(_MSC_VER)
200 #  define INLINE extern __inline
201 # elif defined(__HUGS__)
202 #  define INLINE INLINE_ONLY
203 # else
204 #  define INLINE extern inline
205 # endif
206 #endif
207
208 INLINE int __hscore_get_errno(void) { return errno; }
209 INLINE void __hscore_set_errno(int e) { errno = e; }
210
211 #if !defined(_MSC_VER)
212 INLINE int __hscore_s_isreg(m)  { return S_ISREG(m);  }
213 INLINE int __hscore_s_isdir(m)  { return S_ISDIR(m);  }
214 INLINE int __hscore_s_isfifo(m) { return S_ISFIFO(m); }
215 INLINE int __hscore_s_isblk(m)  { return S_ISBLK(m);  }
216 INLINE int __hscore_s_ischr(m)  { return S_ISCHR(m);  }
217 #ifdef S_ISSOCK
218 INLINE int __hscore_s_issock(m) { return S_ISSOCK(m); }
219 #endif
220 #endif
221
222 #if !defined(mingw32_TARGET_OS) && !defined(_MSC_VER)
223 INLINE int
224 __hscore_sigemptyset( sigset_t *set )
225 { return sigemptyset(set); }
226
227 INLINE int
228 __hscore_sigfillset( sigset_t *set )
229 { return sigfillset(set); }
230
231 INLINE int
232 __hscore_sigaddset( sigset_t * set, int s )
233 { return sigaddset(set,s); }
234
235 INLINE int
236 __hscore_sigdelset( sigset_t * set, int s )
237 { return sigdelset(set,s); }
238
239 INLINE int
240 __hscore_sigismember( sigset_t * set, int s )
241 { return sigismember(set,s); }
242 #endif
243
244 INLINE void *
245 __hscore_memcpy_dst_off( char *dst, int dst_off, char *src, size_t sz )
246 { return memcpy(dst+dst_off, src, sz); }
247
248 INLINE void *
249 __hscore_memcpy_src_off( char *dst, char *src, int src_off, size_t sz )
250 { return memcpy(dst, src+src_off, sz); }
251
252 INLINE HsBool
253 __hscore_supportsTextMode()
254 {
255 #if defined(mingw32_TARGET_OS)
256   return HS_BOOL_FALSE;
257 #else
258   return HS_BOOL_TRUE;
259 #endif
260 }
261
262 INLINE HsInt
263 __hscore_bufsiz()
264 {
265   return BUFSIZ;
266 }
267
268 INLINE HsInt
269 __hscore_seek_cur()
270 {
271   return SEEK_CUR;
272 }
273
274 INLINE HsInt
275 __hscore_o_binary()
276 {
277 #if defined(_MSC_VER)
278   return O_BINARY;
279 #else
280   return CONST_O_BINARY;
281 #endif
282 }
283
284 INLINE int
285 __hscore_o_rdonly()
286 {
287 #ifdef O_RDONLY
288   return O_RDONLY;
289 #else
290   return 0;
291 #endif
292 }
293
294 INLINE int
295 __hscore_o_wronly( void )
296 {
297 #ifdef O_WRONLY
298   return O_WRONLY;
299 #else
300   return 0;
301 #endif
302 }
303
304 INLINE int
305 __hscore_o_rdwr( void )
306 {
307 #ifdef O_RDWR
308   return O_RDWR;
309 #else
310   return 0;
311 #endif
312 }
313
314 INLINE int
315 __hscore_o_append( void )
316 {
317 #ifdef O_APPEND
318   return O_APPEND;
319 #else
320   return 0;
321 #endif
322 }
323
324 INLINE int
325 __hscore_o_creat( void )
326 {
327 #ifdef O_CREAT
328   return O_CREAT;
329 #else
330   return 0;
331 #endif
332 }
333
334 INLINE int
335 __hscore_o_excl( void )
336 {
337 #ifdef O_EXCL
338   return O_EXCL;
339 #else
340   return 0;
341 #endif
342 }
343
344 INLINE int
345 __hscore_o_trunc( void )
346 {
347 #ifdef O_TRUNC
348   return O_TRUNC;
349 #else
350   return 0;
351 #endif
352 }
353
354 INLINE int
355 __hscore_o_noctty( void )
356 {
357 #ifdef O_NOCTTY
358   return O_NOCTTY;
359 #else
360   return 0;
361 #endif
362 }
363
364 INLINE int
365 __hscore_o_nonblock( void )
366 {
367 #ifdef O_NONBLOCK
368   return O_NONBLOCK;
369 #else
370   return 0;
371 #endif
372 }
373
374 INLINE HsInt
375 __hscore_seek_set( void )
376 {
377   return SEEK_SET;
378 }
379
380 INLINE HsInt
381 __hscore_seek_end( void )
382 {
383   return SEEK_END;
384 }
385
386 INLINE HsInt
387 __hscore_setmode( HsInt fd, HsBool toBin )
388 {
389 #if defined(mingw32_TARGET_OS) || defined(_MSC_VER)
390   return setmode(fd,(toBin == HS_BOOL_TRUE) ? _O_BINARY : _O_TEXT);
391 #else
392   return 0;
393 #endif
394 }
395
396 INLINE HsInt
397 __hscore_PrelHandle_write( HsInt fd, HsAddr ptr, HsInt off, int sz )
398 {
399   return write(fd,(char *)ptr + off, sz);
400 }
401
402 INLINE HsInt
403 __hscore_PrelHandle_read( HsInt fd, HsAddr ptr, HsInt off, int sz )
404 {
405   return read(fd,(char *)ptr + off, sz);
406
407 }
408
409 #if defined(mingw32_TARGET_OS) || defined(_MSC_VER)
410 INLINE HsInt
411 __hscore_PrelHandle_send( HsInt fd, HsAddr ptr, HsInt off, int sz )
412 {
413     return send(fd,(char *)ptr + off, sz, 0);
414 }
415
416 INLINE HsInt
417 __hscore_PrelHandle_recv( HsInt fd, HsAddr ptr, HsInt off, int sz )
418 {
419     return recv(fd,(char *)ptr + off, sz, 0);
420 }
421 #endif
422
423 #if defined(mingw32_TARGET_OS) || defined(_MSC_VER)
424 INLINE long *
425 __hscore_Time_ghcTimezone( void ) { return &_timezone; }
426
427 INLINE char **
428 __hscore_Time_ghcTzname( void ) { return _tzname; }
429 #endif
430
431 INLINE HsInt
432 __hscore_mkdir( HsAddr pathName, HsInt mode )
433 {
434 #if defined(mingw32_TARGET_OS) || defined(_MSC_VER)
435   return mkdir(pathName);
436 #else
437   return mkdir(pathName,mode);
438 #endif
439 }
440
441 INLINE HsInt
442 __hscore_lstat( HsAddr fname, HsAddr st )
443 {
444 #if HAVE_LSTAT
445   return lstat((const char*)fname, (struct stat*)st);
446 #else
447   return stat((const char*)fname, (struct stat*)st);
448 #endif
449 }
450
451 #ifdef PATH_MAX
452 /* A size that will contain many path names, but not necessarily all
453  * (PATH_MAX is not defined on systems with unlimited path length,
454  * e.g. the Hurd).
455  */
456 INLINE HsInt __hscore_long_path_size() { return PATH_MAX; }
457 #else
458 INLINE HsInt __hscore_long_path_size() { return 4096; }
459 #endif
460
461 #ifdef R_OK
462 INLINE mode_t __hscore_R_OK() { return R_OK; }
463 #endif
464 #ifdef W_OK
465 INLINE mode_t __hscore_W_OK() { return W_OK; }
466 #endif
467 #ifdef X_OK
468 INLINE mode_t __hscore_X_OK() { return X_OK; }
469 #endif
470
471 #ifdef S_IRUSR
472 INLINE mode_t __hscore_S_IRUSR() { return S_IRUSR; }
473 #endif
474 #ifdef S_IWUSR
475 INLINE mode_t __hscore_S_IWUSR() { return S_IWUSR; }
476 #endif
477 #ifdef S_IXUSR
478 INLINE mode_t __hscore_S_IXUSR() { return S_IXUSR; }
479 #endif
480
481 INLINE HsAddr
482 __hscore_d_name( struct dirent* d )
483 {
484 #if defined(STRUCT_DIRENT_FLAT_LAYOUT)
485   return (HsAddr)(&d->d_name);
486 #else
487   return (HsAddr)(d->d_name);
488 #endif
489 }
490
491 INLINE HsInt
492 __hscore_end_of_dir( void )
493 {
494   return READDIR_ERRNO_EOF;
495 }
496
497 INLINE void
498 __hscore_free_dirent(HsAddr dEnt)
499 {
500 #if HAVE_READDIR_R
501   free(dEnt);
502 #endif
503 }
504
505 INLINE HsInt
506 __hscore_sizeof_stat( void )
507 {
508   return sizeof(struct stat);
509 }
510
511 INLINE time_t __hscore_st_mtime ( struct stat* st ) { return st->st_mtime; }
512 INLINE off_t  __hscore_st_size  ( struct stat* st ) { return st->st_size; }
513 #if !defined(_MSC_VER)
514 INLINE mode_t __hscore_st_mode  ( struct stat* st ) { return st->st_mode; }
515 #endif
516
517 #if HAVE_TERMIOS_H
518 INLINE tcflag_t __hscore_lflag( struct termios* ts ) { return ts->c_lflag; }
519
520 INLINE void
521 __hscore_poke_lflag( struct termios* ts, tcflag_t t ) { ts->c_lflag = t; }
522
523 INLINE unsigned char*
524 __hscore_ptr_c_cc( struct termios* ts )
525 { return (unsigned char*) &ts->c_cc; }
526
527 INLINE HsInt
528 __hscore_sizeof_termios( void )
529 {
530 #ifndef mingw32_TARGET_OS
531   return sizeof(struct termios);
532 #else
533   return 0;
534 #endif
535 }
536 #endif
537
538 #if !defined(mingw32_TARGET_OS) && !defined(_MSC_VER)
539 INLINE HsInt
540 __hscore_sizeof_sigset_t( void )
541 {
542   return sizeof(sigset_t);
543 }
544 #endif
545
546 INLINE int
547 __hscore_echo( void )
548 {
549 #ifdef ECHO
550   return ECHO;
551 #else
552   return 0;
553 #endif
554
555 }
556
557 INLINE int
558 __hscore_tcsanow( void )
559 {
560 #ifdef TCSANOW
561   return TCSANOW;
562 #else
563   return 0;
564 #endif
565
566 }
567
568 INLINE int
569 __hscore_icanon( void )
570 {
571 #ifdef ICANON
572   return ICANON;
573 #else
574   return 0;
575 #endif
576 }
577
578 INLINE int __hscore_vmin( void )
579 {
580 #ifdef VMIN
581   return VMIN;
582 #else
583   return 0;
584 #endif
585 }
586
587 INLINE int __hscore_vtime( void )
588 {
589 #ifdef VTIME
590   return VTIME;
591 #else
592   return 0;
593 #endif
594 }
595
596 INLINE int __hscore_sigttou( void )
597 {
598 #ifdef SIGTTOU
599   return SIGTTOU;
600 #else
601   return 0;
602 #endif
603 }
604
605 INLINE int __hscore_sig_block( void )
606 {
607 #ifdef SIG_BLOCK
608   return SIG_BLOCK;
609 #else
610   return 0;
611 #endif
612 }
613
614 INLINE int __hscore_sig_setmask( void )
615 {
616 #ifdef SIG_SETMASK
617   return SIG_SETMASK;
618 #else
619   return 0;
620 #endif
621 }
622
623 INLINE int
624 __hscore_f_getfl( void )
625 {
626 #ifdef F_GETFL
627   return F_GETFL;
628 #else
629   return 0;
630 #endif
631 }
632
633 INLINE int
634 __hscore_f_setfl( void )
635 {
636 #ifdef F_SETFL
637   return F_SETFL;
638 #else
639   return 0;
640 #endif
641 }
642
643 // defined in rts/RtsStartup.c.
644 extern void* __hscore_get_saved_termios(int fd);
645 extern void __hscore_set_saved_termios(int fd, void* ts);
646
647 INLINE int __hscore_hs_fileno (FILE *f) { return fileno (f); }
648
649 #if !defined(mingw32_TARGET_OS) && !defined(_MSC_VER)
650 INLINE int __hsposix_SIGABRT()   { return SIGABRT; }
651 INLINE int __hsposix_SIGALRM()   { return SIGALRM; }
652 INLINE int __hsposix_SIGBUS()    { return SIGBUS; }
653 INLINE int __hsposix_SIGCHLD()   { return SIGCHLD; }
654 INLINE int __hsposix_SIGCONT()   { return SIGCONT; }
655 INLINE int __hsposix_SIGFPE()    { return SIGFPE; }
656 INLINE int __hsposix_SIGHUP()    { return SIGHUP; }
657 INLINE int __hsposix_SIGILL()    { return SIGILL; }
658 INLINE int __hsposix_SIGINT()    { return SIGINT; }
659 INLINE int __hsposix_SIGKILL()   { return SIGKILL; }
660 INLINE int __hsposix_SIGPIPE()   { return SIGPIPE; }
661 INLINE int __hsposix_SIGQUIT()   { return SIGQUIT; }
662 INLINE int __hsposix_SIGSEGV()   { return SIGSEGV; }
663 INLINE int __hsposix_SIGSTOP()   { return SIGSTOP; }
664 INLINE int __hsposix_SIGTERM()   { return SIGTERM; }
665 INLINE int __hsposix_SIGTSTP()   { return SIGTSTP; }
666 INLINE int __hsposix_SIGTTIN()   { return SIGTTIN; }
667 INLINE int __hsposix_SIGTTOU()   { return SIGTTOU; }
668 INLINE int __hsposix_SIGUSR1()   { return SIGUSR1; }
669 INLINE int __hsposix_SIGUSR2()   { return SIGUSR2; }
670 #ifdef SIGPOLL
671 INLINE int __hsposix_SIGPOLL()   { return SIGPOLL; }
672 #endif
673 INLINE int __hsposix_SIGPROF()   { return SIGPROF; }
674 INLINE int __hsposix_SIGSYS()    { return SIGSYS; }
675 INLINE int __hsposix_SIGTRAP()   { return SIGTRAP; }
676 INLINE int __hsposix_SIGURG()    { return SIGURG; }
677 INLINE int __hsposix_SIGVTALRM() { return SIGVTALRM; }
678 INLINE int __hsposix_SIGXCPU()   { return SIGXCPU; }
679 INLINE int __hsposix_SIGXFSZ()   { return SIGXFSZ; }
680
681 INLINE int __hsposix_SIG_BLOCK()   { return SIG_BLOCK; }
682 INLINE int __hsposix_SIG_UNBLOCK() { return SIG_UNBLOCK; }
683 INLINE int __hsposix_SIG_SETMASK() { return SIG_SETMASK; }
684
685 #endif /* mingw32_TARGET_OS */
686
687 // These are wrapped because on some OSs (eg. Linux) they are
688 // macros which redirect to the 64-bit-off_t versions when large file
689 // support is enabled.
690 //
691 INLINE int __hscore_open(char *file, int how, mode_t mode) {
692         return (open(file,how,mode));
693 }
694
695 INLINE off_t __hscore_lseek(int fd, off_t off, int whence) {
696         return (lseek(fd,off,whence));
697 }
698
699 INLINE int __hscore_stat(char *file, struct stat *buf) {
700         return (stat(file,buf));
701 }
702
703 INLINE int __hscore_fstat(int fd, struct stat *buf) {
704         return (fstat(fd,buf));
705 }
706
707 #if defined(mingw32_TARGET_OS)
708
709 /* Make sure we've got the reqd CSIDL_ constants in scope;
710  * w32api header files are lagging a bit in defining the full set.
711  */
712 #if !defined(CSIDL_APPDATA)
713 #define CSIDL_APPDATA 0x001a
714 #endif
715 #if !defined(CSIDL_PERSONAL)
716 #define CSIDL_PERSONAL 0x0005
717 #endif
718 #if !defined(CSIDL_PROFILE)
719 #define CSIDL_PROFILE 0x0028
720 #endif
721 #if !defined(CSIDL_WINDOWS)
722 #define CSIDL_WINDOWS 0x0024
723 #endif
724
725 INLINE int __hscore_CSIDL_PROFILE()  { return CSIDL_PROFILE;  }
726 INLINE int __hscore_CSIDL_APPDATA()  { return CSIDL_APPDATA;  }
727 INLINE int __hscore_CSIDL_WINDOWS()  { return CSIDL_WINDOWS;  }
728 INLINE int __hscore_CSIDL_PERSONAL() { return CSIDL_PERSONAL; }
729 #endif
730
731 #endif /* __HSBASE_H__ */
732