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