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