vmsish.h revision 1.16
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#ifdef __DECC
28#  pragma message disable (ADDRCONSTEXT,NEEDCONSTEXT)
29#endif
30#ifdef __DECCXX
31#  pragma message informational (INTSIGNCHANGE,CASTQUALTYP,ASSCOMMEA,NOCTOBUTCONREFM,MISSINGRETURN)
32#endif
33
34/* DEC's C compilers and gcc use incompatible definitions of _to(upp|low)er() */
35#ifdef _toupper
36#  undef _toupper
37#endif
38#define _toupper(c) (((c) < 'a' || (c) > 'z') ? (c) : (c) & ~040)
39#ifdef _tolower
40#  undef _tolower
41#endif
42#define _tolower(c) (((c) < 'A' || (c) > 'Z') ? (c) : (c) | 040)
43
44/* Assorted things to look like Unix */
45#include <processes.h> /* for vfork() */
46#include <unixio.h>
47#include <unixlib.h>
48#include <file.h>  /* it's not <sys/file.h>, so don't use I_SYS_FILE */
49#if (defined(__DECC) && defined(__DECC_VER) && __DECC_VER > 20000000) || defined(__DECCXX)
50#  include <unistd.h> /* DECC has this; gcc doesn't */
51#endif
52
53#ifdef NO_PERL_TYPEDEFS /* a2p; we don't want Perl's special routines */
54#  define DONT_MASK_RTL_CALLS
55#endif
56
57#include <namdef.h>
58
59/* Set the maximum filespec size here as it is larger for EFS file
60 * specifications.
61 */
62#ifndef VMS_MAXRSS
63#ifdef NAML$C_MAXRSS
64#define VMS_MAXRSS (NAML$C_MAXRSS+1)
65#ifndef VMS_LONGNAME_SUPPORT
66#define VMS_LONGNAME_SUPPORT 1
67#endif /* VMS_LONGNAME_SUPPORT */
68#endif /* NAML$C_MAXRSS */
69#endif /* VMS_MAXRSS */
70
71#ifndef VMS_MAXRSS
72#define VMS_MAXRSS (NAM$C_MAXRSS + 1)
73#endif
74
75#ifndef MAXPATHLEN
76#define MAXPATHLEN (VMS_MAXRSS - 1)
77#endif
78
79
80/* Note that we do, in fact, have this */
81#define HAS_GETENV_SV
82#define HAS_GETENV_LEN
83
84
85#ifndef PERL_FOR_X2P
86
87#ifndef DONT_MASK_RTL_CALLS
88#  ifdef getenv
89#    undef getenv
90#  endif
91  /* getenv used for regular logical names */
92#  define getenv(v) Perl_my_getenv(aTHX_ v,TRUE)
93#endif
94#ifdef getenv_len
95#  undef getenv_len
96#endif
97#define getenv_len(v,l) Perl_my_getenv_len(aTHX_ v,l,TRUE)
98
99/* DECC introduces this routine in the RTL as of VMS 7.0; for now,
100 * we'll use ours, since it gives us the full VMS exit status. */
101#define waitpid my_waitpid
102
103/* Our own contribution to PerlShr's global symbols . . . */
104
105#if !defined(PERL_IMPLICIT_CONTEXT)
106#define opendir			Perl_opendir
107#define rename			Perl_rename
108#define seekdir			Perl_seekdir
109#define readdir			Perl_readdir
110#define readdir_r		Perl_readdir_r
111#else
112#define opendir(a)		Perl_opendir(aTHX_ a)
113#define rename(a,b)		Perl_rename(aTHX_ a,b)
114#define seekdir(a,b)		Perl_seekdir(aTHX_ a,b)
115#define readdir(a)		Perl_readdir(aTHX_ a)
116#define readdir_r(a,b,c)	Perl_readdir_r(aTHX_ a,b,c)
117#endif
118#define closedir(a)		Perl_closedir(a)
119#define telldir(a)		Perl_telldir(a)
120#define vmsreaddirversions(a,b)	Perl_vmsreaddirversions(a,b)
121
122#define cando_by_name(a,b,c)		Perl_cando_by_name(aTHX_ a,b,c)
123#define do_rmdir(a)			Perl_do_rmdir(aTHX_ a)
124#define fileify_dirspec(a,b)		Perl_fileify_dirspec(aTHX_ a,b)
125#define fileify_dirspec(a,b)		Perl_fileify_dirspec(aTHX_ a,b)
126#define fileify_dirspec_ts(a,b)		Perl_fileify_dirspec_ts(aTHX_ a,b)
127#define fileify_dirspec_ts(a,b)		Perl_fileify_dirspec_ts(aTHX_ a,b)
128#define fileify_dirspec_utf8(a,b,c)	Perl_fileify_dirspec(aTHX_ a,b,utf8)
129#define fileify_dirspec_utf8_ts(a,b,c)	Perl_fileify_dirspec_ts(aTHX_ a,b,utf8)
130#define flex_fstat(a,b)			Perl_flex_fstat(aTHX_ a,b)
131#define flex_lstat(a,b)			Perl_flex_lstat(aTHX_ a,b)
132#define flex_stat(a,b)			Perl_flex_stat(aTHX_ a,b)
133#define init_os_extras			Perl_init_os_extras
134#define kill_file(a)			Perl_kill_file(aTHX_ a)
135#define my_chdir(a)			Perl_my_chdir(aTHX_ a)
136#define my_chmod(a,b)			Perl_my_chmod(aTHX_ a,b)
137#define my_crypt(a,b)			Perl_my_crypt(aTHX_ a,b)
138#define my_endpwent()			Perl_my_endpwent(aTHX)
139#define my_fclose(a)			Perl_my_fclose(a)
140#define my_fdopen(a,b)			Perl_my_fdopen(a,b)
141#define my_flush(a)			Perl_my_flush(aTHX_ a)
142#define my_fwrite(a,b,c,d)		Perl_my_fwrite(a,b,c,d)
143#define my_fgetname(a,b)		Perl_my_fgetname(a,b)
144#define my_gconvert(a,b,c,d)		Perl_my_gconvert(a,b,c,d)
145#define my_getenv(a,b)			Perl_my_getenv(aTHX_ a,b)
146#define my_getenv_len(a,b,c)		Perl_my_getenv_len(aTHX_ a,b,c)
147#define my_getpwent()			Perl_my_getpwent(aTHX)
148#define my_getpwnam(a)			Perl_my_getpwnam(aTHX_ a)
149#define my_getpwuid(a)			Perl_my_getpwuid(aTHX_ a)
150#define my_gmtime(a)			Perl_my_gmtime(aTHX_ a)
151#define my_localtime(a)			Perl_my_localtime(aTHX_ a)
152#define my_mkdir(a,b)			Perl_my_mkdir(aTHX_ a,b)
153#ifdef HAS_SYMLINK
154#  define my_symlink(a,b)		Perl_my_symlink(aTHX_ a,b)
155#endif
156#define my_time(a)			Perl_my_time(aTHX_ a)
157#define my_tmpfile			Perl_my_tmpfile
158#define my_trnlnm(a,b,c)		Perl_my_trnlnm(aTHX_ a,b,c)
159#define my_utime(a,b)			Perl_my_utime(aTHX_ a,b)
160#define my_vfork			Perl_my_vfork
161#define my_waitpid(a,b,c)		Perl_my_waitpid(aTHX_ a,b,c)
162#define pathify_dirspec(a,b)		Perl_pathify_dirspec(aTHX a,b)
163#define pathify_dirspec_ts(a,b)		Perl_pathify_dirspec_ts(aTHX a,b)
164#define pathify_dirspec_utf8(a,b,c)	Perl_pathify_dirspec_utf8(aTHX a,b,c)
165#define pathify_dirspec_utf8_ts(a,b,c)	Perl_pathify_dirspec_utf8_ts(aTHX a,b,c)
166#define prime_env_iter			Perl_prime_env_iter
167#define rmscopy(a,b,c)			Perl_rmscopy(aTHX_ a,b,c)
168#define rmsexpand(a,b,c,d)		Perl_rmsexpand_utf8(aTHX_ a,b,c,d,NULL,NULL)
169#define rmsexpand_ts(a,b,c,d)		Perl_rmsexpand_utf8_ts(aTHX_ a,b,c,d,NULL,NULL)
170#define rmsexpand_utf8(a,b,c,d,e,f)	Perl_rmsexpand_utf8(aTHX_ a,b,c,d,e,f)
171#define rmsexpand_utf8_ts(a,b,c,d,e,f)	Perl_rmsexpand_utf8_ts(aTHX_ a,b,c,d,e,f)
172#define tounixpath(a,b)			Perl_tounixpath_utf8(aTHX_ a,b,NULL)
173#define tounixpath_ts(a,b)		Perl_tounixpath_utf8_ts(aTHX_ a,b,NULL)
174#define tounixpath_utf8(a,b,c)		Perl_tounixpath_utf8(aTHX_ a,b,c)
175#define tounixpath_utf8_ts(a,b,c)	Perl_tounixpath_utf8_ts(aTHX_ a,b,c)
176#define tounixspec(a,b)			Perl_tounixspec_utf8(aTHX_ a,b,NULL)
177#define tounixspec_ts(a,b)		Perl_tounixspec_utf8_ts(aTHX_ a,b,NULL)
178#define tounixspec_utf8(a,b,c)		Perl_tounixspec_utf8(aTHX_ a,b,c)
179#define tounixspec_utf8_ts(a,b,c)	Perl_tounixspec_utf8_ts(aTHX_ a,b,c)
180#define tovmspath(a,b)			Perl_tovmspath_utf8(aTHX_ a,b,NULL)
181#define tovmspath_ts(a,b)		Perl_tovmspath_utf8_ts(aTHX_ a,b,NULL)
182#define tovmspath_utf8(a,b,c)		Perl_tovmspath_utf8(aTHX_ a,b,c)
183#define tovmspath_utf8_ts(a,b,c)	Perl_tovmspath_utf8_ts(aTHX_ a,b,c)
184#define tovmsspec(a,b)			Perl_tovmsspec_utf8(aTHX_ a,b,NULL)
185#define tovmsspec_ts(a,b)		Perl_tovmsspec_utf8_ts(aTHX_ a,b)
186#define tovmsspec_utf8(a,b,c)		Perl_tovmsspec_utf8(aTHX_ a,b,c)
187#define tovmsspec_utf8_ts(a,b,c)	Perl_tovmsspec_utf8_ts(aTHX_ a,b,c)
188#define trim_unixpath(a,b,c)		Perl_trim_unixpath(aTHX_ a,b,c)
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 vms_case_tolerant(a)		Perl_vms_case_tolerant(a)
192#define vms_image_init(a,b)		Perl_vms_image_init(a,b)
193#define vms_realname(a,b,c)		Perl_vms_realname(aTHX_ a,b,c)
194#define vms_realpath(a,b,c)		Perl_vms_realpath(aTHX_ a,b,c)
195#define vmssetenv(a,b,c)		Perl_vmssetenv(aTHX_ a,b,c)
196#define vmstrnenv(a,b,c,d,e)		Perl_vmstrnenv(a,b,c,d,e)
197#define vmssetuserlnm(a,b)		Perl_vmssetuserlnm(a,b)
198
199/* Delete if at all possible, changing protections if necessary. */
200#define unlink(a) kill_file(a)
201
202/*
203 * Intercept calls to fork, so we know whether subsequent calls to
204 * exec should be handled in VMSish or Unixish style.
205 */
206#define fork my_vfork
207#ifndef DONT_MASK_RTL_CALLS     /* #defined in vms.c so we see real vfork */
208#  ifdef vfork
209#    undef vfork
210#  endif
211#  define vfork my_vfork
212#endif
213
214/*
215 * Toss in a shim to tmpfile which creates a plain temp file if the
216 * RMS tmp mechanism won't work (e.g. if someone is relying on ACLs
217 * from a specific directory to permit creation of files).
218 */
219#ifndef DONT_MASK_RTL_CALLS
220#  define tmpfile Perl_my_tmpfile
221#endif
222#endif
223
224
225/* BIG_TIME:
226 *	This symbol is defined if Time_t is an unsigned type on this system.
227 */
228#define BIG_TIME
229
230/* ACME_MESS:
231 *	This symbol, if defined, indicates that error messages should be
232 *	should be generated in a format that allows the use of the Acme
233 *	GUI/editor's autofind feature.
234 */
235#undef ACME_MESS	/**/
236
237/* ALTERNATE_SHEBANG:
238 *	This symbol, if defined, contains a "magic" string which may be used
239 *	as the first line of a Perl program designed to be executed directly
240 *	by name, instead of the standard Unix #!.  If ALTERNATE_SHEBANG
241 *	begins with a character other then #, then Perl will only treat
242 *	it as a command line if if finds the string "perl" in the first
243 *	word; otherwise it's treated as the first line of code in the script.
244 *	(IOW, Perl won't hand off to another interpreter via an alternate
245 *	shebang sequence that might be legal Perl code.)
246 */
247#define ALTERNATE_SHEBANG "$"
248
249/* Macros to set errno using the VAX thread-safe calls, if present */
250#if (defined(__DECC) || defined(__DECCXX)) && !defined(__ALPHA)
251#  define set_errno(v)      (cma$tis_errno_set_value(v))
252   void cma$tis_errno_set_value(int __value);  /* missing in some errno.h */
253#  define set_vaxc_errno(v) (vaxc$errno = (v))
254#else
255#  define set_errno(v)      (errno = (v))
256#  define set_vaxc_errno(v) (vaxc$errno = (v))
257#endif
258
259/* Support for 'vmsish' behaviors enabled with C<use vmsish> pragma */
260
261#define COMPLEX_STATUS	1	/* We track both "POSIX" and VMS values */
262
263#define HINT_M_VMSISH_STATUS	0x40000000 /* system, $? return VMS status */
264#define HINT_M_VMSISH_TIME	0x80000000 /* times are local, not UTC */
265
266#ifdef PERL_IMPLICIT_CONTEXT
267#  define TEST_VMSISH(h)	(my_perl && PL_curcop && (PL_curcop->cop_hints & (h)))
268#else
269#  define TEST_VMSISH(h)	(PL_curcop && (PL_curcop->cop_hints & (h)))
270#endif
271#define VMSISH_STATUS	TEST_VMSISH(HINT_M_VMSISH_STATUS)
272#define VMSISH_TIME	TEST_VMSISH(HINT_M_VMSISH_TIME)
273
274/* VMS-specific data storage */
275
276#define HAVE_INTERP_INTERN
277struct interp_intern {
278    int    hushed;
279    int	   posix_exit;
280    double inv_rand_max;
281};
282#define VMSISH_HUSHED     (PL_sys_intern.hushed)
283#define MY_INV_RAND_MAX   (PL_sys_intern.inv_rand_max)
284#define MY_POSIX_EXIT	(PL_sys_intern.posix_exit)
285
286/* Flags for vmstrnenv() */
287#define PERL__TRNENV_SECURE 0x01
288#define PERL__TRNENV_JOIN_SEARCHLIST 0x02
289
290/* Handy way to vet calls to VMS system services and RTL routines. */
291#define _ckvmssts(call) STMT_START { unsigned long int __ckvms_sts; \
292  if (!((__ckvms_sts=(call))&1)) { \
293  set_errno(EVMSERR); set_vaxc_errno(__ckvms_sts); \
294  Perl_croak(aTHX_ "Fatal VMS error (status=%d) at %s, line %d", \
295  __ckvms_sts,__FILE__,__LINE__); } } STMT_END
296
297/* Same thing, but don't call back to Perl's croak(); useful for errors
298 * occurring during startup, before Perl's state is initialized */
299#define _ckvmssts_noperl(call) STMT_START { unsigned long int __ckvms_sts; \
300  if (!((__ckvms_sts=(call))&1)) { \
301  set_errno(EVMSERR); set_vaxc_errno(__ckvms_sts); \
302  (void)fprintf(stderr,"Fatal VMS error (status=%d) at %s, line %d", \
303  __ckvms_sts,__FILE__,__LINE__); (void)lib$signal(__ckvms_sts); } } STMT_END
304
305#ifdef VMS_DO_SOCKETS
306#define PERL_SOCK_SYSREAD_IS_RECV
307#define PERL_SOCK_SYSWRITE_IS_SEND
308#endif
309
310#define BIT_BUCKET "/dev/null"
311#define PERL_SYS_INIT_BODY(c,v)	MALLOC_CHECK_TAINT2(*c,*v) vms_image_init((c),(v)); PERLIO_INIT; MALLOC_INIT
312#define PERL_SYS_TERM_BODY()    HINTS_REFCNT_TERM; OP_REFCNT_TERM;      \
313                                PERLIO_TERM; MALLOC_TERM; LOCALE_TERM;  \
314                                ENV_TERM;
315#define dXSUB_SYS dNOOP
316#define HAS_KILL
317#define HAS_WAIT
318
319#ifndef PERL_CORE
320#  define PERL_FS_VER_FMT	"%d_%d_%d"
321#endif
322#define PERL_FS_VERSION		STRINGIFY(PERL_REVISION) "_" \
323				STRINGIFY(PERL_VERSION) "_" \
324				STRINGIFY(PERL_SUBVERSION)
325/* Temporary; we need to add support for this to Configure.Com */
326#ifdef PERL_INC_VERSION_LIST
327#  undef PERL_INC_VERSION_LIST
328#endif
329
330/* VMS:
331 *	This symbol, if defined, indicates that the program is running under
332 *	VMS.  It's a symbol automagically defined by all VMS C compilers I've seen.
333 * Just in case, however . . . */
334/* Note that code really should be using __VMS to comply with ANSI */
335#ifndef VMS
336#define VMS		/**/
337#endif
338
339/* HAS_IOCTL:
340 *	This symbol, if defined, indicates that the ioctl() routine is
341 *	available to set I/O characteristics
342 */
343#define	HAS_IOCTL		/**/
344
345/* HAS_UTIME:
346 *	This symbol, if defined, indicates that the routine utime() is
347 *	available to update the access and modification times of files.
348 */
349#define HAS_UTIME		/**/
350
351/* HAS_GROUP
352 *	This symbol, if defined, indicates that the getgrnam() and
353 *	getgrgid() routines are available to get group entries.
354 *	The getgrent() has a separate definition, HAS_GETGRENT.
355 */
356#define HAS_GROUP		/**/
357
358/* HAS_PASSWD
359 *	This symbol, if defined, indicates that the getpwnam() and
360 *	getpwuid() routines are available to get password entries.
361 *	The getpwent() has a separate definition, HAS_GETPWENT.
362 */
363#define HAS_PASSWD		/**/
364
365#define HAS_KILL
366#define HAS_WAIT
367
368/* USEMYBINMODE
369 *	This symbol, if defined, indicates that the program should
370 *	use the routine my_binmode(FILE *fp, char iotype, int mode) to insure
371 *	that a file is in "binary" mode -- that is, that no translation
372 *	of bytes occurs on read or write operations.
373 */
374#undef USEMYBINMODE
375
376/* Stat_t:
377 *	This symbol holds the type used to declare buffers for information
378 *	returned by stat().  It's usually just struct stat.  It may be necessary
379 *	to include <sys/stat.h> and <sys/types.h> to get any typedef'ed
380 *	information.
381 */
382/* VMS:
383 * We need this typedef to point to the new type even if DONT_MASK_RTL_CALLS
384 * is in effect, since Perl's thread.h embeds one of these structs in its
385 * thread data struct, and our struct mystat is a different size from the
386 * regular struct stat (cf. note above about having to pad struct to work
387 * around bug in compiler.)
388 * It's OK to pass one of these to the RTL's stat(), though, since the
389 * fields it fills are the same in each struct.
390 */
391#define Stat_t struct mystat
392
393/* USE_STAT_RDEV:
394*	This symbol is defined if this system has a stat structure declaring
395*	st_rdev
396*	VMS: Field exists in POSIXish version of struct stat(), but is not used.
397*
398*  No definition of what value an operating system or file system should
399*  put in the st_rdev field has been found by me so far.  Examination of
400*  LINUX source code indicates that the value is both very platform and
401*  file system specific, with many filesystems just putting 1 or 0 in it.
402*  J. Malmberg.
403*/
404#undef USE_STAT_RDEV		/**/
405
406/*
407 * fwrite1() should be a routine with the same calling sequence as fwrite(),
408 * but which outputs all of the bytes requested as a single stream (unlike
409 * fwrite() itself, which on some systems outputs several distinct records
410 * if the number_of_items parameter is >1).
411 */
412#define fwrite1 my_fwrite
413
414
415#ifndef DONT_MASK_RTL_CALLS
416#  define fwrite my_fwrite     /* for PerlSIO_fwrite */
417#  define fdopen my_fdopen
418#  define fclose my_fclose
419#  define fgetname(a, b) my_fgetname(a, b)
420#ifdef HAS_SYMLINK
421#  define symlink my_symlink
422#endif
423#endif
424
425
426/* By default, flush data all the way to disk, not just to RMS buffers */
427#define Fflush(fp) my_flush(fp)
428
429/* Use our own rmdir() */
430#ifndef DONT_MASK_RTL_CALLS
431#define rmdir(name) do_rmdir(name)
432#endif
433
434/* Assorted fiddling with sigs . . . */
435# include <signal.h>
436#define ABORT() abort()
437
438#ifdef I_UTIME
439#include <utime.h>
440#else
441/* Used with our my_utime() routine in vms.c */
442struct utimbuf {
443  time_t actime;
444  time_t modtime;
445};
446#endif
447#ifndef DONT_MASK_RTL_CALLS
448#define utime my_utime
449#endif
450
451/* tbuffer_t was replaced with struct tms in v7.0.  We no longer support
452 * systems prior to v7.0, but there could be old XS code out there that
453 * references tbuffer_t, so provide a compatibility macro.
454 */
455
456#define tbuffer_t struct tms
457
458/* Substitute our own routines for gmtime(), localtime(), and time(),
459 * which allow us to implement the vmsish 'time' pragma, and work
460 * around absence of system-level UTC support on old versions of VMS.
461 */
462#define gmtime(t) my_gmtime(t)
463#define localtime(t) my_localtime(t)
464#define time(t) my_time(t)
465
466/*
467 * The C RTL's sigaction fails to check for invalid signal numbers so we
468 * help it out a bit.
469 */
470#ifndef DONT_MASK_RTL_CALLS
471#    define sigaction(a,b,c) Perl_my_sigaction(aTHX_ a,b,c)
472#endif
473#ifdef KILL_BY_SIGPRC
474#  define kill  Perl_my_kill
475#endif
476# define killpg  Perl_my_killpg
477
478
479/* VMS doesn't use a real sys_nerr, but we need this when scanning for error
480 * messages in text strings . . .
481 */
482
483#define sys_nerr EVMSERR  /* EVMSERR is as high as we can go. */
484
485/* Look up new %ENV values on the fly */
486#define DYNAMIC_ENV_FETCH 1
487  /* Special getenv function for retrieving %ENV elements. */
488#define ENVgetenv(v) my_getenv(v,FALSE)
489#define ENVgetenv_len(v,l) my_getenv_len(v,l,FALSE)
490
491
492/* Ditto for sys$hash_password() . . . */
493#define crypt(a,b)  Perl_my_crypt(aTHX_ a,b)
494
495/* Tweak arg to mkdir & chdir first, so we can tolerate trailing /. */
496#define Mkdir(dir,mode) Perl_my_mkdir(aTHX_ (dir),(mode))
497#define Chdir(dir) my_chdir((dir))
498#ifndef DONT_MASK_RTL_CALLS
499#define chmod(file_spec, mode) my_chmod((file_spec), (mode))
500#endif
501
502/* Use our own stat() clones, which handle Unix-style directory names */
503#define Stat(name,bufptr) flex_stat(name,bufptr)
504#define Fstat(fd,bufptr) Perl_flex_fstat(aTHX_ fd,bufptr)
505#ifndef DONT_MASK_RTL_CALLS
506#define lstat(name, bufptr) flex_lstat(name, bufptr)
507#endif
508
509/* Setup for the dirent routines:
510 * opendir(), closedir(), readdir(), seekdir(), telldir(), and
511 * vmsreaddirversions(), and preprocessor stuff on which these depend:
512 *    Written by Rich $alz, <rsalz@bbn.com> in August, 1990.
513 *
514 */
515
516/* Flags for the _dirdesc structure */
517#define PERL_VMSDIR_M_VERSIONS		0x02 /* Want VMS versions */
518#define PERL_VMSDIR_M_UNIXSPECS		0x04 /* Want UNIX specifications */
519
520
521    /* Data structure returned by READDIR(). */
522struct dirent {
523    char	d_name[256];		/* File name		*/
524    int		d_namlen;		/* Length of d_name */
525    int		vms_verscount;		/* Number of versions	*/
526    int		vms_versions[20];	/* Version numbers	*/
527};
528
529    /* Handle returned by opendir(), used by the other routines.  You
530     * are not supposed to care what's inside this structure. */
531typedef struct _dirdesc {
532    long			context;
533    int				flags;
534    unsigned long int           count;
535    char			*pattern;
536    struct dirent		entry;
537    struct dsc$descriptor_s	pat;
538    void			*mutex;
539} DIR;
540
541
542#define rewinddir(dirp)		seekdir((dirp), 0)
543
544/* used for our emulation of getpw* */
545struct passwd {
546        char    *pw_name;    /* Username */
547        char    *pw_passwd;
548        Uid_t   pw_uid;      /* UIC member number */
549        Gid_t   pw_gid;      /* UIC group  number */
550        char    *pw_comment; /* Default device/directory (Unix-style) */
551        char    *pw_gecos;   /* Owner */
552        char    *pw_dir;     /* Default device/directory (VMS-style) */
553        char    *pw_shell;   /* Default CLI name (eg. DCL) */
554};
555#define pw_unixdir pw_comment  /* Default device/directory (Unix-style) */
556#define getpwnam my_getpwnam
557#define getpwuid my_getpwuid
558#define getpwent my_getpwent
559#define endpwent my_endpwent
560#define setpwent my_endpwent
561
562/* Our own stat_t substitute, since we play with st_dev and st_ino -
563 * we want atomic types so Unix-bound code which compares these fields
564 * for two files will work most of the time under VMS.
565 * N.B. 1. The st_ino hack assumes that sizeof(unsigned short[3]) ==
566 * sizeof(unsigned) + sizeof(unsigned short).  We can't use a union type
567 * to map the unsigned int we want and the unsigned short[3] the CRTL
568 * returns into the same member, since gcc has different ideas than DECC
569 * and VAXC about sizing union types.
570 * N.B. 2. The routine cando() in vms.c assumes that &stat.st_ino is the
571 * address of a FID.
572 */
573/* First, grab the system types, so we don't clobber them later */
574#include <stat.h>
575/* Since we've got to match the size of the CRTL's stat_t, we need
576 * to mimic DECC's alignment settings.
577 *
578 * The simplest thing is to just put a wrapper around the stat structure
579 * supplied by the CRTL and use #defines to redirect references to the
580 * members to the real names.
581 */
582
583#if defined(__DECC) || defined(__DECCXX)
584#  pragma __member_alignment __save
585#  pragma member_alignment
586#endif
587
588typedef unsigned mydev_t;
589#if !defined(_USE_STD_STAT) && !defined(_LARGEFILE)
590typedef unsigned myino_t;
591#else
592typedef __ino64_t myino_t;
593#endif
594
595struct mystat
596{
597    struct stat crtl_stat;
598    myino_t st_ino;
599#if !defined(_USE_STD_STAT) && !defined(_LARGEFILE)
600    unsigned rvn; /* FID (num,seq,rvn) + pad */
601#endif
602    mydev_t st_dev;
603    char st_devnam[256]; /* Cache the (short) VMS name */
604};
605
606#define st_mode crtl_stat.st_mode
607#define st_nlink crtl_stat.st_nlink
608#define st_uid crtl_stat.st_uid
609#define st_gid crtl_stat.st_gid
610#define st_rdev crtl_stat.st_rdev
611#define st_size crtl_stat.st_size
612#define st_atime crtl_stat.st_atime
613#define st_mtime crtl_stat.st_mtime
614#define st_ctime crtl_stat.st_ctime
615#define st_fab_rfm crtl_stat.st_fab_rfm
616#define st_fab_rat crtl_stat.st_fab_rat
617#define st_fab_fsz crtl_stat.st_fab_fsz
618#define st_fab_mrs crtl_stat.st_fab_mrs
619
620#if defined(_USE_STD_STAT) || defined(_LARGEFILE)
621#define VMS_INO_T_COMPARE(__a, __b) (__a != __b)
622#define VMS_INO_T_COPY(__a, __b) __a = __b
623#else
624#define VMS_INO_T_COMPARE(__a, __b) memcmp(&__a, &__b, 6)
625#define VMS_INO_T_COPY(__a, __b) memcpy(&__a, &__b, 6)
626#endif
627
628#if defined(__DECC) || defined(__DECCXX)
629#  pragma __member_alignment __restore
630#endif
631
632#ifndef DONT_MASK_RTL_CALLS  /* defined for vms.c so we can see RTL calls */
633#  ifdef stat
634#    undef stat
635#  endif
636#  define stat mystat
637#  define dev_t mydev_t
638#  define ino_t myino_t
639#endif
640/* Cons up a 'delete' bit for testing access */
641#define S_IDUSR (S_IWUSR | S_IXUSR)
642#define S_IDGRP (S_IWGRP | S_IXGRP)
643#define S_IDOTH (S_IWOTH | S_IXOTH)
644
645
646#ifndef PERL_FOR_X2P
647/* Prototypes for functions unique to vms.c.  Don't include replacements
648 * for routines in the mainline source files excluded by #ifndef VMS;
649 * their prototypes are already in proto.h.
650 */
651
652#ifdef __cplusplus
653extern "C" {
654#endif
655
656void	prime_env_iter (void);
657void	init_os_extras (void);
658int	Perl_vms_status_to_unix(int vms_status, int child_flag);
659int	Perl_unix_status_to_vms(int unix_status);
660int	Perl_vmstrnenv (const char *, char *, unsigned long int, struct dsc$descriptor_s **, unsigned long int);
661char *	Perl_vms_realpath (pTHX_ const char *, char *, int *);
662char *	Perl_my_getenv (pTHX_ const char *, bool);
663int	Perl_my_trnlnm (pTHX_ const char *, char *, unsigned long int);
664char *	Perl_tounixspec (pTHX_ const char *, char *);
665char *	Perl_tounixspec_ts (pTHX_ const char *, char *);
666char *	Perl_tounixspec_utf8 (pTHX_ const char *, char *, int *);
667char *	Perl_tounixspec_utf8_ts (pTHX_ const char *, char *, int *);
668char *	Perl_tovmsspec (pTHX_ const char *, char *);
669char *	Perl_tovmsspec_ts (pTHX_ const char *, char *);
670char *	Perl_tovmsspec_utf8 (pTHX_ const char *, char *, int *);
671char *	Perl_tovmsspec_utf8_ts (pTHX_ const char *, char *, int *);
672char *	Perl_tounixpath (pTHX_ const char *, char *);
673char *	Perl_tounixpath_ts (pTHX_ const char *, char *);
674char *	Perl_tounixpath_utf8 (pTHX_ const char *, char *, int *);
675char *	Perl_tounixpath_utf8_ts (pTHX_ const char *, char *, int *);
676char *	Perl_tovmspath (pTHX_ const char *, char *);
677char *	Perl_tovmspath_ts (pTHX_ const char *, char *);
678char *	Perl_tovmspath_utf8 (pTHX_ const char *, char *, int *);
679char *	Perl_tovmspath_utf8_ts (pTHX_ const char *, char *, int *);
680int	Perl_do_rmdir (pTHX_ const char *);
681char *	Perl_fileify_dirspec (pTHX_ const char *, char *);
682char *	Perl_fileify_dirspec_ts (pTHX_ const char *, char *);
683char *	Perl_fileify_dirspec_utf8 (pTHX_ const char *, char *, int *);
684char *	Perl_fileify_dirspec_utf8_ts (pTHX_ const char *, char *, int *);
685char *	Perl_pathify_dirspec (pTHX_ const char *, char *);
686char *	Perl_pathify_dirspec_ts (pTHX_ const char *, char *);
687char *	Perl_pathify_dirspec_utf8 (pTHX_ const char *, char *, int *);
688char *	Perl_pathify_dirspec_utf8_ts (pTHX_ const char *, char *, int *);
689char *	Perl_rmsexpand (pTHX_ const char *, char *, const char *, unsigned);
690char *	Perl_rmsexpand_ts (pTHX_ const char *, char *, const char *, unsigned);
691char *	Perl_rmsexpand_utf8 (pTHX_ const char *, char *, const char *, unsigned, int *, int *);
692char *	Perl_rmsexpand_utf8_ts (pTHX_ const char *, char *, const char *, unsigned, int *, int *);
693int	Perl_trim_unixpath (pTHX_ char *, const char*, int);
694DIR * Perl_opendir (pTHX_ const char *);
695int	Perl_rename (pTHX_ const char *, const char *);
696int	Perl_rmscopy (pTHX_ const char *, const char *, int);
697int	Perl_my_mkdir (pTHX_ const char *, Mode_t);
698bool	Perl_vms_do_aexec (pTHX_ SV *, SV **, SV **);
699int	Perl_vms_case_tolerant(void);
700char *	Perl_my_getenv_len (pTHX_ const char *, unsigned long *, bool);
701int	Perl_vmssetenv (pTHX_ const char *, const char *, struct dsc$descriptor_s **);
702void	Perl_vmssetuserlnm(const char *name, const char *eqv);
703char *	Perl_my_crypt (pTHX_ const char *, const char *);
704Pid_t	Perl_my_waitpid (pTHX_ Pid_t, int *, int);
705char *	my_gconvert (double, int, int, char *);
706int	Perl_kill_file (pTHX_ const char *);
707int	Perl_my_chdir (pTHX_ const char *);
708int	Perl_my_chmod(pTHX_ const char *, mode_t);
709FILE *	Perl_my_tmpfile (void);
710int	Perl_my_sigaction (pTHX_ int, const struct sigaction*, struct sigaction*);
711#ifdef KILL_BY_SIGPRC
712unsigned int	Perl_sig_to_vmscondition (int);
713int	Perl_my_kill (int, int);
714int	Perl_my_killpg (int, int);
715void	Perl_csighandler_init (void);
716#endif
717int	Perl_my_utime (pTHX_ const char *, const struct utimbuf *);
718void	Perl_vms_image_init (int *, char ***);
719struct dirent *	Perl_readdir (pTHX_ DIR *);
720int	Perl_readdir_r(pTHX_ DIR *, struct dirent *, struct dirent **);
721long	Perl_telldir (DIR *);
722void	Perl_seekdir (pTHX_ DIR *, long);
723void	Perl_closedir (DIR *);
724void	vmsreaddirversions (DIR *, int);
725struct tm *	Perl_my_gmtime (pTHX_ const time_t *);
726struct tm *	Perl_my_localtime (pTHX_ const time_t *);
727time_t	Perl_my_time (pTHX_ time_t *);
728I32	Perl_cando_by_name (pTHX_ I32, bool, const char *);
729int	Perl_flex_fstat (pTHX_ int, Stat_t *);
730int	Perl_flex_lstat (pTHX_ const char *, Stat_t *);
731int	Perl_flex_stat (pTHX_ const char *, Stat_t *);
732int	my_vfork (void);
733bool	Perl_vms_do_exec (pTHX_ const char *);
734FILE *  my_fdopen (int, const char *);
735int     my_fclose (FILE *);
736int     my_fwrite (const void *, size_t, size_t, FILE *);
737char *  Perl_my_fgetname (FILE *fp, char *buf);
738#ifdef HAS_SYMLINK
739int     Perl_my_symlink(pTHX_ const char *path1, const char *path2);
740#endif
741int	Perl_my_flush (pTHX_ FILE *);
742struct passwd *	Perl_my_getpwnam (pTHX_ const char *name);
743struct passwd *	Perl_my_getpwuid (pTHX_ Uid_t uid);
744void	Perl_my_endpwent (pTHX);
745
746/*
747 * The following prototypes are in math.h but for some reason they
748 * are ifdefed out for C++.  So we have to repeat them here in order
749 * to build the POSIX extension.
750 */
751
752#ifdef __DECCXX
753
754double exp2(double __x);
755double fdim(double __x, double __y);
756double fma(double __x, double __y, double __z);
757double fmax(double __x, double __y);
758double fmin(double __x, double __y);
759double nexttoward(double __x, long double __y);
760double remainder(double __x, double __y);
761double remquo(double __x, double __y, int *__quo);
762double tgamma(double __x);
763float exp2f(float __x);
764float fdimf(float __x, float __y);
765float fmaf(float __x, float __y, float __z);
766float fmaxf(float __x, float __y);
767float fminf(float __x, float __y);
768float nexttowardf(float __x, long double __y);
769float remainderf(float __x, float __y);
770float remquof(float __x, float __y, int *__quo);
771float tgammaf(float __x);
772long double exp2l(long double __x);
773long double fdiml(long double __x, long double __y);
774long double fmal(long double __x, long double __y, long double __z);
775long double fmaxl(long double __x, long double __y);
776long double fminl(long double __x, long double __y);
777long double nexttowardl(long double __x, long double __y);
778long double remainderl(long double __x, long double __y);
779long double remquol(long double __x, long double __y, int *__quo);
780long double tgammal(long double __x);
781int ilogb(double __x);
782int ilogbf(float __x);
783int ilogbl(long double __x);
784long int lrint(double __x);
785long int lrintf(float __x);
786long int lrintl(long double __x);
787long int lround(double __x);
788long int lroundf(float __x);
789long int lroundl(long double __x);
790
791#endif
792
793
794#ifdef __cplusplus
795}
796#endif
797
798#endif
799
800#ifndef VMS_DO_SOCKETS
801/* This relies on tricks in perl.h to pick up that these manifest constants
802 * are undefined and set up conversion routines.  It will then redefine
803 * these manifest constants, so the actual values will match config.h
804 */
805#undef HAS_HTONS
806#undef HAS_NTOHS
807#undef HAS_HTONL
808#undef HAS_NTOHL
809#endif
810
811/* The C RTL manual says to undef the macro for DEC C 5.2 and lower. */
812#if defined(fileno) && defined(__DECC_VER) && __DECC_VER < 50300000
813#  undef fileno
814#endif
815
816#define NO_ENVIRON_ARRAY
817
818/* RMSEXPAND options */
819#define PERL_RMSEXPAND_M_VMS		0x02 /* Force output to VMS format */
820#define PERL_RMSEXPAND_M_LONG		0x04 /* Expand to long name format */
821#define PERL_RMSEXPAND_M_VMS_IN		0x08 /* Assume input is VMS already */
822#define PERL_RMSEXPAND_M_SYMLINK	0x20 /* Use symbolic link, not target */
823
824/* With long doubles, NaN == NaN, which it shouldn't. */
825#ifdef USE_LONG_DOUBLE
826#  define NAN_COMPARE_BROKEN 1
827#endif
828#endif  /* __vmsish_h_included */
829