Threadsafe patches
[p5sagit/p5-mst-13.2.git] / vms / vmsish.h
1 /*  vmsish.h
2  *
3  * VMS-specific C header file for perl5.
4  *
5  * Last revised: 16-Sep-1998 by Charles Bailey  bailey@newman.upenn.edu
6  * Version: 5.5.2
7  */
8
9 #ifndef __vmsish_h_included
10 #define __vmsish_h_included
11
12 #include <descrip.h> /* for dirent struct definitions */
13 #include <libdef.h>  /* status codes for various places */
14 #include <rmsdef.h>  /* at which errno and vaxc$errno are */
15 #include <ssdef.h>   /* explicitly set in the perl source code */
16 #include <stsdef.h>  /* bitmasks for exit status testing */
17
18 /* Suppress compiler warnings from DECC for VMS-specific extensions:
19  * ADDRCONSTEXT,NEEDCONSTEXT: initialization of data with non-constant values
20  *                            (e.g. pointer fields of descriptors)
21  */
22 #ifdef __DECC
23 #  pragma message disable (ADDRCONSTEXT,NEEDCONSTEXT)
24 #endif
25
26 /* DEC's C compilers and gcc use incompatible definitions of _to(upp|low)er() */
27 #ifdef _toupper
28 #  undef _toupper
29 #endif
30 #define _toupper(c) (((c) < 'a' || (c) > 'z') ? (c) : (c) & ~040)
31 #ifdef _tolower
32 #  undef _tolower
33 #endif
34 #define _tolower(c) (((c) < 'A' || (c) > 'Z') ? (c) : (c) | 040)
35 /* DECC 1.3 has a funny definition of abs; it's fixed in DECC 4.0, so this
36  * can go away once DECC 1.3 isn't in use any more. */
37 #if defined(__ALPHA) && defined(__DECC)
38 #undef abs
39 #define abs(__x)        __ABS(__x)
40 #undef labs
41 #define labs(__x)        __LABS(__x)
42 #endif /* __ALPHA && __DECC */
43
44 /* Assorted things to look like Unix */
45 #ifdef __GNUC__
46 #ifndef _IOLBF /* gcc's stdio.h doesn't define this */
47 #define _IOLBF 1
48 #endif
49 #endif
50 #include <processes.h> /* for vfork() */
51 #include <unixio.h>
52 #include <unixlib.h>
53 #include <file.h>  /* it's not <sys/file.h>, so don't use I_SYS_FILE */
54 #if defined(__DECC) && defined(__DECC_VER) && __DECC_VER > 20000000
55 #  include <unistd.h> /* DECC has this; VAXC and gcc don't */
56 #endif
57
58 /* VAXC doesn't have a unary plus operator, so we need to get there indirectly */
59 #if defined(VAXC) && !defined(__DECC)
60 #  define NO_UNARY_PLUS
61 #endif
62
63 #ifdef NO_PERL_TYPEDEFS /* a2p; we don't want Perl's special routines */
64 #  define DONT_MASK_RTL_CALLS
65 #endif
66
67 /* Note that we do, in fact, have this */
68 #define HAS_GETENV_SV
69 #define HAS_GETENV_LEN
70
71 #ifndef DONT_MASK_RTL_CALLS
72 #  ifdef getenv
73 #    undef getenv
74 #  endif
75   /* getenv used for regular logical names */
76 #  define getenv(v) my_getenv(v,TRUE)
77 #endif
78 #ifdef getenv_len
79 #  undef getenv_len
80 #endif
81 #define getenv_len(v,l) my_getenv_len(v,l,TRUE)
82
83 /* DECC introduces this routine in the RTL as of VMS 7.0; for now,
84  * we'll use ours, since it gives us the full VMS exit status. */
85 #define waitpid my_waitpid
86
87 /* Don't redeclare standard RTL routines in Perl's header files;
88  * VMS history or extensions makes some of the formal protoypes
89  * differ from the common Unix forms.
90  */
91 #define DONT_DECLARE_STD 1
92
93 /* Our own contribution to PerlShr's global symbols . . . */
94 #define my_getenv_len           Perl_my_getenv_len
95 #define prime_env_iter  Perl_prime_env_iter
96 #define vmssetenv               Perl_vmssetenv
97 #if !defined(PERL_IMPLICIT_CONTEXT)
98 #define my_trnlnm               Perl_my_trnlnm
99 #define vmstrnenv               Perl_vmstrnenv            
100 #define my_setenv               Perl_my_setenv
101 #define my_getenv               Perl_my_getenv
102 #define tounixspec              Perl_tounixspec
103 #define tounixspec_ts           Perl_tounixspec_ts
104 #define tovmsspec               Perl_tovmsspec
105 #define tovmsspec_ts            Perl_tovmsspec_ts
106 #define tounixpath              Perl_tounixpath
107 #define tounixpath_ts           Perl_tounixpath_ts
108 #define tovmspath               Perl_tovmspath
109 #define tovmspath_ts            Perl_tovmspath_ts
110 #define do_rmdir                Perl_do_rmdir
111 #define fileify_dirspec         Perl_fileify_dirspec
112 #define fileify_dirspec_ts      Perl_fileify_dirspec_ts
113 #define pathify_dirspec         Perl_pathify_dirspec
114 #define pathify_dirspec_ts      Perl_pathify_dirspec_ts
115 #define trim_unixpath           Perl_trim_unixpath
116 #define opendir                 Perl_opendir
117 #define rmscopy                 Perl_rmscopy
118 #else
119 #define my_trnlnm(a,b,c)        Perl_my_trnlnm(aTHX_ a,b,c)
120 #define vmstrnenv(a,b,c,d,e)    Perl_vmstrnenv(aTHX_ a,b,c,d,e)
121 #define my_setenv(a,b)          Perl_my_setenv(aTHX_ a,b)
122 #define my_getenv(a,b)          Perl_my_getenv(aTHX_ a,b)
123 #define tounixspec(a,b)         Perl_tounixspec(aTHX_ a,b)
124 #define tounixspec_ts(a,b)      Perl_tounixspec_ts(aTHX_ a,b)
125 #define tovmsspec(a,b)          Perl_tovmsspec(aTHX_ a,b)
126 #define tovmsspec_t(a,b)        Perl_tovmsspec_ts(aTHX_ a,b)
127 #define tounixpath(a,b)         Perl_tounixpath(aTHX_ a,b)
128 #define tounixpath_ts(a,b)      Perl_tounixpath_ts(aTHX_ a,b)
129 #define tovmspath(a,b)          Perl_tovmspath(aTHX_ a,b)
130 #define tovmspath_ts(a,b)       Perl_tovmspath_ts(aTHX_ a,b)
131 #define do_rmdir(a)             Perl_do_rmdir(aTHX_ a)
132 #define fileify_dirspec(a,b)    Perl_fileify_dirspec(aTHX_ a,b)
133 #define fileify_dirspec_ts(a,b) Perl_fileify_dirspec_ts(aTHX_ a,b)
134 #define pathify_dirspec         Perl_pathify_dirspec
135 #define pathify_dirspec_ts      Perl_pathify_dirspec_ts
136 #define rmsexpand(a,b,c,d)      Perl_rmsexpand(aTHX_ a,b,c,d)
137 #define rmsexpand_ts(a,b,c,d)   Perl_rmsexpand_ts(aTHX_ a,b,c,d)
138 #define trim_unixpath(a,b,c)    Perl_trim_unixpath(aTHX_ a,b,c)
139 #define opendir(a)              Perl_opendir(aTHX_ a)
140 #define rmscopy(a,b,c)          Perl_rmscopy(aTHX_ a,b,c)
141 #endif
142 #define my_crypt                Perl_my_crypt
143 #define my_waitpid              Perl_my_waitpid
144 #define my_gconvert             Perl_my_gconvert
145 #define kill_file               Perl_kill_file
146 #define my_mkdir                Perl_my_mkdir
147 #define my_chdir                Perl_my_chdir
148 #define my_utime                Perl_my_utime
149 #define vms_image_init  Perl_vms_image_init
150 #define readdir         Perl_readdir
151 #define telldir         Perl_telldir
152 #define seekdir         Perl_seekdir
153 #define closedir                Perl_closedir
154 #define vmsreaddirversions      Perl_vmsreaddirversions
155 #define my_gmtime               Perl_my_gmtime
156 #define my_localtime            Perl_my_localtime
157 #define my_time         Perl_my_time
158 #define my_sigemptyset        Perl_my_sigemptyset
159 #define my_sigfillset         Perl_my_sigfillset
160 #define my_sigaddset          Perl_my_sigaddset
161 #define my_sigdelset          Perl_my_sigdelset
162 #define my_sigismember        Perl_my_sigismember
163 #define my_sigprocmask        Perl_my_sigprocmask
164 #define cando_by_name           Perl_cando_by_name
165 #define flex_fstat              Perl_flex_fstat
166 #define flex_stat               Perl_flex_stat
167 #define my_vfork                Perl_my_vfork
168 #define vms_do_aexec            Perl_vms_do_aexec
169 #define vms_do_exec             Perl_vms_do_exec
170 #define do_aspawn               Perl_do_aspawn
171 #define do_spawn                Perl_do_spawn
172 #define my_fwrite               Perl_my_fwrite
173 #define my_flush                Perl_my_flush
174 #define my_getpwnam             Perl_my_getpwnam
175 #define my_getpwuid             Perl_my_getpwuid
176 #define my_getpwent             Perl_my_getpwent
177 #define my_endpwent             Perl_my_endpwent
178 #define my_getlogin             Perl_my_getlogin
179 #define init_os_extras  Perl_init_os_extras
180
181 /* Delete if at all possible, changing protections if necessary. */
182 #define unlink kill_file
183
184 /* 
185  * Intercept calls to fork, so we know whether subsequent calls to
186  * exec should be handled in VMSish or Unixish style.
187  */
188 #define fork my_vfork
189 #ifndef DONT_MASK_RTL_CALLS     /* #defined in vms.c so we see real vfork */
190 #  ifdef vfork
191 #    undef vfork
192 #  endif
193 #  define vfork my_vfork
194 #endif
195
196 /* BIG_TIME:
197  *      This symbol is defined if Time_t is an unsigned type on this system.
198  */
199 #define BIG_TIME
200
201 /* ACME_MESS:
202  *      This symbol, if defined, indicates that error messages should be 
203  *      should be generated in a format that allows the use of the Acme
204  *      GUI/editor's autofind feature.
205  */
206 #undef ACME_MESS        /**/
207
208 /* ALTERNATE_SHEBANG:
209  *      This symbol, if defined, contains a "magic" string which may be used
210  *      as the first line of a Perl program designed to be executed directly
211  *      by name, instead of the standard Unix #!.  If ALTERNATE_SHEBANG
212  *      begins with a character other then #, then Perl will only treat
213  *      it as a command line if if finds the string "perl" in the first
214  *      word; otherwise it's treated as the first line of code in the script.
215  *      (IOW, Perl won't hand off to another interpreter via an alternate
216  *      shebang sequence that might be legal Perl code.)
217  */
218 #define ALTERNATE_SHEBANG "$"
219
220 /* Lower case entry points for these are missing in some earlier RTLs 
221  * so we borrow the defines and declares from errno.h and upcase them.
222  */
223 #if defined(VMS_WE_ARE_CASE_SENSITIVE) && (__DECC_VER < 50500000)
224 #  define errno      (*CMA$TIS_ERRNO_GET_ADDR())
225 #  define vaxc$errno (*CMA$TIS_VMSERRNO_GET_ADDR())
226    int *CMA$TIS_ERRNO_GET_ADDR     (void);   /* UNIX style error code        */
227    int *CMA$TIS_VMSERRNO_GET_ADDR  (void);   /* VMS error (errno == EVMSERR) */
228 #endif
229
230 /* Macros to set errno using the VAX thread-safe calls, if present */
231 #if (defined(__DECC) || defined(__DECCXX)) && !defined(__ALPHA)
232 #  define set_errno(v)      (cma$tis_errno_set_value(v))
233    void cma$tis_errno_set_value(int __value);  /* missing in some errno.h */
234 #  define set_vaxc_errno(v) (vaxc$errno = (v))
235 #else
236 #  define set_errno(v)      (errno = (v))
237 #  define set_vaxc_errno(v) (vaxc$errno = (v))
238 #endif
239
240 /* Support for 'vmsish' behaviors enabled with C<use vmsish> pragma */
241
242 #define COMPLEX_STATUS  1       /* We track both "POSIX" and VMS values */
243
244 #define HINT_V_VMSISH           24
245 #define HINT_M_VMSISH_HUSHED    0x20000000 /* stifle error msgs on exit */
246 #define HINT_M_VMSISH_STATUS    0x40000000 /* system, $? return VMS status */
247 #define HINT_M_VMSISH_TIME      0x80000000 /* times are local, not UTC */
248 #define NATIVE_HINTS            (PL_hints >> HINT_V_VMSISH)  /* used in op.c */
249
250 #define TEST_VMSISH(h)  (PL_curcop->op_private & ((h) >> HINT_V_VMSISH))
251 #define VMSISH_HUSHED   TEST_VMSISH(HINT_M_VMSISH_HUSHED)
252 #define VMSISH_STATUS   TEST_VMSISH(HINT_M_VMSISH_STATUS)
253 #define VMSISH_TIME     TEST_VMSISH(HINT_M_VMSISH_TIME)
254
255 /* Flags for vmstrnenv() */
256 #define PERL__TRNENV_SECURE 0x01
257
258 /* Handy way to vet calls to VMS system services and RTL routines. */
259 #define _ckvmssts(call) STMT_START { register unsigned long int __ckvms_sts; \
260   if (!((__ckvms_sts=(call))&1)) { \
261   set_errno(EVMSERR); set_vaxc_errno(__ckvms_sts); \
262   Perl_croak(aTHX_ "Fatal VMS error (status=%d) at %s, line %d", \
263   __ckvms_sts,__FILE__,__LINE__); } } STMT_END
264
265 /* Same thing, but don't call back to Perl's croak(); useful for errors
266  * occurring during startup, before Perl's state is initialized */
267 #define _ckvmssts_noperl(call) STMT_START { register unsigned long int __ckvms_sts; \
268   if (!((__ckvms_sts=(call))&1)) { \
269   set_errno(EVMSERR); set_vaxc_errno(__ckvms_sts); \
270   fprintf(Perl_debug_log,"Fatal VMS error (status=%d) at %s, line %d", \
271   __ckvms_sts,__FILE__,__LINE__); lib$signal(__ckvms_sts); } } STMT_END
272
273 #ifdef VMS_DO_SOCKETS
274 #include "sockadapt.h"
275 #define PERL_SOCK_SYSREAD_IS_RECV
276 #define PERL_SOCK_SYSWRITE_IS_SEND
277 #endif
278
279 #define BIT_BUCKET "_NLA0:"
280 #define PERL_SYS_INIT(c,v)      vms_image_init((c),(v)); MALLOC_INIT
281 #define PERL_SYS_TERM()         OP_REFCNT_TERM; MALLOC_TERM
282 #define dXSUB_SYS
283 #define HAS_KILL
284 #define HAS_WAIT
285
286 #define PERL_FS_VER_FMT         "%d_%d_%d"
287 /* Temporary; we need to add support for this to Configure.Com */
288 #ifdef PERL_INC_VERSION_LIST
289 #  undef PERL_INC_VERSION_LIST
290 #endif
291
292 /* VMS:
293  *      This symbol, if defined, indicates that the program is running under
294  *      VMS.  It's a symbol automagically defined by all VMS C compilers I've seen.
295  * Just in case, however . . . */
296 #ifndef VMS
297 #define VMS             /**/
298 #endif
299
300 /* HAS_IOCTL:
301  *      This symbol, if defined, indicates that the ioctl() routine is
302  *      available to set I/O characteristics
303  */
304 #undef  HAS_IOCTL               /**/
305  
306 /* HAS_UTIME:
307  *      This symbol, if defined, indicates that the routine utime() is
308  *      available to update the access and modification times of files.
309  */
310 #define HAS_UTIME               /**/
311
312 /* HAS_GROUP
313  *      This symbol, if defined, indicates that the getgrnam() and
314  *      getgrgid() routines are available to get group entries.
315  *      The getgrent() has a separate definition, HAS_GETGRENT.
316  */
317 #undef HAS_GROUP                /**/
318
319 /* HAS_PASSWD
320  *      This symbol, if defined, indicates that the getpwnam() and
321  *      getpwuid() routines are available to get password entries.
322  *      The getpwent() has a separate definition, HAS_GETPWENT.
323  */
324 #define HAS_PASSWD              /**/
325
326 #define HAS_KILL
327 #define HAS_WAIT
328   
329 /* USEMYBINMODE
330  *      This symbol, if defined, indicates that the program should
331  *      use the routine my_binmode(FILE *fp, char iotype, int mode) to insure
332  *      that a file is in "binary" mode -- that is, that no translation
333  *      of bytes occurs on read or write operations.
334  */
335 #undef USEMYBINMODE
336
337 /* Stat_t:
338  *      This symbol holds the type used to declare buffers for information
339  *      returned by stat().  It's usually just struct stat.  It may be necessary
340  *      to include <sys/stat.h> and <sys/types.h> to get any typedef'ed
341  *      information.
342  */
343 /* VMS:
344  * We need this typedef to point to the new type even if DONT_MASK_RTL_CALLS
345  * is in effect, since Perl's thread.h embeds one of these structs in its
346  * thread data struct, and our struct mystat is a different size from the
347  * regular struct stat (cf. note above about having to pad struct to work
348  * around bug in compiler.)
349  * It's OK to pass one of these to the RTL's stat(), though, since the
350  * fields it fills are the same in each struct.
351  */
352 #define Stat_t struct mystat
353
354 /* USE_STAT_RDEV:
355 *       This symbol is defined if this system has a stat structure declaring
356 *       st_rdev
357 *       VMS: Field exists in POSIXish version of struct stat(), but is not used.
358 */
359 #undef USE_STAT_RDEV            /**/
360
361 /*
362  * fwrite1() should be a routine with the same calling sequence as fwrite(),
363  * but which outputs all of the bytes requested as a single stream (unlike
364  * fwrite() itself, which on some systems outputs several distinct records
365  * if the number_of_items parameter is >1).
366  */
367 #define fwrite1 my_fwrite
368
369 /* By default, flush data all the way to disk, not just to RMS buffers */
370 #define Fflush(fp) my_flush(fp)
371
372 /* Use our own rmdir() */
373 #define rmdir(name) do_rmdir(name)
374
375 /* Assorted fiddling with sigs . . . */
376 # include <signal.h>
377 #define ABORT() abort()
378     /* VAXC's signal.h doesn't #define SIG_ERR, but provides BADSIG instead. */
379 #if !defined(SIG_ERR) && defined(BADSIG)
380 #  define SIG_ERR BADSIG
381 #endif
382
383
384 /* Used with our my_utime() routine in vms.c */
385 struct utimbuf {
386   time_t actime;
387   time_t modtime;
388 };
389 #define utime my_utime
390
391 /* This is what times() returns, but <times.h> calls it tbuffer_t on VMS
392  * prior to v7.0.  We check the DECC manifest to see whether it's already
393  * done this for us, relying on the fact that perl.h #includes <time.h>
394  * before it #includes "vmsish.h".
395  */
396
397 #ifndef __TMS
398   struct tms {
399     clock_t tms_utime;    /* user time */
400     clock_t tms_stime;    /* system time - always 0 on VMS */
401     clock_t tms_cutime;   /* user time, children */
402     clock_t tms_cstime;   /* system time, children - always 0 on VMS */
403   };
404 #else
405    /* The new headers change the times() prototype to tms from tbuffer */
406 #  define tbuffer_t struct tms
407 #endif
408
409 /* Substitute our own routines for gmtime(), localtime(), and time(),
410  * which allow us to implement the vmsish 'time' pragma, and work
411  * around absence of system-level UTC support on old versions of VMS.
412  */
413 #define gmtime(t) my_gmtime(t)
414 #define localtime(t) my_localtime(t)
415 #define time(t) my_time(t)
416
417 /* If we're using an older version of VMS whose Unix signal emulation
418  * isn't very POSIXish, then roll our own.
419  */
420 #if __VMS_VER < 70000000 || __DECC_VER < 50200000
421 #  define HOMEGROWN_POSIX_SIGNALS
422 #endif
423 #ifdef HOMEGROWN_POSIX_SIGNALS
424 #  define sigemptyset(t) my_sigemptyset(t)
425 #  define sigfillset(t) my_sigfillset(t)
426 #  define sigaddset(t, u) my_sigaddset(t, u)
427 #  define sigdelset(t, u) my_sigdelset(t, u)
428 #  define sigismember(t, u) my_sigismember(t, u)
429 #  define sigprocmask(t, u, v) my_sigprocmask(t, u, v)
430 #  ifndef _SIGSET_T
431    typedef int sigset_t;
432 #  endif
433    /* The tools for sigprocmask() are there, just not the routine itself */
434 #  ifndef SIG_UNBLOCK
435 #    define SIG_UNBLOCK 1
436 #  endif
437 #  ifndef SIG_BLOCK
438 #    define SIG_BLOCK 2
439 #  endif
440 #  ifndef SIG_SETMASK
441 #    define SIG_SETMASK 3
442 #  endif
443 #  define sigaction sigvec
444 #  define sa_flags sv_onstack
445 #  define sa_handler sv_handler
446 #  define sa_mask sv_mask
447 #  define sigsuspend(set) sigpause(*set)
448 #  define sigpending(a) (not_here("sigpending"),0)
449 #endif
450
451 /* VMS doesn't use a real sys_nerr, but we need this when scanning for error
452  * messages in text strings . . .
453  */
454
455 #define sys_nerr EVMSERR  /* EVMSERR is as high as we can go. */
456
457 /* Look up new %ENV values on the fly */
458 #define DYNAMIC_ENV_FETCH 1
459 #define ENV_HV_NAME "%EnV%VmS%"
460   /* Special getenv function for retrieving %ENV elements. */
461 #define ENVgetenv(v) my_getenv(v,FALSE)
462 #define ENVgetenv_len(v,l) my_getenv_len(v,l,FALSE)
463
464
465 /* Thin jacket around cuserid() tomatch Unix' calling sequence */
466 #define getlogin my_getlogin
467
468 /* Ditto for sys$hash_passwrod() . . . */
469 #define crypt  my_crypt
470
471 /* Tweak arg to mkdir & chdir first, so we can tolerate trailing /. */
472 #define Mkdir(dir,mode) my_mkdir((dir),(mode))
473 #define Chdir(dir) my_chdir((dir))
474
475 /* Use our own stat() clones, which handle Unix-style directory names */
476 #define Stat(name,bufptr) flex_stat(name,bufptr)
477 #define Fstat(fd,bufptr) flex_fstat(fd,bufptr)
478
479 /* Setup for the dirent routines:
480  * opendir(), closedir(), readdir(), seekdir(), telldir(), and
481  * vmsreaddirversions(), and preprocessor stuff on which these depend:
482  *    Written by Rich $alz, <rsalz@bbn.com> in August, 1990.
483  */
484     /* Data structure returned by READDIR(). */
485 struct dirent {
486     char        d_name[256];            /* File name            */
487     int         d_namlen;                       /* Length of d_name */
488     int         vms_verscount;          /* Number of versions   */
489     int         vms_versions[20];       /* Version numbers      */
490 };
491
492     /* Handle returned by opendir(), used by the other routines.  You
493      * are not supposed to care what's inside this structure. */
494 typedef struct _dirdesc {
495     long                        context;
496     int                         vms_wantversions;
497     unsigned long int           count;
498     char                        *pattern;
499     struct dirent               entry;
500     struct dsc$descriptor_s     pat;
501 } DIR;
502
503 #define rewinddir(dirp)         seekdir((dirp), 0)
504
505 /* used for our emulation of getpw* */
506 struct passwd {
507         char    *pw_name;    /* Username */
508         char    *pw_passwd;
509         Uid_t   pw_uid;      /* UIC member number */
510         Gid_t   pw_gid;      /* UIC group  number */
511         char    *pw_comment; /* Default device/directory (Unix-style) */
512         char    *pw_gecos;   /* Owner */
513         char    *pw_dir;     /* Default device/directory (VMS-style) */
514         char    *pw_shell;   /* Default CLI name (eg. DCL) */
515 };
516 #define pw_unixdir pw_comment  /* Default device/directory (Unix-style) */
517 #define getpwnam my_getpwnam
518 #define getpwuid my_getpwuid
519 #define getpwent my_getpwent
520 #define endpwent my_endpwent
521 #define setpwent my_endpwent
522
523 /* Our own stat_t substitute, since we play with st_dev and st_ino -
524  * we want atomic types so Unix-bound code which compares these fields
525  * for two files will work most of the time under VMS.
526  * N.B. 1. The st_ino hack assumes that sizeof(unsigned short[3]) ==
527  * sizeof(unsigned) + sizeof(unsigned short).  We can't use a union type
528  * to map the unsigned int we want and the unsigned short[3] the CRTL
529  * returns into the same member, since gcc has different ideas than DECC
530  * and VAXC about sizing union types.
531  * N.B 2. The routine cando() in vms.c assumes that &stat.st_ino is the
532  * address of a FID.
533  */
534 /* First, grab the system types, so we don't clobber them later */
535 #include <stat.h>
536 /* Since we've got to match the size of the CRTL's stat_t, we need
537  * to mimic DECC's alignment settings.
538  */
539 #if defined(__DECC) || defined(__DECCXX)
540 #  pragma __member_alignment __save
541 #  pragma __nomember_alignment
542 #endif
543 #if defined(__DECC) 
544 #  pragma __message __save
545 #  pragma __message disable (__MISALGNDSTRCT)
546 #  pragma __message disable (__MISALGNDMEM)
547 #endif
548 struct mystat
549 {
550         char *st_devnam;  /* pointer to device name */
551         unsigned st_ino;    /* hack - CRTL uses unsigned short[3] for */
552         unsigned short rvn; /* FID (num,seq,rvn) */
553         unsigned short st_mode; /* file "mode" i.e. prot, dir, reg, etc. */
554         int     st_nlink;       /* for compatibility - not really used */
555         unsigned st_uid;        /* from ACP - QIO uic field */
556         unsigned short st_gid;  /* group number extracted from st_uid */
557         dev_t   st_rdev;        /* for compatibility - always zero */
558         off_t   st_size;        /* file size in bytes */
559         unsigned st_atime;      /* file access time; always same as st_mtime */
560         unsigned st_mtime;      /* last modification time */
561         unsigned st_ctime;      /* file creation time */
562         char    st_fab_rfm;     /* record format */
563         char    st_fab_rat;     /* record attributes */
564         char    st_fab_fsz;     /* fixed header size */
565         unsigned st_dev;        /* encoded device name */
566         /* Pad struct out to integral number of longwords, since DECC 5.6/VAX
567          * has a bug in dealing with offsets in structs in which are embedded
568          * other structs whose size is an odd number of bytes.  (An even
569          * number of bytes is enough to make it happy, but we go for natural
570          * alignment anyhow.)
571          */
572         char    st_fill1[sizeof(void *) - (3*sizeof(unsigned short) + 3*sizeof(char))%sizeof(void *)];
573 };
574 typedef unsigned mydev_t;
575 typedef unsigned myino_t;
576
577 /*
578  * DEC C previous to 6.0 corrupts the behavior of the /prefix
579  * qualifier with the extern prefix pragma.  This provisional
580  * hack circumvents this prefix pragma problem in previous 
581  * precompilers.
582  */
583 #if defined(__VMS_VER) && __VMS_VER >= 70000000
584 #  if defined(VMS_WE_ARE_CASE_SENSITIVE) && (__DECC_VER < 60000000)
585 #    pragma __extern_prefix save
586 #    pragma __extern_prefix ""  /* set to empty to prevent prefixing */
587 #    define geteuid decc$__unix_geteuid
588 #    define getuid decc$__unix_getuid
589 #    define stat(__p1,__p2)   decc$__utc_stat(__p1,__p2)
590 #    define fstat(__p1,__p2)  decc$__utc_fstat(__p1,__p2)
591 #    pragma __extern_prefix restore
592 #  endif
593 #endif
594
595 #ifndef DONT_MASK_RTL_CALLS  /* defined for vms.c so we can see RTL calls */
596 #  ifdef stat
597 #    undef stat
598 #  endif
599 #  define stat mystat
600 #  define dev_t mydev_t
601 #  define ino_t myino_t
602 #endif
603 #if defined(__DECC) || defined(__DECCXX)
604 #  pragma __member_alignment __restore
605 #endif
606 #if defined(__DECC) 
607 #  pragma __message __restore
608 #endif
609 /* Cons up a 'delete' bit for testing access */
610 #define S_IDUSR (S_IWUSR | S_IXUSR)
611 #define S_IDGRP (S_IWGRP | S_IXGRP)
612 #define S_IDOTH (S_IWOTH | S_IXOTH)
613
614
615 /* Prototypes for functions unique to vms.c.  Don't include replacements
616  * for routines in the mainline source files excluded by #ifndef VMS;
617  * their prototypes are already in proto.h.
618  *
619  * In order to keep Gen_ShrFls.Pl happy, functions which are to be made
620  * available to images linked to PerlShr.Exe must be declared between the
621  * __VMS_PROTOTYPES__ and __VMS_SEPYTOTORP__ lines, and must be in the form
622  *    <data type><TAB>name<WHITESPACE>(<prototype args>);
623  */
624
625 #ifdef NO_PERL_TYPEDEFS
626   /* We don't have Perl typedefs available (e.g. when building a2p), so
627      we fake them here.  N.B.  There is *no* guarantee that the faked
628      prototypes will actually match the real routines.  If you want to
629      call Perl routines, include perl.h to get the real typedefs.  */
630 #  ifndef bool
631 #    define bool int
632 #    define __MY_BOOL_TYPE_FAKE
633 #  endif
634 #  ifndef I32
635 #    define I32  int
636 #    define __MY_I32_TYPE_FAKE
637 #  endif
638 #  ifndef SV
639 #    define SV   void   /* Since we only see SV * in prototypes */
640 #    define __MY_SV_TYPE_FAKE
641 #  endif
642 #endif
643
644 void    prime_env_iter (void);
645 void    init_os_extras ();
646 /* prototype section start marker; `typedef' passes through cpp */
647 typedef char  __VMS_PROTOTYPES__;
648 #if !defined(PERL_IMPLICIT_CONTEXT)
649 char *  Perl_my_getenv (const char *, bool);
650 int     Perl_vmstrnenv (const char *, char *, unsigned long int, struct dsc$descriptor_s **, unsigned long int);
651 int     Perl_my_trnlnm (const char *, char *, unsigned long int);
652 char *  Perl_tounixspec (char *, char *);
653 char *  Perl_tounixspec_ts (char *, char *);
654 char *  Perl_tovmsspec (char *, char *);
655 char *  Perl_tovmsspec_ts (char *, char *);
656 char *  Perl_tounixpath (char *, char *);
657 char *  Perl_tounixpath_ts (char *, char *);
658 char *  Perl_tovmspath (char *, char *);
659 char *  Perl_tovmspath_ts (char *, char *);
660 int     Perl_do_rmdir (char *);
661 char *  Perl_fileify_dirspec (char *, char *);
662 char *  Perl_fileify_dirspec_ts (char *, char *);
663 char *  Perl_pathify_dirspec (char *, char *);
664 char *  Perl_pathify_dirspec_ts (char *, char *);
665 char *  Perl_rmsexpand (char *, char *, char *, unsigned);
666 char *  Perl_rmsexpand_ts (char *, char *, char *, unsigned);
667 int     Perl_trim_unixpath (char *, char*, int);
668 DIR *   Perl_opendir (char *);
669 int     Perl_rmscopy (char *, char *, int);
670 #else
671 int     Perl_vmstrnenv (pTHX_ const char *, char *, unsigned long int, struct dsc$descriptor_s **, unsigned long int);
672 char *  Perl_my_getenv (pTHX_ const char *, bool);
673 int     Perl_my_trnlnm (pTHX_ const char *, char *, unsigned long int);
674 char *  Perl_tounixspec (pTHX_ char *, char *);
675 char *  Perl_tounixspec_ts (pTHX_ char *, char *);
676 char *  Perl_tovmsspec (pTHX_ char *, char *);
677 char *  Perl_tovmsspec_ts (pTHX_ char *, char *);
678 char *  Perl_tounixpath (pTHX_ char *, char *);
679 char *  Perl_tounixpath_ts (pTHX_ char *, char *);
680 char *  Perl_tovmspath (pTHX_ char *, char *);
681 char *  Perl_tovmspath_ts (pTHX_ char *, char *);
682 int     Perl_do_rmdir (pTHX_ char *);
683 char *  Perl_fileify_dirspec (pTHX_ char *, char *);
684 char *  Perl_fileify_dirspec_ts (pTHX_ char *, char *);
685 char *  Perl_pathify_dirspec (pTHX_ char *, char *);
686 char *  Perl_pathify_dirspec_ts (pTHX_ char *, char *);
687 char *  Perl_rmsexpand (pTHX_ char *, char *, char *, unsigned);
688 char *  Perl_rmsexpand_ts (pTHX_ char *, char *, char *, unsigned);
689 int     Perl_trim_unixpath (pTHX_ char *, char*, int);
690 DIR *   Perl_opendir (pTHX_ char *);
691 int     Perl_rmscopy (pTHX_ char *, char *, int);
692 #endif
693 char *  my_getenv_len (const char *, unsigned long *, bool);
694 int     vmssetenv (char *, char *, struct dsc$descriptor_s **);
695 char *  my_crypt (const char *, const char *);
696 Pid_t   my_waitpid (Pid_t, int *, int);
697 char *  my_gconvert (double, int, int, char *);
698 int     kill_file (char *);
699 int     my_mkdir (char *, Mode_t);
700 int     my_chdir (char *);
701 int     my_utime (char *, struct utimbuf *);
702 void    vms_image_init (int *, char ***);
703 struct dirent * readdir (DIR *);
704 long    telldir (DIR *);
705 void    seekdir (DIR *, long);
706 void    closedir (DIR *);
707 void    vmsreaddirversions (DIR *, int);
708 struct tm *     my_gmtime (const time_t *);
709 struct tm *     my_localtime (const time_t *);
710 time_t  my_time (time_t *);
711 #ifdef HOMEGROWN_POSIX_SIGNALS
712 int     my_sigemptyset (sigset_t *);
713 int     my_sigfillset  (sigset_t *);
714 int     my_sigaddset   (sigset_t *, int);
715 int     my_sigdelset   (sigset_t *, int);
716 int     my_sigismember (sigset_t *, int);
717 int     my_sigprocmask (int, sigset_t *, sigset_t *);
718 #endif
719 I32     cando_by_name (I32, Uid_t, char *);
720 int     flex_fstat (int, Stat_t *);
721 int     flex_stat (const char *, Stat_t *);
722 int     my_vfork ();
723 bool    vms_do_aexec (SV *, SV **, SV **);
724 bool    vms_do_exec (char *);
725 unsigned long int       do_aspawn (void *, void **, void **);
726 unsigned long int       do_spawn (char *);
727 int     my_fwrite (void *, size_t, size_t, FILE *);
728 int     my_flush (FILE *);
729 struct passwd * my_getpwnam (char *name);
730 struct passwd * my_getpwuid (Uid_t uid);
731 struct passwd * my_getpwent ();
732 void    my_endpwent ();
733 char *  my_getlogin ();
734 typedef char __VMS_SEPYTOTORP__;
735 /* prototype section end marker; `typedef' passes through cpp */
736
737 #ifdef NO_PERL_TYPEDEFS  /* We'll try not to scramble later files */
738 #  ifdef __MY_BOOL_TYPE_FAKE
739 #    undef bool
740 #    undef __MY_BOOL_TYPE_FAKE
741 #  endif
742 #  ifdef __MY_I32_TYPE_FAKE
743 #    undef I32
744 #    undef __MY_I32_TYPE_FAKE
745 #  endif
746 #  ifdef __MY_SV_TYPE_FAKE
747 #    undef SV
748 #    undef __MY_SV_TYPE_FAKE
749 #  endif
750 #endif
751
752 #ifndef VMS_DO_SOCKETS
753 /* This relies on tricks in perl.h to pick up that these manifest constants
754  * are undefined and set up conversion routines.  It will then redefine
755  * these manifest constants, so the actual values will match config.h
756  */
757 #undef HAS_HTONS
758 #undef HAS_NTOHS
759 #undef HAS_HTONL
760 #undef HAS_NTOHL
761 #endif
762
763 /* The C RTL manual says to undef the macro for DEC C 5.2 and lower. */
764 #if defined(fileno) && defined(__DECC_VER) && __DECC_VER < 50300000
765 #  undef fileno 
766 #endif 
767
768 #endif  /* __vmsish_h_included */