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