This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
a0ea93a283d8dd774224e1356bde89cc3d22ed12
[perl5.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
238 /* Delete if at all possible, changing protections if necessary. */
239 #define unlink kill_file
240
241 /* 
242  * Intercept calls to fork, so we know whether subsequent calls to
243  * exec should be handled in VMSish or Unixish style.
244  */
245 #define fork my_vfork
246 #ifndef DONT_MASK_RTL_CALLS     /* #defined in vms.c so we see real vfork */
247 #  ifdef vfork
248 #    undef vfork
249 #  endif
250 #  define vfork my_vfork
251 #endif
252
253 /*
254  * Toss in a shim to tmpfile which creates a plain temp file if the
255  * RMS tmp mechanism won't work (e.g. if someone is relying on ACLs
256  * from a specific directory to permit creation of files).
257  */
258 #ifndef DONT_MASK_RTL_CALLS
259 #  define tmpfile Perl_my_tmpfile
260 #endif
261
262
263 /* BIG_TIME:
264  *      This symbol is defined if Time_t is an unsigned type on this system.
265  */
266 #define BIG_TIME
267
268 /* ACME_MESS:
269  *      This symbol, if defined, indicates that error messages should be 
270  *      should be generated in a format that allows the use of the Acme
271  *      GUI/editor's autofind feature.
272  */
273 #undef ACME_MESS        /**/
274
275 /* ALTERNATE_SHEBANG:
276  *      This symbol, if defined, contains a "magic" string which may be used
277  *      as the first line of a Perl program designed to be executed directly
278  *      by name, instead of the standard Unix #!.  If ALTERNATE_SHEBANG
279  *      begins with a character other then #, then Perl will only treat
280  *      it as a command line if if finds the string "perl" in the first
281  *      word; otherwise it's treated as the first line of code in the script.
282  *      (IOW, Perl won't hand off to another interpreter via an alternate
283  *      shebang sequence that might be legal Perl code.)
284  */
285 #define ALTERNATE_SHEBANG "$"
286
287 /* Lower case entry points for these are missing in some earlier RTLs 
288  * so we borrow the defines and declares from errno.h and upcase them.
289  */
290 #if defined(VMS_WE_ARE_CASE_SENSITIVE) && (__DECC_VER < 50500000)
291 #  define errno      (*CMA$TIS_ERRNO_GET_ADDR())
292 #  define vaxc$errno (*CMA$TIS_VMSERRNO_GET_ADDR())
293    int *CMA$TIS_ERRNO_GET_ADDR     (void);   /* UNIX style error code        */
294    int *CMA$TIS_VMSERRNO_GET_ADDR  (void);   /* VMS error (errno == EVMSERR) */
295 #endif
296
297 /* Macros to set errno using the VAX thread-safe calls, if present */
298 #if (defined(__DECC) || defined(__DECCXX)) && !defined(__ALPHA)
299 #  define set_errno(v)      (cma$tis_errno_set_value(v))
300    void cma$tis_errno_set_value(int __value);  /* missing in some errno.h */
301 #  define set_vaxc_errno(v) (vaxc$errno = (v))
302 #else
303 #  define set_errno(v)      (errno = (v))
304 #  define set_vaxc_errno(v) (vaxc$errno = (v))
305 #endif
306
307 /* Support for 'vmsish' behaviors enabled with C<use vmsish> pragma */
308
309 #define COMPLEX_STATUS  1       /* We track both "POSIX" and VMS values */
310
311 #define HINT_V_VMSISH           24
312 #define HINT_M_VMSISH_STATUS    0x40000000 /* system, $? return VMS status */
313 #define HINT_M_VMSISH_TIME      0x80000000 /* times are local, not UTC */
314 #define NATIVE_HINTS            (PL_hints >> HINT_V_VMSISH)  /* used in op.c */
315
316 #define TEST_VMSISH(h)  (PL_curcop->op_private & ((h) >> HINT_V_VMSISH))
317 #define VMSISH_STATUS   TEST_VMSISH(HINT_M_VMSISH_STATUS)
318 #define VMSISH_TIME     TEST_VMSISH(HINT_M_VMSISH_TIME)
319
320 /* VMS-specific data storage */
321
322 #define HAVE_INTERP_INTERN
323 struct interp_intern {
324     int    hushed;
325     int    posix_exit;
326     double inv_rand_max;
327 };
328 #define VMSISH_HUSHED     (PL_sys_intern.hushed)
329 #define MY_INV_RAND_MAX   (PL_sys_intern.inv_rand_max)
330 #define MY_POSIX_EXIT   (PL_sys_intern.posix_exit)
331
332 /* Flags for vmstrnenv() */
333 #define PERL__TRNENV_SECURE 0x01
334 #define PERL__TRNENV_JOIN_SEARCHLIST 0x02
335
336 /* Handy way to vet calls to VMS system services and RTL routines. */
337 #define _ckvmssts(call) STMT_START { register unsigned long int __ckvms_sts; \
338   if (!((__ckvms_sts=(call))&1)) { \
339   set_errno(EVMSERR); set_vaxc_errno(__ckvms_sts); \
340   Perl_croak(aTHX_ "Fatal VMS error (status=%d) at %s, line %d", \
341   __ckvms_sts,__FILE__,__LINE__); } } STMT_END
342
343 /* Same thing, but don't call back to Perl's croak(); useful for errors
344  * occurring during startup, before Perl's state is initialized */
345 #define _ckvmssts_noperl(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   fprintf(stderr,"Fatal VMS error (status=%d) at %s, line %d", \
349   __ckvms_sts,__FILE__,__LINE__); lib$signal(__ckvms_sts); } } STMT_END
350
351 #ifdef VMS_DO_SOCKETS
352 #include "sockadapt.h"
353 #define PERL_SOCK_SYSREAD_IS_RECV
354 #define PERL_SOCK_SYSWRITE_IS_SEND
355 #endif
356
357 #if __CRTL_VER < 70000000
358 #define BIT_BUCKET "_NLA0:"
359 #else
360 #define BIT_BUCKET "/dev/null"
361 #endif
362 #define PERL_SYS_INIT(c,v)      MALLOC_CHECK_TAINT2(*c,*v) vms_image_init((c),(v)); MALLOC_INIT
363 #define PERL_SYS_TERM()         OP_REFCNT_TERM; MALLOC_TERM
364 #define dXSUB_SYS
365 #define HAS_KILL
366 #define HAS_WAIT
367
368 #define PERL_FS_VER_FMT         "%d_%d_%d"
369 /* Temporary; we need to add support for this to Configure.Com */
370 #ifdef PERL_INC_VERSION_LIST
371 #  undef PERL_INC_VERSION_LIST
372 #endif
373
374 /* VMS:
375  *      This symbol, if defined, indicates that the program is running under
376  *      VMS.  It's a symbol automagically defined by all VMS C compilers I've seen.
377  * Just in case, however . . . */
378 /* Note that code really should be using __VMS to comply with ANSI */
379 #ifndef VMS
380 #define VMS             /**/
381 #endif
382
383 /* HAS_IOCTL:
384  *      This symbol, if defined, indicates that the ioctl() routine is
385  *      available to set I/O characteristics
386  */
387 #if defined(__CRTL_VER) && __CRTL_VER >= 70000000
388 #define HAS_IOCTL               /**/
389 #else
390 #undef  HAS_IOCTL               /**/
391 #endif
392  
393 /* HAS_UTIME:
394  *      This symbol, if defined, indicates that the routine utime() is
395  *      available to update the access and modification times of files.
396  */
397 #define HAS_UTIME               /**/
398
399 /* HAS_GROUP
400  *      This symbol, if defined, indicates that the getgrnam() and
401  *      getgrgid() routines are available to get group entries.
402  *      The getgrent() has a separate definition, HAS_GETGRENT.
403  */
404 #undef HAS_GROUP                /**/
405
406 /* HAS_PASSWD
407  *      This symbol, if defined, indicates that the getpwnam() and
408  *      getpwuid() routines are available to get password entries.
409  *      The getpwent() has a separate definition, HAS_GETPWENT.
410  */
411 #define HAS_PASSWD              /**/
412
413 #define HAS_KILL
414 #define HAS_WAIT
415   
416 /* USEMYBINMODE
417  *      This symbol, if defined, indicates that the program should
418  *      use the routine my_binmode(FILE *fp, char iotype, int mode) to insure
419  *      that a file is in "binary" mode -- that is, that no translation
420  *      of bytes occurs on read or write operations.
421  */
422 #undef USEMYBINMODE
423
424 /* Stat_t:
425  *      This symbol holds the type used to declare buffers for information
426  *      returned by stat().  It's usually just struct stat.  It may be necessary
427  *      to include <sys/stat.h> and <sys/types.h> to get any typedef'ed
428  *      information.
429  */
430 /* VMS:
431  * We need this typedef to point to the new type even if DONT_MASK_RTL_CALLS
432  * is in effect, since Perl's thread.h embeds one of these structs in its
433  * thread data struct, and our struct mystat is a different size from the
434  * regular struct stat (cf. note above about having to pad struct to work
435  * around bug in compiler.)
436  * It's OK to pass one of these to the RTL's stat(), though, since the
437  * fields it fills are the same in each struct.
438  */
439 #define Stat_t struct mystat
440
441 /* USE_STAT_RDEV:
442 *       This symbol is defined if this system has a stat structure declaring
443 *       st_rdev
444 *       VMS: Field exists in POSIXish version of struct stat(), but is not used.
445 *
446 *  No definition of what value an operating system or file system should
447 *  put in the st_rdev field has been found by me so far.  Examination of
448 *  LINUX source code indicates that the value is both very platform and
449 *  file system specific, with many filesystems just putting 1 or 0 in it.
450 *  J. Malmberg.
451 */
452 #undef USE_STAT_RDEV            /**/
453
454 /*
455  * fwrite1() should be a routine with the same calling sequence as fwrite(),
456  * but which outputs all of the bytes requested as a single stream (unlike
457  * fwrite() itself, which on some systems outputs several distinct records
458  * if the number_of_items parameter is >1).
459  */
460 #define fwrite1 my_fwrite
461
462
463 #ifndef DONT_MASK_RTL_CALLS
464 #  define fwrite my_fwrite     /* for PerlSIO_fwrite */
465 #  define fdopen my_fdopen
466 #  define fclose my_fclose
467 #endif
468
469
470 /* By default, flush data all the way to disk, not just to RMS buffers */
471 #define Fflush(fp) my_flush(fp)
472
473 /* Use our own rmdir() */
474 #ifndef DONT_MASK_RTL_CALLS
475 #define rmdir(name) do_rmdir(name)
476 #endif
477
478 /* Assorted fiddling with sigs . . . */
479 # include <signal.h>
480 #define ABORT() abort()
481
482 /* Used with our my_utime() routine in vms.c */
483 struct utimbuf {
484   time_t actime;
485   time_t modtime;
486 };
487 #define utime my_utime
488
489 /* This is what times() returns, but <times.h> calls it tbuffer_t on VMS
490  * prior to v7.0.  We check the DECC manifest to see whether it's already
491  * done this for us, relying on the fact that perl.h #includes <time.h>
492  * before it #includes "vmsish.h".
493  */
494
495 #ifndef __TMS
496   struct tms {
497     clock_t tms_utime;    /* user time */
498     clock_t tms_stime;    /* system time - always 0 on VMS */
499     clock_t tms_cutime;   /* user time, children */
500     clock_t tms_cstime;   /* system time, children - always 0 on VMS */
501   };
502 #else
503    /* The new headers change the times() prototype to tms from tbuffer */
504 #  define tbuffer_t struct tms
505 #endif
506
507 /* Substitute our own routines for gmtime(), localtime(), and time(),
508  * which allow us to implement the vmsish 'time' pragma, and work
509  * around absence of system-level UTC support on old versions of VMS.
510  */
511 #define gmtime(t) my_gmtime(t)
512 #define localtime(t) my_localtime(t)
513 #define time(t) my_time(t)
514
515 /* If we're using an older version of VMS whose Unix signal emulation
516  * isn't very POSIXish, then roll our own.
517  */
518 #if __VMS_VER < 70000000 || __DECC_VER < 50200000
519 #  define HOMEGROWN_POSIX_SIGNALS
520 #endif
521 #ifdef HOMEGROWN_POSIX_SIGNALS
522 #  define sigemptyset(t) my_sigemptyset(t)
523 #  define sigfillset(t) my_sigfillset(t)
524 #  define sigaddset(t, u) my_sigaddset(t, u)
525 #  define sigdelset(t, u) my_sigdelset(t, u)
526 #  define sigismember(t, u) my_sigismember(t, u)
527 #  define sigprocmask(t, u, v) my_sigprocmask(t, u, v)
528 #  ifndef _SIGSET_T
529    typedef int sigset_t;
530 #  endif
531    /* The tools for sigprocmask() are there, just not the routine itself */
532 #  ifndef SIG_UNBLOCK
533 #    define SIG_UNBLOCK 1
534 #  endif
535 #  ifndef SIG_BLOCK
536 #    define SIG_BLOCK 2
537 #  endif
538 #  ifndef SIG_SETMASK
539 #    define SIG_SETMASK 3
540 #  endif
541 #  define sigaction sigvec
542 #  define sa_flags sv_onstack
543 #  define sa_handler sv_handler
544 #  define sa_mask sv_mask
545 #  define sigsuspend(set) sigpause(*set)
546 #  define sigpending(a) (not_here("sigpending"),0)
547 #else
548 /*
549  * The C RTL's sigaction fails to check for invalid signal numbers so we 
550  * help it out a bit.
551  */
552 #  ifndef DONT_MASK_RTL_CALLS
553 #    define sigaction(a,b,c) Perl_my_sigaction(aTHX_ a,b,c)
554 #  endif
555 #endif
556 #ifdef KILL_BY_SIGPRC
557 #  define kill  Perl_my_kill
558 #endif
559
560
561 /* VMS doesn't use a real sys_nerr, but we need this when scanning for error
562  * messages in text strings . . .
563  */
564
565 #define sys_nerr EVMSERR  /* EVMSERR is as high as we can go. */
566
567 /* Look up new %ENV values on the fly */
568 #define DYNAMIC_ENV_FETCH 1
569   /* Special getenv function for retrieving %ENV elements. */
570 #define ENVgetenv(v) my_getenv(v,FALSE)
571 #define ENVgetenv_len(v,l) my_getenv_len(v,l,FALSE)
572
573
574 /* Thin jacket around cuserid() to match Unix' calling sequence */
575 #define getlogin my_getlogin
576
577 /* Ditto for sys$hash_password() . . . */
578 #define crypt(a,b)  Perl_my_crypt(aTHX_ a,b)
579
580 /* Tweak arg to mkdir & chdir first, so we can tolerate trailing /. */
581 #define Mkdir(dir,mode) Perl_my_mkdir(aTHX_ (dir),(mode))
582 #define Chdir(dir) my_chdir((dir))
583
584 /* Use our own stat() clones, which handle Unix-style directory names */
585 #define Stat(name,bufptr) flex_stat(name,bufptr)
586 #define Fstat(fd,bufptr) Perl_flex_fstat(aTHX_ fd,bufptr)
587 #ifndef DONT_MASK_RTL_CALLS
588 #define lstat(name, bufptr) Perl_flex_lstat(name, bufptr)
589 #endif
590
591 /* Setup for the dirent routines:
592  * opendir(), closedir(), readdir(), seekdir(), telldir(), and
593  * vmsreaddirversions(), and preprocessor stuff on which these depend:
594  *    Written by Rich $alz, <rsalz@bbn.com> in August, 1990.
595  *
596  * Feb 2005 - POSIX filespecs need real opendir() structures.
597  *            rename to remove conflicts.  J. Malmberg (HP OpenVMS)
598  */
599
600     /* Data structure returned by READDIR(). */
601 struct my_dirent {
602     char        d_name[256];            /* File name            */
603 #   if defined _XOPEN_SOURCE || !defined _POSIX_C_SOURCE
604 #if !_USE_STD_STAT
605         /* 3 word array */
606         __ino_t d_ino[3];           /*  file serial number (vms-style inode) */
607         unsigned short fill;
608 #else   /* quadword */
609         __ino_t d_ino;
610 #endif
611     int         d_namlen;               /* Length of d_name */
612     int         vms_verscount;          /* Number of versions   */
613     int         vms_versions[20];       /* Version numbers      */
614 };
615
616     /* Handle returned by opendir(), used by the other routines.  You
617      * are not supposed to care what's inside this structure. */
618 typedef struct my_dirdesc {
619 #if __CRTL_VER >= 80200000 && !defined(__VAX)
620     int                         flags;
621     DIR                         *vms_dirdesc;
622 #endif
623     long                        context;
624     int                         vms_wantversions;
625     unsigned long int           count;
626     char                        *pattern;
627     struct my_dirent            entry;
628     struct dsc$descriptor_s     pat;
629     void                        *mutex;
630 } MY_DIR;
631
632
633 #ifndef DONT_MASK_RTL_CALLS
634 #define DIR MY_DIR
635 #define dirent my_dirent
636 #define rewinddir(dirp)         seekdir((dirp), 0)
637 #endif
638
639 /* used for our emulation of getpw* */
640 struct passwd {
641         char    *pw_name;    /* Username */
642         char    *pw_passwd;
643         Uid_t   pw_uid;      /* UIC member number */
644         Gid_t   pw_gid;      /* UIC group  number */
645         char    *pw_comment; /* Default device/directory (Unix-style) */
646         char    *pw_gecos;   /* Owner */
647         char    *pw_dir;     /* Default device/directory (VMS-style) */
648         char    *pw_shell;   /* Default CLI name (eg. DCL) */
649 };
650 #define pw_unixdir pw_comment  /* Default device/directory (Unix-style) */
651 #define getpwnam my_getpwnam
652 #define getpwuid my_getpwuid
653 #define getpwent my_getpwent
654 #define endpwent my_endpwent
655 #define setpwent my_endpwent
656
657 /* Our own stat_t substitute, since we play with st_dev and st_ino -
658  * we want atomic types so Unix-bound code which compares these fields
659  * for two files will work most of the time under VMS.
660  * N.B. 1. The st_ino hack assumes that sizeof(unsigned short[3]) ==
661  * sizeof(unsigned) + sizeof(unsigned short).  We can't use a union type
662  * to map the unsigned int we want and the unsigned short[3] the CRTL
663  * returns into the same member, since gcc has different ideas than DECC
664  * and VAXC about sizing union types.
665  * N.B. 2. The routine cando() in vms.c assumes that &stat.st_ino is the
666  * address of a FID.
667  */
668 /* First, grab the system types, so we don't clobber them later */
669 #include <stat.h>
670 /* Since we've got to match the size of the CRTL's stat_t, we need
671  * to mimic DECC's alignment settings.
672  *
673  * The simplest thing is to just put a wrapper around the stat structure
674  * supplied by the CRTL and use #defines to redirect references to the
675  * members to the real names.
676  */
677
678 #if defined(__DECC) || defined(__DECCXX)
679 #  pragma __member_alignment __save
680 #  pragma member_alignment
681 #endif
682
683 typedef unsigned mydev_t;
684 #ifndef _LARGEFILE
685 typedef unsigned myino_t;
686 #else
687 typedef __ino64_t myino_t;
688 #endif
689
690 struct mystat
691 {
692     struct stat crtl_stat;
693     myino_t st_ino;
694 #ifndef _LARGEFILE
695     unsigned rvn; /* FID (num,seq,rvn) + pad */
696 #endif
697     mydev_t st_dev;
698     char st_devnam[256]; /* Cache the (short) VMS name */
699 };
700
701 #define st_mode crtl_stat.st_mode
702 #define st_nlink crtl_stat.st_nlink
703 #define st_uid crtl_stat.st_uid
704 #define st_gid crtl_stat.st_gid
705 #define st_rdev crtl_stat.st_rdev
706 #define st_size crtl_stat.st_size
707 #define st_atime crtl_stat.st_atime
708 #define st_mtime crtl_stat.st_mtime
709 #define st_ctime crtl_stat.st_ctime
710 #define st_fab_rfm crtl_stat.st_fab_rfm
711 #define st_fab_rat crtl_stat.st_fab_rat
712 #define st_fab_fsz crtl_stat.st_fab_fsz
713 #define st_fab_mrs crtl_stat_st_fab_mrs
714
715 #endif /* defined(USE_LARGE_FILES) */
716
717 #if defined(__DECC) || defined(__DECCXX)
718 #  pragma __member_alignment __restore
719 #endif
720
721 /*
722  * DEC C previous to 6.0 corrupts the behavior of the /prefix
723  * qualifier with the extern prefix pragma.  This provisional
724  * hack circumvents this prefix pragma problem in previous 
725  * precompilers.
726  */
727 #if defined(__VMS_VER) && __VMS_VER >= 70000000
728 #  if defined(VMS_WE_ARE_CASE_SENSITIVE) && (__DECC_VER < 60000000)
729 #    pragma __extern_prefix save
730 #    pragma __extern_prefix ""  /* set to empty to prevent prefixing */
731 #    define geteuid decc$__unix_geteuid
732 #    define getuid decc$__unix_getuid
733 #    define stat(__p1,__p2)   decc$__utc_stat(__p1,__p2)
734 #    define fstat(__p1,__p2)  decc$__utc_fstat(__p1,__p2)
735 #    pragma __extern_prefix restore
736 #  endif
737 #endif
738
739 #ifndef DONT_MASK_RTL_CALLS  /* defined for vms.c so we can see RTL calls */
740 #  ifdef stat
741 #    undef stat
742 #  endif
743 #  define stat mystat
744 #  define dev_t mydev_t
745 #  define ino_t myino_t
746 #endif
747 /* Cons up a 'delete' bit for testing access */
748 #define S_IDUSR (S_IWUSR | S_IXUSR)
749 #define S_IDGRP (S_IWGRP | S_IXGRP)
750 #define S_IDOTH (S_IWOTH | S_IXOTH)
751
752
753 /* Prototypes for functions unique to vms.c.  Don't include replacements
754  * for routines in the mainline source files excluded by #ifndef VMS;
755  * their prototypes are already in proto.h.
756  *
757  * In order to keep Gen_ShrFls.Pl happy, functions which are to be made
758  * available to images linked to PerlShr.Exe must be declared between the
759  * __VMS_PROTOTYPES__ and __VMS_SEPYTOTORP__ lines, and must be in the form
760  *    <data type><TAB>name<WHITESPACE>(<prototype args>);
761  */
762
763 #ifdef NO_PERL_TYPEDEFS
764   /* We don't have Perl typedefs available (e.g. when building a2p), so
765      we fake them here.  N.B.  There is *no* guarantee that the faked
766      prototypes will actually match the real routines.  If you want to
767      call Perl routines, include perl.h to get the real typedefs.  */
768 #  ifndef bool
769 #    define bool int
770 #    define __MY_BOOL_TYPE_FAKE
771 #  endif
772 #  ifndef I32
773 #    define I32  int
774 #    define __MY_I32_TYPE_FAKE
775 #  endif
776 #  ifndef SV
777 #    define SV   void   /* Since we only see SV * in prototypes */
778 #    define __MY_SV_TYPE_FAKE
779 #  endif
780 #endif
781
782 void    prime_env_iter (void);
783 void    init_os_extras (void);
784 int     Perl_vms_status_to_unix(int vms_status, int child_flag);
785 int     Perl_unix_status_to_vms(int unix_status);
786 /* prototype section start marker; `typedef' passes through cpp */
787 typedef char  __VMS_PROTOTYPES__;
788 int     Perl_vmstrnenv (const char *, char *, unsigned long int, struct dsc$descriptor_s **, unsigned long int);
789 char *  Perl_vms_realpath (pTHX_ const char *, char *);
790 #if !defined(PERL_IMPLICIT_CONTEXT)
791 int     Perl_vms_case_tolerant(void);
792 char *  Perl_my_getenv (const char *, bool);
793 int     Perl_my_trnlnm (const char *, char *, unsigned long int);
794 char *  Perl_tounixspec (const char *, char *);
795 char *  Perl_tounixspec_ts (const char *, char *);
796 char *  Perl_tovmsspec (const char *, char *);
797 char *  Perl_tovmsspec_ts (const char *, char *);
798 char *  Perl_tounixpath (const char *, char *);
799 char *  Perl_tounixpath_ts (const char *, char *);
800 char *  Perl_tovmspath (const char *, char *);
801 char *  Perl_tovmspath_ts (const char *, char *);
802 int     Perl_do_rmdir (const char *);
803 char *  Perl_fileify_dirspec (const char *, char *);
804 char *  Perl_fileify_dirspec_ts (const char *, char *);
805 char *  Perl_pathify_dirspec (const char *, char *);
806 char *  Perl_pathify_dirspec_ts (const char *, char *);
807 char *  Perl_rmsexpand (const char *, char *, const char *, unsigned);
808 char *  Perl_rmsexpand_ts (const char *, char *, const char *, unsigned);
809 int     Perl_trim_unixpath (char *, const char*, int);
810 MY_DIR  * Perl_opendir (const char *);
811 int     Perl_rmscopy (const char *, const char *, int);
812 int     Perl_my_mkdir (const char *, Mode_t);
813 bool    Perl_vms_do_aexec (SV *, SV **, SV **);
814 #else
815 char *  Perl_my_getenv (pTHX_ const char *, bool);
816 int     Perl_my_trnlnm (pTHX_ const char *, char *, unsigned long int);
817 char *  Perl_tounixspec (pTHX_ const char *, char *);
818 char *  Perl_tounixspec_ts (pTHX_ const char *, char *);
819 char *  Perl_tovmsspec (pTHX_ const char *, char *);
820 char *  Perl_tovmsspec_ts (pTHX_ const char *, char *);
821 char *  Perl_tounixpath (pTHX_ const char *, char *);
822 char *  Perl_tounixpath_ts (pTHX_ const char *, char *);
823 char *  Perl_tovmspath (pTHX_ const char *, char *);
824 char *  Perl_tovmspath_ts (pTHX_ const char *, char *);
825 int     Perl_do_rmdir (pTHX_ const char *);
826 char *  Perl_fileify_dirspec (pTHX_ const char *, char *);
827 char *  Perl_fileify_dirspec_ts (pTHX_ const char *, char *);
828 char *  Perl_pathify_dirspec (pTHX_ const char *, char *);
829 char *  Perl_pathify_dirspec_ts (pTHX_ const char *, char *);
830 char *  Perl_rmsexpand (pTHX_ const char *, char *, const char *, unsigned);
831 char *  Perl_rmsexpand_ts (pTHX_ const char *, char *, const char *, unsigned);
832 int     Perl_trim_unixpath (pTHX_ char *, const char*, int);
833 MY_DIR * Perl_opendir (pTHX_ const char *);
834 int     Perl_rmscopy (pTHX_ const char *, const char *, int);
835 int     Perl_my_mkdir (pTHX_ const char *, Mode_t);
836 bool    Perl_vms_do_aexec (pTHX_ SV *, SV **, SV **);
837 #endif
838 int     Perl_vms_case_tolerant(void);
839 char *  Perl_my_getenv_len (pTHX_ const char *, unsigned long *, bool);
840 int     Perl_vmssetenv (pTHX_ const char *, const char *, struct dsc$descriptor_s **);
841 void    Perl_vmssetuserlnm(pTHX_ const char *name, const char *eqv);
842 char *  Perl_my_crypt (pTHX_ const char *, const char *);
843 Pid_t   Perl_my_waitpid (pTHX_ Pid_t, int *, int);
844 char *  my_gconvert (double, int, int, char *);
845 int     Perl_kill_file (pTHX_ const char *);
846 int     Perl_my_chdir (pTHX_ const char *);
847 FILE *  Perl_my_tmpfile (void);
848 #ifndef HOMEGROWN_POSIX_SIGNALS
849 int     Perl_my_sigaction (pTHX_ int, const struct sigaction*, struct sigaction*);
850 #endif
851 #ifdef KILL_BY_SIGPRC
852 unsigned int    Perl_sig_to_vmscondition (int);
853 int     Perl_my_kill (int, int);
854 void    Perl_csighandler_init (void);
855 #endif
856 int     Perl_my_utime (pTHX_ const char *, const struct utimbuf *);
857 void    Perl_vms_image_init (int *, char ***);
858 struct my_dirent *      Perl_readdir (pTHX_ MY_DIR *);
859 int     Perl_readdir_r(pTHX_ MY_DIR *, struct my_dirent *, struct my_dirent **);
860 long    Perl_telldir (MY_DIR *);
861 void    Perl_seekdir (pTHX_ MY_DIR *, long);
862 void    Perl_closedir (MY_DIR *);
863 void    vmsreaddirversions (MY_DIR *, int);
864 struct tm *     Perl_my_gmtime (pTHX_ const time_t *);
865 struct tm *     Perl_my_localtime (pTHX_ const time_t *);
866 time_t  Perl_my_time (pTHX_ time_t *);
867 #ifdef HOMEGROWN_POSIX_SIGNALS
868 int     my_sigemptyset (sigset_t *);
869 int     my_sigfillset  (sigset_t *);
870 int     my_sigaddset   (sigset_t *, int);
871 int     my_sigdelset   (sigset_t *, int);
872 int     my_sigismember (sigset_t *, int);
873 int     my_sigprocmask (int, sigset_t *, sigset_t *);
874 #endif
875 I32     Perl_cando_by_name (pTHX_ I32, Uid_t, const char *);
876 int     Perl_flex_fstat (pTHX_ int, Stat_t *);
877 int     Perl_flex_lstat (pTHX_ const char *, Stat_t *);
878 int     Perl_flex_stat (pTHX_ const char *, Stat_t *);
879 int     my_vfork (void);
880 bool    Perl_vms_do_exec (pTHX_ const char *);
881 unsigned long int       Perl_do_aspawn (pTHX_ void *, void **, void **);
882 unsigned long int       Perl_do_spawn (pTHX_ const char *);
883 FILE *  my_fdopen (int, const char *);
884 int     my_fclose (FILE *);
885 int    my_fwrite (const void *, size_t, size_t, FILE *);
886 int     Perl_my_flush (pTHX_ FILE *);
887 struct passwd * Perl_my_getpwnam (pTHX_ const char *name);
888 struct passwd * Perl_my_getpwuid (pTHX_ Uid_t uid);
889 void    Perl_my_endpwent (pTHX);
890 char *  my_getlogin (void);
891 typedef char __VMS_SEPYTOTORP__;
892 /* prototype section end marker; `typedef' passes through cpp */
893
894 #ifdef NO_PERL_TYPEDEFS  /* We'll try not to scramble later files */
895 #  ifdef __MY_BOOL_TYPE_FAKE
896 #    undef bool
897 #    undef __MY_BOOL_TYPE_FAKE
898 #  endif
899 #  ifdef __MY_I32_TYPE_FAKE
900 #    undef I32
901 #    undef __MY_I32_TYPE_FAKE
902 #  endif
903 #  ifdef __MY_SV_TYPE_FAKE
904 #    undef SV
905 #    undef __MY_SV_TYPE_FAKE
906 #  endif
907 #endif
908
909 #ifndef VMS_DO_SOCKETS
910 /* This relies on tricks in perl.h to pick up that these manifest constants
911  * are undefined and set up conversion routines.  It will then redefine
912  * these manifest constants, so the actual values will match config.h
913  */
914 #undef HAS_HTONS
915 #undef HAS_NTOHS
916 #undef HAS_HTONL
917 #undef HAS_NTOHL
918 #endif
919
920 /* The C RTL manual says to undef the macro for DEC C 5.2 and lower. */
921 #if defined(fileno) && defined(__DECC_VER) && __DECC_VER < 50300000
922 #  undef fileno 
923 #endif 
924
925 #define NO_ENVIRON_ARRAY
926
927 /* RMSEXPAND options */
928 #define PERL_RMSEXPAND_M_VMS            0x02 /* Force output to VMS format */
929 #define PERL_RMSEXPAND_M_LONG           0x04 /* Expand to long name format */
930 #define PERL_RMSEXPAND_M_SYMLINK        0x20 /* Use symbolic link, not target */
931
932 #endif  /* __vmsish_h_included */