This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
skip test on AFS (from Hans Ranke <Hans.Ranke@ei.tum.de>)
[perl5.git] / os2 / os2ish.h
1 #include <signal.h>
2
3 /* HAS_IOCTL:
4  *      This symbol, if defined, indicates that the ioctl() routine is
5  *      available to set I/O characteristics
6  */
7 #define HAS_IOCTL               /**/
8  
9 /* HAS_UTIME:
10  *      This symbol, if defined, indicates that the routine utime() is
11  *      available to update the access and modification times of files.
12  */
13 #define HAS_UTIME               /**/
14
15 #define HAS_KILL
16 #define HAS_WAIT
17 #define HAS_DLERROR
18 #define HAS_WAITPID_RUNTIME (_emx_env & 0x200)
19
20 /* USEMYBINMODE
21  *      This symbol, if defined, indicates that the program should
22  *      use the routine my_binmode(FILE *fp, char iotype) to insure
23  *      that a file is in "binary" mode -- that is, that no translation
24  *      of bytes occurs on read or write operations.
25  */
26 #undef USEMYBINMODE
27
28 /* Stat_t:
29  *      This symbol holds the type used to declare buffers for information
30  *      returned by stat().  It's usually just struct stat.  It may be necessary
31  *      to include <sys/stat.h> and <sys/types.h> to get any typedef'ed
32  *      information.
33  */
34 #define Stat_t struct stat
35
36 /* USE_STAT_RDEV:
37  *      This symbol is defined if this system has a stat structure declaring
38  *      st_rdev
39  */
40 #define USE_STAT_RDEV   /**/
41
42 /* ACME_MESS:
43  *      This symbol, if defined, indicates that error messages should be 
44  *      should be generated in a format that allows the use of the Acme
45  *      GUI/editor's autofind feature.
46  */
47 #undef ACME_MESS        /**/
48
49 /* ALTERNATE_SHEBANG:
50  *      This symbol, if defined, contains a "magic" string which may be used
51  *      as the first line of a Perl program designed to be executed directly
52  *      by name, instead of the standard Unix #!.  If ALTERNATE_SHEBANG
53  *      begins with a character other then #, then Perl will only treat
54  *      it as a command line if if finds the string "perl" in the first
55  *      word; otherwise it's treated as the first line of code in the script.
56  *      (IOW, Perl won't hand off to another interpreter via an alternate
57  *      shebang sequence that might be legal Perl code.)
58  */
59 #define ALTERNATE_SHEBANG "extproc "
60
61 #ifndef SIGABRT
62 #    define SIGABRT SIGILL
63 #endif
64 #ifndef SIGILL
65 #    define SIGILL 6         /* blech */
66 #endif
67 #define ABORT() kill(PerlProc_getpid(),SIGABRT);
68
69 #define BIT_BUCKET "/dev/nul"  /* Will this work? */
70
71 /* Apparently TCPIPV4 defines may be included even with only IAK present */
72
73 #if !defined(NO_TCPIPV4) && !defined(TCPIPV4)
74 #  define TCPIPV4
75 #  define TCPIPV4_FORCED                /* Just in case */
76 #endif
77
78 #if defined(I_SYS_UN) && !defined(TCPIPV4)
79 /* It is not working without TCPIPV4 defined. */
80 # undef I_SYS_UN
81 #endif 
82
83 #ifdef USE_THREADS
84
85 #define OS2_ERROR_ALREADY_POSTED 299    /* Avoid os2.h */
86
87 extern int rc;
88
89 #define MUTEX_INIT(m) \
90     STMT_START {                                                \
91         int rc;                                                 \
92         if ((rc = _rmutex_create(m,0)))                         \
93             croak("panic: MUTEX_INIT: rc=%i", rc);              \
94     } STMT_END
95 #define MUTEX_LOCK(m) \
96     STMT_START {                                                \
97         int rc;                                                 \
98         if ((rc = _rmutex_request(m,_FMR_IGNINT)))              \
99             croak("panic: MUTEX_LOCK: rc=%i", rc);              \
100     } STMT_END
101 #define MUTEX_UNLOCK(m) \
102     STMT_START {                                                \
103         int rc;                                                 \
104         if ((rc = _rmutex_release(m)))                          \
105             croak("panic: MUTEX_UNLOCK: rc=%i", rc);            \
106     } STMT_END
107 #define MUTEX_DESTROY(m) \
108     STMT_START {                                                \
109         int rc;                                                 \
110         if ((rc = _rmutex_close(m)))                            \
111             croak("panic: MUTEX_DESTROY: rc=%i", rc);           \
112     } STMT_END
113
114 #define COND_INIT(c) \
115     STMT_START {                                                \
116         int rc;                                                 \
117         if ((rc = DosCreateEventSem(NULL,c,0,0)))               \
118             croak("panic: COND_INIT: rc=%i", rc);               \
119     } STMT_END
120 #define COND_SIGNAL(c) \
121     STMT_START {                                                \
122         int rc;                                                 \
123         if ((rc = DosPostEventSem(*(c))) && rc != OS2_ERROR_ALREADY_POSTED)             \
124             croak("panic: COND_SIGNAL, rc=%ld", rc);            \
125     } STMT_END
126 #define COND_BROADCAST(c) \
127     STMT_START {                                                \
128         int rc;                                                 \
129         if ((rc = DosPostEventSem(*(c))) && rc != OS2_ERROR_ALREADY_POSTED)\
130             croak("panic: COND_BROADCAST, rc=%i", rc);          \
131     } STMT_END
132 /* #define COND_WAIT(c, m) \
133     STMT_START {                                                \
134         if (WaitForSingleObject(*(c),INFINITE) == WAIT_FAILED)  \
135             croak("panic: COND_WAIT");                          \
136     } STMT_END
137 */
138 #define COND_WAIT(c, m) os2_cond_wait(c,m)
139
140 #define COND_WAIT_win32(c, m) \
141     STMT_START {                                                \
142         int rc;                                                 \
143         if ((rc = SignalObjectAndWait(*(m),*(c),INFINITE,FALSE)))\
144             croak("panic: COND_WAIT");                          \
145         else                                                    \
146             MUTEX_LOCK(m);                                      \
147     } STMT_END
148 #define COND_DESTROY(c) \
149     STMT_START {                                                \
150         int rc;                                                 \
151         if ((rc = DosCloseEventSem(*(c))))                      \
152             croak("panic: COND_DESTROY, rc=%i", rc);            \
153     } STMT_END
154 /*#define THR ((struct thread *) TlsGetValue(PL_thr_key))
155 #define dTHR struct thread *thr = THR
156 */
157
158 #ifdef USE_SLOW_THREAD_SPECIFIC
159 #  define pthread_getspecific(k)        (*_threadstore())
160 #  define pthread_setspecific(k,v)      (*_threadstore()=v,0)
161 #  define pthread_key_create(keyp,flag) (*keyp=_gettid(),0)
162 #else
163 #  define pthread_getspecific(k)        (*(k))
164 #  define pthread_setspecific(k,v)      (*(k)=(v),0)
165 #  define pthread_key_create(keyp,flag) (DosAllocThreadLocalMemory(1,(U32*)keyp) ? croak("LocalMemory"),1 : 0)
166 #endif
167 #define pthread_key_delete(keyp)
168 #define pthread_self()                  _gettid()
169 #define YIELD                           DosSleep(0)
170
171 #ifdef PTHREADS_INCLUDED                /* For ./x2p stuff. */
172 int pthread_join(pthread_t tid, void **status);
173 int pthread_detach(pthread_t tid);
174 int pthread_create(pthread_t *tid, const pthread_attr_t *attr,
175                    void *(*start_routine)(void*), void *arg);
176 #endif 
177
178 #define THREADS_ELSEWHERE
179
180 #endif 
181  
182 void Perl_OS2_init(char **);
183
184 /* XXX This code hideously puts env inside: */
185
186 #ifdef PERL_CORE
187 #  define PERL_SYS_INIT3(argcp, argvp, envp) STMT_START {       \
188     _response(argcp, argvp);                    \
189     _wildcard(argcp, argvp);                    \
190     Perl_OS2_init(*envp);       } STMT_END
191 #  define PERL_SYS_INIT(argcp, argvp) STMT_START {      \
192     _response(argcp, argvp);                    \
193     _wildcard(argcp, argvp);                    \
194     Perl_OS2_init(NULL);        } STMT_END
195 #else  /* Compiling embedded Perl or Perl extension */
196 #  define PERL_SYS_INIT3(argcp, argvp, envp) STMT_START {       \
197     Perl_OS2_init(*envp);       } STMT_END
198 #  define PERL_SYS_INIT(argcp, argvp) STMT_START {      \
199     Perl_OS2_init(NULL);        } STMT_END
200 #endif
201
202 #ifndef __EMX__
203 #  define PERL_CALLCONV _System
204 #endif
205
206 #define PERL_SYS_TERM()         MALLOC_TERM
207
208 /* #define PERL_SYS_TERM() STMT_START { \
209     if (Perl_HAB_set) WinTerminate(Perl_hab);   } STMT_END */
210
211 #define dXSUB_SYS OS2_XS_init()
212
213 #ifdef PERL_IS_AOUT
214 /* #  define HAS_FORK */
215 /* #  define HIDEMYMALLOC */
216 /* #  define PERL_SBRK_VIA_MALLOC */ /* gets off-page sbrk... */
217 #else /* !PERL_IS_AOUT */
218 #  ifndef PERL_FOR_X2P
219 #    ifdef EMX_BAD_SBRK
220 #      define USE_PERL_SBRK
221 #    endif 
222 #  else
223 #    define PerlIO FILE
224 #  endif 
225 #  define SYSTEM_ALLOC(a) sys_alloc(a)
226
227 void *sys_alloc(int size);
228
229 #endif /* !PERL_IS_AOUT */
230 #if !defined(PERL_CORE) && !defined(PerlIO) /* a2p */
231 #  define PerlIO FILE
232 #endif 
233
234 #define TMPPATH1 "plXXXXXX"
235 extern char *tmppath;
236 PerlIO *my_syspopen(char *cmd, char *mode);
237 /* Cannot prototype with I32 at this point. */
238 int my_syspclose(PerlIO *f);
239 FILE *my_tmpfile (void);
240 char *my_tmpnam (char *);
241
242 #define tmpfile my_tmpfile
243 #define tmpnam  my_tmpnam
244 #define isatty  _isterm
245 #define rand    random
246 #define srand   srandom
247
248 /*
249  * fwrite1() should be a routine with the same calling sequence as fwrite(),
250  * but which outputs all of the bytes requested as a single stream (unlike
251  * fwrite() itself, which on some systems outputs several distinct records
252  * if the number_of_items parameter is >1).
253  */
254 #define fwrite1 fwrite
255
256 #define my_getenv(var) getenv(var)
257 #define flock   my_flock
258
259 void *emx_calloc (size_t, size_t);
260 void emx_free (void *);
261 void *emx_malloc (size_t);
262 void *emx_realloc (void *, size_t);
263
264 /*****************************************************************************/
265
266 #include <stdlib.h>     /* before the following definitions */
267 #include <unistd.h>     /* before the following definitions */
268
269 #define chdir   _chdir2
270 #define getcwd  _getcwd2
271
272 /* This guy is needed for quick stdstd  */
273
274 #if defined(USE_STDIO_PTR) && defined(STDIO_PTR_LVALUE) && defined(STDIO_CNT_LVALUE)
275         /* Perl uses ungetc only with successful return */
276 #  define ungetc(c,fp) \
277         (FILE_ptr(fp) > FILE_base(fp) && c == (int)*(FILE_ptr(fp) - 1) \
278          ? (--FILE_ptr(fp), ++FILE_cnt(fp), (int)c) : ungetc(c,fp))
279 #endif
280
281 #define OP_BINARY O_BINARY
282
283 #define OS2_STAT_HACK 1
284 #if OS2_STAT_HACK
285
286 #define Stat(fname,bufptr) os2_stat((fname),(bufptr))
287 #define Fstat(fd,bufptr)   fstat((fd),(bufptr))
288 #define Fflush(fp)         fflush(fp)
289 #define Mkdir(path,mode)   mkdir((path),(mode))
290
291 #undef S_IFBLK
292 #undef S_ISBLK
293 #define S_IFBLK         0120000
294 #define S_ISBLK(mode)   (((mode) & S_IFMT) == S_IFBLK)
295
296 #else
297
298 #define Stat(fname,bufptr) stat((fname),(bufptr))
299 #define Fstat(fd,bufptr)   fstat((fd),(bufptr))
300 #define Fflush(fp)         fflush(fp)
301 #define Mkdir(path,mode)   mkdir((path),(mode))
302
303 #endif
304
305 /* With SD386 it is impossible to debug register variables. */
306 #if !defined(PERL_IS_AOUT) && defined(DEBUGGING) && !defined(register)
307 #  define register
308 #endif
309
310 /* Our private OS/2 specific data. */
311
312 typedef struct OS2_Perl_data {
313   unsigned long flags;
314   unsigned long phab;
315   int (*xs_init)();
316   unsigned long rc;
317   unsigned long severity;
318   unsigned long phmq;                   /* Handle to message queue */
319   unsigned long phmq_refcnt;
320   unsigned long phmq_servers;
321   unsigned long initial_mode;           /* VIO etc. mode we were started in */
322 } OS2_Perl_data_t;
323
324 extern OS2_Perl_data_t OS2_Perl_data;
325
326 #define Perl_hab                ((HAB)OS2_Perl_data.phab)
327 #define Perl_rc                 (OS2_Perl_data.rc)
328 #define Perl_severity           (OS2_Perl_data.severity)
329 #define errno_isOS2             12345678
330 #define errno_isOS2_set         12345679
331 #define OS2_Perl_flags  (OS2_Perl_data.flags)
332 #define Perl_HAB_set_f  1
333 #define Perl_HAB_set    (OS2_Perl_flags & Perl_HAB_set_f)
334 #define set_Perl_HAB_f  (OS2_Perl_flags |= Perl_HAB_set_f)
335 #define set_Perl_HAB(h) (set_Perl_HAB_f, Perl_hab = h)
336 #define _obtain_Perl_HAB (init_PMWIN_entries(),                         \
337                           Perl_hab = (*PMWIN_entries.Initialize)(0),    \
338                           set_Perl_HAB_f, Perl_hab)
339 #define perl_hab_GET()  (Perl_HAB_set ? Perl_hab : _obtain_Perl_HAB)
340 #define Acquire_hab()   perl_hab_GET()
341 #define Perl_hmq        ((HMQ)OS2_Perl_data.phmq)
342 #define Perl_hmq_refcnt (OS2_Perl_data.phmq_refcnt)
343 #define Perl_hmq_servers        (OS2_Perl_data.phmq_servers)
344 #define Perl_os2_initial_mode   (OS2_Perl_data.initial_mode)
345
346 unsigned long Perl_hab_GET();
347 unsigned long Perl_Register_MQ(int serve);
348 void    Perl_Deregister_MQ(int serve);
349 int     Perl_Serve_Messages(int force);
350 /* Cannot prototype with I32 at this point. */
351 int     Perl_Process_Messages(int force, long *cntp);
352 char    *os2_execname(void);
353
354 struct _QMSG;
355 struct PMWIN_entries_t {
356     unsigned long (*Initialize)( unsigned long fsOptions );
357     unsigned long (*CreateMsgQueue)(unsigned long hab, long cmsg);
358     int (*DestroyMsgQueue)(unsigned long hmq);
359     int (*PeekMsg)(unsigned long hab, struct _QMSG *pqmsg,
360                    unsigned long hwndFilter, unsigned long msgFilterFirst,
361                    unsigned long msgFilterLast, unsigned long fl);
362     int (*GetMsg)(unsigned long hab, struct _QMSG *pqmsg,
363                   unsigned long hwndFilter, unsigned long msgFilterFirst,
364                   unsigned long msgFilterLast);
365     void * (*DispatchMsg)(unsigned long hab, struct _QMSG *pqmsg);
366 };
367 extern struct PMWIN_entries_t PMWIN_entries;
368 void init_PMWIN_entries(void);
369
370 #define perl_hmq_GET(serve)     Perl_Register_MQ(serve)
371 #define perl_hmq_UNSET(serve)   Perl_Deregister_MQ(serve)
372
373 #define OS2_XS_init() (*OS2_Perl_data.xs_init)()
374
375 #if _EMX_CRT_REV_ >= 60
376 # define os2_setsyserrno(rc)    (Perl_rc = rc, errno = errno_isOS2_set, \
377                                 _setsyserrno(rc))
378 #else
379 # define os2_setsyserrno(rc)    (Perl_rc = rc, errno = errno_isOS2)
380 #endif
381
382 /* The expressions below return true on error. */
383 /* INCL_DOSERRORS needed. rc should be declared outside. */
384 #define CheckOSError(expr) (!(rc = (expr)) ? 0 : (FillOSError(rc), 1))
385 /* INCL_WINERRORS needed. */
386 #define SaveWinError(expr) ((expr) ? : (FillWinError, 0))
387 #define CheckWinError(expr) ((expr) ? 0: (FillWinError, 1))
388 #define FillOSError(rc) (os2_setsyserrno(rc),                           \
389                         Perl_severity = SEVERITY_ERROR) 
390 #define FillWinError (Perl_severity = ERRORIDSEV(Perl_rc),              \
391                         Perl_rc = ERRORIDERROR(Perl_rc)),               \
392                         os2_setsyserrno(Perl_rc)
393
394 #define STATIC_FILE_LENGTH 127
395
396 #define PERLLIB_MANGLE(s, n) perllib_mangle((s), (n))
397 char *perllib_mangle(char *, unsigned int);
398
399 char *os2error(int rc);
400
401 /* ************************************************************ */
402 #define Dos32QuerySysState DosQuerySysState
403 #define QuerySysState(flags, pid, buf, bufsz) \
404         Dos32QuerySysState(flags, 0,  pid, 0, buf, bufsz)
405
406 #define QSS_PROCESS     1
407 #define QSS_MODULE      4
408 #define QSS_SEMAPHORES  2
409 #define QSS_FILE        8               /* Buggy until fixpack18 */
410 #define QSS_SHARED      16
411
412 #ifdef _OS2_H
413
414 APIRET APIENTRY Dos32QuerySysState(ULONG func,ULONG arg1,ULONG pid,
415                         ULONG _res_,PVOID buf,ULONG bufsz);
416 typedef struct {
417         ULONG   threadcnt;
418         ULONG   proccnt;
419         ULONG   modulecnt;
420 } QGLOBAL, *PQGLOBAL;
421
422 typedef struct {
423         ULONG   rectype;
424         USHORT  threadid;
425         USHORT  slotid;
426         ULONG   sleepid;
427         ULONG   priority;
428         ULONG   systime;
429         ULONG   usertime;
430         UCHAR   state;
431         UCHAR   _reserved1_;    /* padding to ULONG */
432         USHORT  _reserved2_;    /* padding to ULONG */
433 } QTHREAD, *PQTHREAD;
434
435 typedef struct {
436         USHORT  sfn;
437         USHORT  refcnt;
438         USHORT  flags1;
439         USHORT  flags2;
440         USHORT  accmode1;
441         USHORT  accmode2;
442         ULONG   filesize;
443         USHORT  volhnd;
444         USHORT  attrib;
445         USHORT  _reserved_;
446 } QFDS, *PQFDS;
447
448 typedef struct qfile {
449         ULONG           rectype;
450         struct qfile    *next;
451         ULONG           opencnt;
452         PQFDS           filedata;
453         char            name[1];
454 } QFILE, *PQFILE;
455
456 typedef struct {
457         ULONG   rectype;
458         PQTHREAD threads;
459         USHORT  pid;
460         USHORT  ppid;
461         ULONG   type;
462         ULONG   state;
463         ULONG   sessid;
464         USHORT  hndmod;
465         USHORT  threadcnt;
466         ULONG   privsem32cnt;
467         ULONG   _reserved2_;
468         USHORT  sem16cnt;
469         USHORT  dllcnt;
470         USHORT  shrmemcnt;
471         USHORT  fdscnt;
472         PUSHORT sem16s;
473         PUSHORT dlls;
474         PUSHORT shrmems;
475         PUSHORT fds;
476 } QPROCESS, *PQPROCESS;
477
478 typedef struct sema {
479         struct sema *next;
480         USHORT  refcnt;
481         UCHAR   sysflags;
482         UCHAR   sysproccnt;
483         ULONG   _reserved1_;
484         USHORT  index;
485         CHAR    name[1];
486 } QSEMA, *PQSEMA;
487
488 typedef struct {
489         ULONG   rectype;
490         ULONG   _reserved1_;
491         USHORT  _reserved2_;
492         USHORT  syssemidx;
493         ULONG   index;
494         QSEMA   sema;
495 } QSEMSTRUC, *PQSEMSTRUC;
496
497 typedef struct {
498         USHORT  pid;
499         USHORT  opencnt;
500 } QSEMOWNER32, *PQSEMOWNER32;
501
502 typedef struct {
503         PQSEMOWNER32    own;
504         PCHAR           name;
505         PVOID           semrecs; /* array of associated sema's */
506         USHORT          flags;
507         USHORT          semreccnt;
508         USHORT          waitcnt;
509         USHORT          _reserved_;     /* padding to ULONG */
510 } QSEMSMUX32, *PQSEMSMUX32;
511
512 typedef struct {
513         PQSEMOWNER32    own;
514         PCHAR           name;
515         PQSEMSMUX32     mux;
516         USHORT          flags;
517         USHORT          postcnt;
518 } QSEMEV32, *PQSEMEV32;
519
520 typedef struct {
521         PQSEMOWNER32    own;
522         PCHAR           name;
523         PQSEMSMUX32     mux;
524         USHORT          flags;
525         USHORT          refcnt;
526         USHORT          thrdnum;
527         USHORT          _reserved_;     /* padding to ULONG */
528 } QSEMMUX32, *PQSEMMUX32;
529
530 typedef struct semstr32 {
531         struct semstr *next;
532         QSEMEV32 evsem;
533         QSEMMUX32  muxsem;
534         QSEMSMUX32 smuxsem;
535 } QSEMSTRUC32, *PQSEMSTRUC32;
536
537 typedef struct shrmem {
538         struct shrmem *next;
539         USHORT  hndshr;
540         USHORT  selshr;
541         USHORT  refcnt;
542         CHAR    name[1];
543 } QSHRMEM, *PQSHRMEM;
544
545 typedef struct module {
546         struct module *next;
547         USHORT  hndmod;
548         USHORT  type;
549         ULONG   refcnt;
550         ULONG   segcnt;
551         PVOID   _reserved_;
552         PCHAR   name;
553         USHORT  modref[1];
554 } QMODULE, *PQMODULE;
555
556 typedef struct {
557         PQGLOBAL        gbldata;
558         PQPROCESS       procdata;
559         PQSEMSTRUC      semadata;
560         PQSEMSTRUC32    sem32data;
561         PQSHRMEM        shrmemdata;
562         PQMODULE        moddata;
563         PVOID           _reserved2_;
564         PQFILE          filedata;
565 } QTOPLEVEL, *PQTOPLEVEL;
566 /* ************************************************************ */
567
568 PQTOPLEVEL get_sysinfo(ULONG pid, ULONG flags);
569
570 #endif /* _OS2_H */
571