Documentation fix
[perl.git] / vms / vmsish.h
1 /*    vmsish.h
2  *
3  *    VMS-specific C header file for perl5.
4  *
5  *    Copyright (C) 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001,
6  *    2002, 2003, 2004, 2005, 2006, 2007 by Charles Bailey and others.
7  *
8  *    You may distribute under the terms of either the GNU General Public
9  *    License or the Artistic License, as specified in the README file.
10  *
11  *    Please see Changes*.* or the Perl Repository Browser for revision history.
12  */
13
14 #ifndef __vmsish_h_included
15 #define __vmsish_h_included
16
17 #include <descrip.h> /* for dirent struct definitions */
18 #include <libdef.h>  /* status codes for various places */
19 #include <rmsdef.h>  /* at which errno and vaxc$errno are */
20 #include <ssdef.h>   /* explicitly set in the perl source code */
21 #include <stsdef.h>  /* bitmasks for exit status testing */
22
23 /* Suppress compiler warnings from DECC for VMS-specific extensions:
24  * ADDRCONSTEXT,NEEDCONSTEXT: initialization of data with non-constant values
25  *                            (e.g. pointer fields of descriptors)
26  */
27 #if defined(__DECC) || defined(__DECCXX)
28 #  pragma message disable (ADDRCONSTEXT,NEEDCONSTEXT)
29 #endif
30
31 /* DEC's C compilers and gcc use incompatible definitions of _to(upp|low)er() */
32 #ifdef _toupper
33 #  undef _toupper
34 #endif
35 #define _toupper(c) (((c) < 'a' || (c) > 'z') ? (c) : (c) & ~040)
36 #ifdef _tolower
37 #  undef _tolower
38 #endif
39 #define _tolower(c) (((c) < 'A' || (c) > 'Z') ? (c) : (c) | 040)
40 /* DECC 1.3 has a funny definition of abs; it's fixed in DECC 4.0, so this
41  * can go away once DECC 1.3 isn't in use any more. */
42 #if defined(__ALPHA) && (defined(__DECC) || defined(__DECCXX))
43 #undef abs
44 #define abs(__x)        __ABS(__x)
45 #undef labs
46 #define labs(__x)        __LABS(__x)
47 #endif /* __ALPHA && __DECC */
48
49 /* Assorted things to look like Unix */
50 #ifdef __GNUC__
51 #ifndef _IOLBF /* gcc's stdio.h doesn't define this */
52 #define _IOLBF 1
53 #endif
54 #endif
55 #include <processes.h> /* for vfork() */
56 #include <unixio.h>
57 #include <unixlib.h>
58 #include <file.h>  /* it's not <sys/file.h>, so don't use I_SYS_FILE */
59 #if (defined(__DECC) && defined(__DECC_VER) && __DECC_VER > 20000000) || defined(__DECCXX)
60 #  include <unistd.h> /* DECC has this; gcc doesn't */
61 #endif
62
63 #ifdef NO_PERL_TYPEDEFS /* a2p; we don't want Perl's special routines */
64 #  define DONT_MASK_RTL_CALLS
65 #endif
66
67 #include <namdef.h>
68
69 /* Set the maximum filespec size here as it is larger for EFS file
70  * specifications.
71  */
72 #ifndef __VAX
73 #ifndef VMS_MAXRSS
74 #ifdef NAML$C_MAXRSS
75 #define VMS_MAXRSS (NAML$C_MAXRSS+1)
76 #ifndef VMS_LONGNAME_SUPPORT
77 #define VMS_LONGNAME_SUPPORT 1
78 #endif /* VMS_LONGNAME_SUPPORT */
79 #endif /* NAML$C_MAXRSS */
80 #endif /* VMS_MAXRSS */
81 #endif
82
83 #ifndef VMS_MAXRSS
84 #define VMS_MAXRSS (NAM$C_MAXRSS + 1)
85 #endif
86
87 #ifndef MAXPATHLEN
88 #define MAXPATHLEN (VMS_MAXRSS - 1)
89 #endif
90
91
92 /* Note that we do, in fact, have this */
93 #define HAS_GETENV_SV
94 #define HAS_GETENV_LEN
95
96 /* All this stiff is for the x2P programs. Hopefully they'll still work */
97 #if defined(PERL_FOR_X2P)
98 #ifndef aTHX_
99 #define aTHX_
100 #endif
101 #ifndef pTHX_
102 #define pTHX_
103 #endif
104 #ifndef pTHX
105 #define pTHX
106 #endif
107 #endif
108
109 #ifndef DONT_MASK_RTL_CALLS
110 #  ifdef getenv
111 #    undef getenv
112 #  endif
113   /* getenv used for regular logical names */
114 #  define getenv(v) Perl_my_getenv(aTHX_ v,TRUE)
115 #endif
116 #ifdef getenv_len
117 #  undef getenv_len
118 #endif
119 #define getenv_len(v,l) Perl_my_getenv_len(aTHX_ v,l,TRUE)
120
121 /* DECC introduces this routine in the RTL as of VMS 7.0; for now,
122  * we'll use ours, since it gives us the full VMS exit status. */
123 #define waitpid my_waitpid
124
125 /* Don't redeclare standard RTL routines in Perl's header files;
126  * VMS history or extensions makes some of the formal protoypes
127  * differ from the common Unix forms.
128  */
129 #define DONT_DECLARE_STD 1
130
131 /* Our own contribution to PerlShr's global symbols . . . */
132
133 #if !defined(PERL_IMPLICIT_CONTEXT)
134 #define opendir                 Perl_opendir
135 #define rename                  Perl_rename
136 #define seekdir                 Perl_seekdir
137 #define readdir                 Perl_readdir
138 #define readdir_r               Perl_readdir_r
139 #else
140 #define opendir(a)              Perl_opendir(aTHX_ a)
141 #define rename(a,b)             Perl_rename(aTHX_ a,b)
142 #define seekdir(a,b)            Perl_seekdir(aTHX_ a,b)
143 #define readdir(a)              Perl_readdir(aTHX_ a)
144 #define readdir_r(a,b,c)        Perl_readdir_r(aTHX_ a,b,c)
145 #endif
146 #define closedir(a)             Perl_closedir(a)
147 #define telldir(a)              Perl_telldir(a)
148 #define vmsreaddirversions(a,b) Perl_vmsreaddirversions(a,b)
149
150 #define cando_by_name(a,b,c)            Perl_cando_by_name(aTHX_ a,b,c)
151 #define do_rmdir(a)                     Perl_do_rmdir(aTHX_ a)
152 #define fileify_dirspec(a,b)            Perl_fileify_dirspec(aTHX_ a,b)
153 #define fileify_dirspec(a,b)            Perl_fileify_dirspec(aTHX_ a,b)
154 #define fileify_dirspec_ts(a,b)         Perl_fileify_dirspec_ts(aTHX_ a,b)
155 #define fileify_dirspec_ts(a,b)         Perl_fileify_dirspec_ts(aTHX_ a,b)
156 #define fileify_dirspec_utf8(a,b,c)     Perl_fileify_dirspec(aTHX_ a,b,utf8)
157 #define fileify_dirspec_utf8_ts(a,b,c)  Perl_fileify_dirspec_ts(aTHX_ a,b,utf8)
158 #define flex_fstat(a,b)                 Perl_flex_fstat(aTHX_ a,b)
159 #define flex_lstat(a,b)                 Perl_flex_lstat(aTHX_ a,b)
160 #define flex_stat(a,b)                  Perl_flex_stat(aTHX_ a,b)
161 #define init_os_extras                  Perl_init_os_extras
162 #define kill_file(a)                    Perl_kill_file(aTHX_ a)
163 #define my_chdir(a)                     Perl_my_chdir(aTHX_ a)
164 #define my_chmod(a,b)                   Perl_my_chmod(aTHX_ a,b)
165 #define my_crypt(a,b)                   Perl_my_crypt(aTHX_ a,b)
166 #define my_endpwent()                   Perl_my_endpwent(aTHX)
167 #define my_fclose(a)                    Perl_my_fclose(a)
168 #define my_fdopen(a,b)                  Perl_my_fdopen(a,b)
169 #define my_flush(a)                     Perl_my_flush(aTHX_ a)
170 #define my_fwrite(a,b,c,d)              Perl_my_fwrite(a,b,c,d)
171 #define my_fgetname(a,b)                Perl_my_fgetname(a,b)
172 #define my_gconvert(a,b,c,d)            Perl_my_gconvert(a,b,c,d)
173 #define my_getenv(a,b)                  Perl_my_getenv(aTHX_ a,b)
174 #define my_getenv_len(a,b,c)            Perl_my_getenv_len(aTHX_ a,b,c)
175 #define my_getlogin                     Perl_my_getlogin
176 #define my_getpwent()                   Perl_my_getpwent(aTHX)
177 #define my_getpwnam(a)                  Perl_my_getpwnam(aTHX_ a)
178 #define my_getpwuid(a)                  Perl_my_getpwuid(aTHX_ a)
179 #define my_gmtime(a)                    Perl_my_gmtime(aTHX_ a)
180 #define my_localtime(a)                 Perl_my_localtime(aTHX_ a)
181 #define my_mkdir(a,b)                   Perl_my_mkdir(aTHX_ a,b)
182 #define my_sigemptyset(a)               Perl_my_sigemptyset(a)
183 #define my_sigfillset(a)                Perl_my_sigfillset(a)
184 #define my_sigaddset(a,b)               Perl_my_sigaddset(a,b)
185 #define my_sigdelset(a,b,c)             Perl_my_sigdelset(a,b,c)
186 #define my_sigismember(a,b)             Perl_my_sigismember(a,b)
187 #define my_sigprocmask(a,b,c)           Perl_my_sigprocmask(a,b,c)
188 #ifdef HAS_SYMLINK
189 #  define my_symlink(a,b)               Perl_my_symlink(aTHX_ a,b)
190 #endif
191 #define my_time(a)                      Perl_my_time(aTHX_ a)
192 #define my_tmpfile                      Perl_my_tmpfile
193 #define my_trnlnm(a,b,c)                Perl_my_trnlnm(aTHX_ a,b,c)
194 #define my_utime(a,b)                   Perl_my_utime(aTHX_ a,b)
195 #define my_vfork                        Perl_my_vfork
196 #define my_waitpid(a,b,c)               Perl_my_waitpid(aTHX_ a,b,c)
197 #define pathify_dirspec(a,b)            Perl_pathify_dirspec(aTHX a,b)
198 #define pathify_dirspec_ts(a,b)         Perl_pathify_dirspec_ts(aTHX a,b)
199 #define pathify_dirspec_utf8(a,b,c)     Perl_pathify_dirspec_utf8(aTHX a,b,c)
200 #define pathify_dirspec_utf8_ts(a,b,c)  Perl_pathify_dirspec_utf8_ts(aTHX a,b,c)
201 #define prime_env_iter                  Perl_prime_env_iter
202 #define rmscopy(a,b,c)                  Perl_rmscopy(aTHX_ a,b,c)
203 #define rmsexpand(a,b,c,d)              Perl_rmsexpand_utf8(aTHX_ a,b,c,d,NULL,NULL)
204 #define rmsexpand_ts(a,b,c,d)           Perl_rmsexpand_utf8_ts(aTHX_ a,b,c,d,NULL,NULL)
205 #define rmsexpand_utf8(a,b,c,d,e,f)     Perl_rmsexpand_utf8(aTHX_ a,b,c,d,e,f)
206 #define rmsexpand_utf8_ts(a,b,c,d,e,f)  Perl_rmsexpand_utf8_ts(aTHX_ a,b,c,d,e,f)
207 #define tounixpath(a,b)                 Perl_tounixpath_utf8(aTHX_ a,b,NULL)
208 #define tounixpath_ts(a,b)              Perl_tounixpath_utf8_ts(aTHX_ a,b,NULL)
209 #define tounixpath_utf8(a,b,c)          Perl_tounixpath_utf8(aTHX_ a,b,c)
210 #define tounixpath_utf8_ts(a,b,c)       Perl_tounixpath_utf8_ts(aTHX_ a,b,c)
211 #define tounixspec(a,b)                 Perl_tounixspec_utf8(aTHX_ a,b,NULL)
212 #define tounixspec_ts(a,b)              Perl_tounixspec_utf8_ts(aTHX_ a,b,NULL)
213 #define tounixspec_utf8(a,b,c)          Perl_tounixspec_utf8(aTHX_ a,b,c)
214 #define tounixspec_utf8_ts(a,b,c)       Perl_tounixspec_utf8_ts(aTHX_ a,b,c)
215 #define tovmspath(a,b)                  Perl_tovmspath_utf8(aTHX_ a,b,NULL)
216 #define tovmspath_ts(a,b)               Perl_tovmspath_utf8_ts(aTHX_ a,b,NULL)
217 #define tovmspath_utf8(a,b,c)           Perl_tovmspath_utf8(aTHX_ a,b,c)
218 #define tovmspath_utf8_ts(a,b,c)        Perl_tovmspath_utf8_ts(aTHX_ a,b,c)
219 #define tovmsspec(a,b)                  Perl_tovmsspec_utf8(aTHX_ a,b,NULL)
220 #define tovmsspec_ts(a,b)               Perl_tovmsspec_utf8_ts(aTHX_ a,b)
221 #define tovmsspec_utf8(a,b,c)           Perl_tovmsspec_utf8(aTHX_ a,b,c)
222 #define tovmsspec_utf8_ts(a,b,c)        Perl_tovmsspec_utf8_ts(aTHX_ a,b,c)
223 #define trim_unixpath(a,b,c)            Perl_trim_unixpath(aTHX_ a,b,c)
224 #define vms_do_aexec(a,b,c)             Perl_vms_do_aexec(aTHX_ a,b,c)
225 #define vms_do_exec(a)                  Perl_vms_do_exec(aTHX_ a)
226 #define vms_case_tolerant(a)            Perl_vms_case_tolerant(a)
227 #define vms_image_init(a,b)             Perl_vms_image_init(a,b)
228 #define vms_realname(a,b,c)             Perl_vms_realname(aTHX_ a,b,c)
229 #define vms_realpath(a,b,c)             Perl_vms_realpath(aTHX_ a,b,c)
230 #define vmssetenv(a,b,c)                Perl_vmssetenv(aTHX_ a,b,c)
231 #define vmstrnenv(a,b,c,d,e)            Perl_vmstrnenv(a,b,c,d,e)
232
233 /* Delete if at all possible, changing protections if necessary. */
234 #define unlink(a) kill_file(a)
235
236 /* 
237  * Intercept calls to fork, so we know whether subsequent calls to
238  * exec should be handled in VMSish or Unixish style.
239  */
240 #define fork my_vfork
241 #ifndef DONT_MASK_RTL_CALLS     /* #defined in vms.c so we see real vfork */
242 #  ifdef vfork
243 #    undef vfork
244 #  endif
245 #  define vfork my_vfork
246 #endif
247
248 /*
249  * Toss in a shim to tmpfile which creates a plain temp file if the
250  * RMS tmp mechanism won't work (e.g. if someone is relying on ACLs
251  * from a specific directory to permit creation of files).
252  */
253 #ifndef DONT_MASK_RTL_CALLS
254 #  define tmpfile Perl_my_tmpfile
255 #endif
256
257
258 /* BIG_TIME:
259  *      This symbol is defined if Time_t is an unsigned type on this system.
260  */
261 #define BIG_TIME
262
263 /* ACME_MESS:
264  *      This symbol, if defined, indicates that error messages should be 
265  *      should be generated in a format that allows the use of the Acme
266  *      GUI/editor's autofind feature.
267  */
268 #undef ACME_MESS        /**/
269
270 /* ALTERNATE_SHEBANG:
271  *      This symbol, if defined, contains a "magic" string which may be used
272  *      as the first line of a Perl program designed to be executed directly
273  *      by name, instead of the standard Unix #!.  If ALTERNATE_SHEBANG
274  *      begins with a character other then #, then Perl will only treat
275  *      it as a command line if if finds the string "perl" in the first
276  *      word; otherwise it's treated as the first line of code in the script.
277  *      (IOW, Perl won't hand off to another interpreter via an alternate
278  *      shebang sequence that might be legal Perl code.)
279  */
280 #define ALTERNATE_SHEBANG "$"
281
282 /* Lower case entry points for these are missing in some earlier RTLs 
283  * so we borrow the defines and declares from errno.h and upcase them.
284  */
285 #if defined(VMS_WE_ARE_CASE_SENSITIVE) && (__DECC_VER < 50500000)
286 #  define errno      (*CMA$TIS_ERRNO_GET_ADDR())
287 #  define vaxc$errno (*CMA$TIS_VMSERRNO_GET_ADDR())
288    int *CMA$TIS_ERRNO_GET_ADDR     (void);   /* UNIX style error code        */
289    int *CMA$TIS_VMSERRNO_GET_ADDR  (void);   /* VMS error (errno == EVMSERR) */
290 #endif
291
292 /* Macros to set errno using the VAX thread-safe calls, if present */
293 #if (defined(__DECC) || defined(__DECCXX)) && !defined(__ALPHA)
294 #  define set_errno(v)      (cma$tis_errno_set_value(v))
295    void cma$tis_errno_set_value(int __value);  /* missing in some errno.h */
296 #  define set_vaxc_errno(v) (vaxc$errno = (v))
297 #else
298 #  define set_errno(v)      (errno = (v))
299 #  define set_vaxc_errno(v) (vaxc$errno = (v))
300 #endif
301
302 /* Support for 'vmsish' behaviors enabled with C<use vmsish> pragma */
303
304 #define COMPLEX_STATUS  1       /* We track both "POSIX" and VMS values */
305
306 #define HINT_V_VMSISH           24
307 #define HINT_M_VMSISH_STATUS    0x40000000 /* system, $? return VMS status */
308 #define HINT_M_VMSISH_TIME      0x80000000 /* times are local, not UTC */
309 #define NATIVE_HINTS            (PL_hints >> HINT_V_VMSISH)  /* used in op.c */
310
311 #ifdef PERL_IMPLICIT_CONTEXT
312 #  define TEST_VMSISH(h)        (my_perl && PL_curcop && (PL_curcop->op_private & ((h) >> HINT_V_VMSISH)))
313 #else
314 #  define TEST_VMSISH(h)        (PL_curcop && (PL_curcop->op_private & ((h) >> HINT_V_VMSISH)))
315 #endif
316 #define VMSISH_STATUS   TEST_VMSISH(HINT_M_VMSISH_STATUS)
317 #define VMSISH_TIME     TEST_VMSISH(HINT_M_VMSISH_TIME)
318
319 /* VMS-specific data storage */
320
321 #define HAVE_INTERP_INTERN
322 struct interp_intern {
323     int    hushed;
324     int    posix_exit;
325     double inv_rand_max;
326 };
327 #define VMSISH_HUSHED     (PL_sys_intern.hushed)
328 #define MY_INV_RAND_MAX   (PL_sys_intern.inv_rand_max)
329 #define MY_POSIX_EXIT   (PL_sys_intern.posix_exit)
330
331 /* Flags for vmstrnenv() */
332 #define PERL__TRNENV_SECURE 0x01
333 #define PERL__TRNENV_JOIN_SEARCHLIST 0x02
334
335 /* Handy way to vet calls to VMS system services and RTL routines. */
336 #define _ckvmssts(call) STMT_START { register unsigned long int __ckvms_sts; \
337   if (!((__ckvms_sts=(call))&1)) { \
338   set_errno(EVMSERR); set_vaxc_errno(__ckvms_sts); \
339   Perl_croak(aTHX_ "Fatal VMS error (status=%d) at %s, line %d", \
340   __ckvms_sts,__FILE__,__LINE__); } } STMT_END
341
342 /* Same thing, but don't call back to Perl's croak(); useful for errors
343  * occurring during startup, before Perl's state is initialized */
344 #define _ckvmssts_noperl(call) STMT_START { register unsigned long int __ckvms_sts; \
345   if (!((__ckvms_sts=(call))&1)) { \
346   set_errno(EVMSERR); set_vaxc_errno(__ckvms_sts); \
347   fprintf(stderr,"Fatal VMS error (status=%d) at %s, line %d", \
348   __ckvms_sts,__FILE__,__LINE__); lib$signal(__ckvms_sts); } } STMT_END
349
350 #ifdef VMS_DO_SOCKETS
351 #include "sockadapt.h"
352 #define PERL_SOCK_SYSREAD_IS_RECV
353 #define PERL_SOCK_SYSWRITE_IS_SEND
354 #endif
355
356 #if __CRTL_VER < 70000000
357 #define BIT_BUCKET "_NLA0:"
358 #else
359 #define BIT_BUCKET "/dev/null"
360 #endif
361 #define PERL_SYS_INIT_BODY(c,v) MALLOC_CHECK_TAINT2(*c,*v) vms_image_init((c),(v)); PERLIO_INIT; MALLOC_INIT
362 #define PERL_SYS_TERM_BODY()            HINTS_REFCNT_TERM; OP_REFCNT_TERM; PERLIO_TERM; MALLOC_TERM
363 #define dXSUB_SYS
364 #define HAS_KILL
365 #define HAS_WAIT
366
367 #ifndef PERL_CORE
368 #  define PERL_FS_VER_FMT       "%d_%d_%d"
369 #endif
370 #define PERL_FS_VERSION         STRINGIFY(PERL_REVISION) "_" \
371                                 STRINGIFY(PERL_VERSION) "_" \
372                                 STRINGIFY(PERL_SUBVERSION)
373 /* Temporary; we need to add support for this to Configure.Com */
374 #ifdef PERL_INC_VERSION_LIST
375 #  undef PERL_INC_VERSION_LIST
376 #endif
377
378 /* VMS:
379  *      This symbol, if defined, indicates that the program is running under
380  *      VMS.  It's a symbol automagically defined by all VMS C compilers I've seen.
381  * Just in case, however . . . */
382 /* Note that code really should be using __VMS to comply with ANSI */
383 #ifndef VMS
384 #define VMS             /**/
385 #endif
386
387 /* HAS_IOCTL:
388  *      This symbol, if defined, indicates that the ioctl() routine is
389  *      available to set I/O characteristics
390  */
391 #if defined(__CRTL_VER) && __CRTL_VER >= 70000000
392 #define HAS_IOCTL               /**/
393 #else
394 #undef  HAS_IOCTL               /**/
395 #endif
396  
397 /* HAS_UTIME:
398  *      This symbol, if defined, indicates that the routine utime() is
399  *      available to update the access and modification times of files.
400  */
401 #define HAS_UTIME               /**/
402
403 /* HAS_GROUP
404  *      This symbol, if defined, indicates that the getgrnam() and
405  *      getgrgid() routines are available to get group entries.
406  *      The getgrent() has a separate definition, HAS_GETGRENT.
407  */
408 #if __CRTL_VER >= 70302000
409 #define HAS_GROUP               /**/
410 #else
411 #undef HAS_GROUP                /**/
412 #endif
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 #  define fgetname(a, b) my_fgetname(a, b)
476 #ifdef HAS_SYMLINK
477 #  define symlink my_symlink
478 #endif
479 #endif
480
481
482 /* By default, flush data all the way to disk, not just to RMS buffers */
483 #define Fflush(fp) my_flush(fp)
484
485 /* Use our own rmdir() */
486 #ifndef DONT_MASK_RTL_CALLS
487 #define rmdir(name) do_rmdir(name)
488 #endif
489
490 /* Assorted fiddling with sigs . . . */
491 # include <signal.h>
492 #define ABORT() abort()
493
494 #ifdef I_UTIME
495 #include <utime.h>
496 #else
497 /* Used with our my_utime() routine in vms.c */
498 struct utimbuf {
499   time_t actime;
500   time_t modtime;
501 };
502 #endif
503 #ifndef DONT_MASK_RTL_CALLS
504 #define utime my_utime
505 #endif
506
507 /* This is what times() returns, but <times.h> calls it tbuffer_t on VMS
508  * prior to v7.0.  We check the DECC manifest to see whether it's already
509  * done this for us, relying on the fact that perl.h #includes <time.h>
510  * before it #includes "vmsish.h".
511  */
512
513 #ifndef __TMS
514   struct tms {
515     clock_t tms_utime;    /* user time */
516     clock_t tms_stime;    /* system time - always 0 on VMS */
517     clock_t tms_cutime;   /* user time, children */
518     clock_t tms_cstime;   /* system time, children - always 0 on VMS */
519   };
520 #else
521    /* The new headers change the times() prototype to tms from tbuffer */
522 #  define tbuffer_t struct tms
523 #endif
524
525 /* Substitute our own routines for gmtime(), localtime(), and time(),
526  * which allow us to implement the vmsish 'time' pragma, and work
527  * around absence of system-level UTC support on old versions of VMS.
528  */
529 #define gmtime(t) my_gmtime(t)
530 #define localtime(t) my_localtime(t)
531 #define time(t) my_time(t)
532
533 /* If we're using an older version of VMS whose Unix signal emulation
534  * isn't very POSIXish, then roll our own.
535  */
536 #if __VMS_VER < 70000000 || __DECC_VER < 50200000
537 #  define HOMEGROWN_POSIX_SIGNALS
538 #endif
539 #ifdef HOMEGROWN_POSIX_SIGNALS
540 #  define sigemptyset(t) my_sigemptyset(t)
541 #  define sigfillset(t) my_sigfillset(t)
542 #  define sigaddset(t, u) my_sigaddset(t, u)
543 #  define sigdelset(t, u) my_sigdelset(t, u)
544 #  define sigismember(t, u) my_sigismember(t, u)
545 #  define sigprocmask(t, u, v) my_sigprocmask(t, u, v)
546 #  ifndef _SIGSET_T
547    typedef int sigset_t;
548 #  endif
549    /* The tools for sigprocmask() are there, just not the routine itself */
550 #  ifndef SIG_UNBLOCK
551 #    define SIG_UNBLOCK 1
552 #  endif
553 #  ifndef SIG_BLOCK
554 #    define SIG_BLOCK 2
555 #  endif
556 #  ifndef SIG_SETMASK
557 #    define SIG_SETMASK 3
558 #  endif
559 #  define sigaction sigvec
560 #  define sa_flags sv_onstack
561 #  define sa_handler sv_handler
562 #  define sa_mask sv_mask
563 #  define sigsuspend(set) sigpause(*set)
564 #  define sigpending(a) (not_here("sigpending"),0)
565 #else
566 /*
567  * The C RTL's sigaction fails to check for invalid signal numbers so we 
568  * help it out a bit.
569  */
570 #  ifndef DONT_MASK_RTL_CALLS
571 #    define sigaction(a,b,c) Perl_my_sigaction(aTHX_ a,b,c)
572 #  endif
573 #endif
574 #ifdef KILL_BY_SIGPRC
575 #  define kill  Perl_my_kill
576 #endif
577
578
579 /* VMS doesn't use a real sys_nerr, but we need this when scanning for error
580  * messages in text strings . . .
581  */
582
583 #define sys_nerr EVMSERR  /* EVMSERR is as high as we can go. */
584
585 /* Look up new %ENV values on the fly */
586 #define DYNAMIC_ENV_FETCH 1
587   /* Special getenv function for retrieving %ENV elements. */
588 #define ENVgetenv(v) my_getenv(v,FALSE)
589 #define ENVgetenv_len(v,l) my_getenv_len(v,l,FALSE)
590
591
592 /* Thin jacket around cuserid() to match Unix' calling sequence */
593 #define getlogin my_getlogin
594
595 /* Ditto for sys$hash_password() . . . */
596 #define crypt(a,b)  Perl_my_crypt(aTHX_ a,b)
597
598 /* Tweak arg to mkdir & chdir first, so we can tolerate trailing /. */
599 #define Mkdir(dir,mode) Perl_my_mkdir(aTHX_ (dir),(mode))
600 #define Chdir(dir) my_chdir((dir))
601 #ifndef DONT_MASK_RTL_CALLS
602 #define chmod(file_spec, mode) my_chmod((file_spec), (mode))
603 #endif
604
605 /* Use our own stat() clones, which handle Unix-style directory names */
606 #define Stat(name,bufptr) flex_stat(name,bufptr)
607 #define Fstat(fd,bufptr) Perl_flex_fstat(aTHX_ fd,bufptr)
608 #ifndef DONT_MASK_RTL_CALLS
609 #define lstat(name, bufptr) flex_lstat(name, bufptr)
610 #endif
611
612 /* Setup for the dirent routines:
613  * opendir(), closedir(), readdir(), seekdir(), telldir(), and
614  * vmsreaddirversions(), and preprocessor stuff on which these depend:
615  *    Written by Rich $alz, <rsalz@bbn.com> in August, 1990.
616  *
617  */
618
619 /* Flags for the _dirdesc structure */
620 #define PERL_VMSDIR_M_VERSIONS          0x02 /* Want VMS versions */
621 #define PERL_VMSDIR_M_UNIXSPECS         0x04 /* Want UNIX specifications */
622
623
624     /* Data structure returned by READDIR(). */
625 struct dirent {
626     char        d_name[256];            /* File name            */
627     int         d_namlen;               /* Length of d_name */
628     int         vms_verscount;          /* Number of versions   */
629     int         vms_versions[20];       /* Version numbers      */
630 };
631
632     /* Handle returned by opendir(), used by the other routines.  You
633      * are not supposed to care what's inside this structure. */
634 typedef struct _dirdesc {
635     long                        context;
636     int                         flags;
637     unsigned long int           count;
638     char                        *pattern;
639     struct dirent               entry;
640     struct dsc$descriptor_s     pat;
641     void                        *mutex;
642 } DIR;
643
644
645 #define rewinddir(dirp)         seekdir((dirp), 0)
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 #ifdef _USE_STD_STAT
724 #define VMS_INO_T_COMPARE(__a, __b) (__a != __b)
725 #define VMS_INO_T_COPY(__a, __b) __a = __b
726 #else
727 #define VMS_INO_T_COMPARE(__a, __b) memcmp(&__a, &__b, 6)
728 #define VMS_INO_T_COPY(__a, __b) memcpy(&__a, &__b, 6)
729 #endif
730
731 #if defined(__DECC) || defined(__DECCXX)
732 #  pragma __member_alignment __restore
733 #endif
734
735 /*
736  * DEC C previous to 6.0 corrupts the behavior of the /prefix
737  * qualifier with the extern prefix pragma.  This provisional
738  * hack circumvents this prefix pragma problem in previous 
739  * precompilers.
740  */
741 #if defined(__VMS_VER) && __VMS_VER >= 70000000
742 #  if defined(VMS_WE_ARE_CASE_SENSITIVE) && (__DECC_VER < 60000000)
743 #    pragma __extern_prefix save
744 #    pragma __extern_prefix ""  /* set to empty to prevent prefixing */
745 #    define geteuid decc$__unix_geteuid
746 #    define getuid decc$__unix_getuid
747 #    define stat(__p1,__p2)   decc$__utc_stat(__p1,__p2)
748 #    define fstat(__p1,__p2)  decc$__utc_fstat(__p1,__p2)
749 #    pragma __extern_prefix restore
750 #  endif
751 #endif
752
753 #ifndef DONT_MASK_RTL_CALLS  /* defined for vms.c so we can see RTL calls */
754 #  ifdef stat
755 #    undef stat
756 #  endif
757 #  define stat mystat
758 #  define dev_t mydev_t
759 #  define ino_t myino_t
760 #endif
761 /* Cons up a 'delete' bit for testing access */
762 #define S_IDUSR (S_IWUSR | S_IXUSR)
763 #define S_IDGRP (S_IWGRP | S_IXGRP)
764 #define S_IDOTH (S_IWOTH | S_IXOTH)
765
766
767 /* Prototypes for functions unique to vms.c.  Don't include replacements
768  * for routines in the mainline source files excluded by #ifndef VMS;
769  * their prototypes are already in proto.h.
770  *
771  * In order to keep Gen_ShrFls.Pl happy, functions which are to be made
772  * available to images linked to PerlShr.Exe must be declared between the
773  * __VMS_PROTOTYPES__ and __VMS_SEPYTOTORP__ lines, and must be in the form
774  *    <data type><TAB>name<WHITESPACE>(<prototype args>);
775  */
776
777 #ifdef NO_PERL_TYPEDEFS
778   /* We don't have Perl typedefs available (e.g. when building a2p), so
779      we fake them here.  N.B.  There is *no* guarantee that the faked
780      prototypes will actually match the real routines.  If you want to
781      call Perl routines, include perl.h to get the real typedefs.  */
782 #  ifndef bool
783 #    define bool int
784 #    define __MY_BOOL_TYPE_FAKE
785 #  endif
786 #  ifndef I32
787 #    define I32  int
788 #    define __MY_I32_TYPE_FAKE
789 #  endif
790 #  ifndef SV
791 #    define SV   void   /* Since we only see SV * in prototypes */
792 #    define __MY_SV_TYPE_FAKE
793 #  endif
794 #endif
795
796 void    prime_env_iter (void);
797 void    init_os_extras (void);
798 int     Perl_vms_status_to_unix(int vms_status, int child_flag);
799 int     Perl_unix_status_to_vms(int unix_status);
800 /* prototype section start marker; `typedef' passes through cpp */
801 typedef char  __VMS_PROTOTYPES__;
802 int     Perl_vmstrnenv (const char *, char *, unsigned long int, struct dsc$descriptor_s **, unsigned long int);
803 char *  Perl_vms_realpath (pTHX_ const char *, char *, int *);
804 char *  Perl_my_getenv (pTHX_ const char *, bool);
805 int     Perl_my_trnlnm (pTHX_ const char *, char *, unsigned long int);
806 char *  Perl_tounixspec (pTHX_ const char *, char *);
807 char *  Perl_tounixspec_ts (pTHX_ const char *, char *);
808 char *  Perl_tounixspec_utf8 (pTHX_ const char *, char *, int *);
809 char *  Perl_tounixspec_utf8_ts (pTHX_ const char *, char *, int *);
810 char *  Perl_tovmsspec (pTHX_ const char *, char *);
811 char *  Perl_tovmsspec_ts (pTHX_ const char *, char *);
812 char *  Perl_tovmsspec_utf8 (pTHX_ const char *, char *, int *);
813 char *  Perl_tovmsspec_utf8_ts (pTHX_ const char *, char *, int *);
814 char *  Perl_tounixpath (pTHX_ const char *, char *);
815 char *  Perl_tounixpath_ts (pTHX_ const char *, char *);
816 char *  Perl_tounixpath_utf8 (pTHX_ const char *, char *, int *);
817 char *  Perl_tounixpath_utf8_ts (pTHX_ const char *, char *, int *);
818 char *  Perl_tovmspath (pTHX_ const char *, char *);
819 char *  Perl_tovmspath_ts (pTHX_ const char *, char *);
820 char *  Perl_tovmspath_utf8 (pTHX_ const char *, char *, int *);
821 char *  Perl_tovmspath_utf8_ts (pTHX_ const char *, char *, int *);
822 int     Perl_do_rmdir (pTHX_ const char *);
823 char *  Perl_fileify_dirspec (pTHX_ const char *, char *);
824 char *  Perl_fileify_dirspec_ts (pTHX_ const char *, char *);
825 char *  Perl_fileify_dirspec_utf8 (pTHX_ const char *, char *, int *);
826 char *  Perl_fileify_dirspec_utf8_ts (pTHX_ const char *, char *, int *);
827 char *  Perl_pathify_dirspec (pTHX_ const char *, char *);
828 char *  Perl_pathify_dirspec_ts (pTHX_ const char *, char *);
829 char *  Perl_pathify_dirspec_utf8 (pTHX_ const char *, char *, int *);
830 char *  Perl_pathify_dirspec_utf8_ts (pTHX_ const char *, char *, int *);
831 char *  Perl_rmsexpand (pTHX_ const char *, char *, const char *, unsigned);
832 char *  Perl_rmsexpand_ts (pTHX_ const char *, char *, const char *, unsigned);
833 char *  Perl_rmsexpand_utf8 (pTHX_ const char *, char *, const char *, unsigned, int *, int *);
834 char *  Perl_rmsexpand_utf8_ts (pTHX_ const char *, char *, const char *, unsigned, int *, int *);
835 int     Perl_trim_unixpath (pTHX_ char *, const char*, int);
836 DIR * Perl_opendir (pTHX_ const char *);
837 int     Perl_rename (pTHX_ const char *, const char *);
838 int     Perl_rmscopy (pTHX_ const char *, const char *, int);
839 int     Perl_my_mkdir (pTHX_ const char *, Mode_t);
840 bool    Perl_vms_do_aexec (pTHX_ SV *, SV **, SV **);
841 int     Perl_vms_case_tolerant(void);
842 char *  Perl_my_getenv_len (pTHX_ const char *, unsigned long *, bool);
843 int     Perl_vmssetenv (pTHX_ const char *, const char *, struct dsc$descriptor_s **);
844 void    Perl_vmssetuserlnm(pTHX_ const char *name, const char *eqv);
845 char *  Perl_my_crypt (pTHX_ const char *, const char *);
846 Pid_t   Perl_my_waitpid (pTHX_ Pid_t, int *, int);
847 char *  my_gconvert (double, int, int, char *);
848 int     Perl_kill_file (pTHX_ const char *);
849 int     Perl_my_chdir (pTHX_ const char *);
850 int     Perl_my_chmod(pTHX_ const char *, mode_t);
851 FILE *  Perl_my_tmpfile (void);
852 #ifndef HOMEGROWN_POSIX_SIGNALS
853 int     Perl_my_sigaction (pTHX_ int, const struct sigaction*, struct sigaction*);
854 #endif
855 #ifdef KILL_BY_SIGPRC
856 unsigned int    Perl_sig_to_vmscondition (int);
857 int     Perl_my_kill (int, int);
858 void    Perl_csighandler_init (void);
859 #endif
860 int     Perl_my_utime (pTHX_ const char *, const struct utimbuf *);
861 void    Perl_vms_image_init (int *, char ***);
862 struct dirent * Perl_readdir (pTHX_ DIR *);
863 int     Perl_readdir_r(pTHX_ DIR *, struct dirent *, struct dirent **);
864 long    Perl_telldir (DIR *);
865 void    Perl_seekdir (pTHX_ DIR *, long);
866 void    Perl_closedir (DIR *);
867 void    vmsreaddirversions (DIR *, int);
868 struct tm *     Perl_my_gmtime (pTHX_ const time_t *);
869 struct tm *     Perl_my_localtime (pTHX_ const time_t *);
870 time_t  Perl_my_time (pTHX_ time_t *);
871 #ifdef HOMEGROWN_POSIX_SIGNALS
872 int     my_sigemptyset (sigset_t *);
873 int     my_sigfillset  (sigset_t *);
874 int     my_sigaddset   (sigset_t *, int);
875 int     my_sigdelset   (sigset_t *, int);
876 int     my_sigismember (sigset_t *, int);
877 int     my_sigprocmask (int, sigset_t *, sigset_t *);
878 #endif
879 I32     Perl_cando_by_name (pTHX_ I32, bool, const char *);
880 int     Perl_flex_fstat (pTHX_ int, Stat_t *);
881 int     Perl_flex_lstat (pTHX_ const char *, Stat_t *);
882 int     Perl_flex_stat (pTHX_ const char *, Stat_t *);
883 int     my_vfork (void);
884 bool    Perl_vms_do_exec (pTHX_ const char *);
885 FILE *  my_fdopen (int, const char *);
886 int     my_fclose (FILE *);
887 int     my_fwrite (const void *, size_t, size_t, FILE *);
888 char *  Perl_my_fgetname (FILE *fp, char *buf);
889 #ifdef HAS_SYMLINK
890 int     Perl_my_symlink(pTHX_ const char *path1, const char *path2);
891 #endif
892 int     Perl_my_flush (pTHX_ FILE *);
893 struct passwd * Perl_my_getpwnam (pTHX_ const char *name);
894 struct passwd * Perl_my_getpwuid (pTHX_ Uid_t uid);
895 void    Perl_my_endpwent (pTHX);
896 char *  my_getlogin (void);
897 typedef char __VMS_SEPYTOTORP__;
898 /* prototype section end marker; `typedef' passes through cpp */
899
900 #ifdef NO_PERL_TYPEDEFS  /* We'll try not to scramble later files */
901 #  ifdef __MY_BOOL_TYPE_FAKE
902 #    undef bool
903 #    undef __MY_BOOL_TYPE_FAKE
904 #  endif
905 #  ifdef __MY_I32_TYPE_FAKE
906 #    undef I32
907 #    undef __MY_I32_TYPE_FAKE
908 #  endif
909 #  ifdef __MY_SV_TYPE_FAKE
910 #    undef SV
911 #    undef __MY_SV_TYPE_FAKE
912 #  endif
913 #endif
914
915 #ifndef VMS_DO_SOCKETS
916 /* This relies on tricks in perl.h to pick up that these manifest constants
917  * are undefined and set up conversion routines.  It will then redefine
918  * these manifest constants, so the actual values will match config.h
919  */
920 #undef HAS_HTONS
921 #undef HAS_NTOHS
922 #undef HAS_HTONL
923 #undef HAS_NTOHL
924 #endif
925
926 /* The C RTL manual says to undef the macro for DEC C 5.2 and lower. */
927 #if defined(fileno) && defined(__DECC_VER) && __DECC_VER < 50300000
928 #  undef fileno 
929 #endif 
930
931 #define NO_ENVIRON_ARRAY
932
933 /* RMSEXPAND options */
934 #define PERL_RMSEXPAND_M_VMS            0x02 /* Force output to VMS format */
935 #define PERL_RMSEXPAND_M_LONG           0x04 /* Expand to long name format */
936 #define PERL_RMSEXPAND_M_VMS_IN         0x08 /* Assume input is VMS already */
937 #define PERL_RMSEXPAND_M_SYMLINK        0x20 /* Use symbolic link, not target */
938
939 #endif  /* __vmsish_h_included */