This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Fix example #4 in perlXStut
[perl5.git] / vms / vmsish.h
CommitLineData
a0d0e21e
LW
1/* vmsish.h
2 *
3 * VMS-specific C header file for perl5.
4 *
e518068a 5 * Last revised: 01-Oct-1995 by Charles Bailey bailey@genetics.upenn.edu
c07a80fd 6 * Version: 5.1.6
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 */
16
4633a7c4 17/* Suppress compiler warnings from DECC for VMS-specific extensions:
36477c24 18 * GLOBALEXT, NOSHAREEXT, READONLYEXT: global[dr]ef declarations
e518068a
PP
19 * ADDRCONSTEXT,NEEDCONSTEXT: initialization of data with non-constant values
20 * (e.g. pointer fields of descriptors)
21 */
22#ifdef __DECC
36477c24 23# pragma message disable (GLOBALEXT,NOSHAREEXT,READONLYEXT,ADDRCONSTEXT,NEEDCONSTEXT)
e518068a
PP
24#endif
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. */
37#if defined(__ALPHA) && defined(__DECC)
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 */
bbce6d69
PP
54#ifdef __DECC
55# include <unistd.h> /* DECC has this; VAXC and gcc don't */
56#endif
bf109933
PP
57
58/* Our own contribution to PerlShr's global symbols . . . */
59#ifdef EMBED
60# define my_trnlnm Perl_my_trnlnm
61# define my_getenv Perl_my_getenv
94c456c4
PP
62# define prime_env_iter Perl_prime_env_iter
63# define my_setenv Perl_my_setenv
bf109933
PP
64# define my_crypt Perl_my_crypt
65# define waitpid Perl_waitpid
66# define my_gconvert Perl_my_gconvert
67# define do_rmdir Perl_do_rmdir
68# define kill_file Perl_kill_file
69# define my_utime Perl_my_utime
bbce6d69
PP
70# define rmsexpand Perl_rmsexpand
71# define rmsexpand_ts Perl_rmsexpand_ts
bf109933
PP
72# define fileify_dirspec Perl_fileify_dirspec
73# define fileify_dirspec_ts Perl_fileify_dirspec_ts
74# define pathify_dirspec Perl_pathify_dirspec
75# define pathify_dirspec_ts Perl_pathify_dirspec_ts
76# define tounixspec Perl_tounixspec
77# define tounixspec_ts Perl_tounixspec_ts
78# define tovmsspec Perl_tovmsspec
79# define tovmsspec_ts Perl_tovmsspec_ts
80# define tounixpath Perl_tounixpath
81# define tounixpath_ts Perl_tounixpath_ts
82# define tovmspath Perl_tovmspath
83# define tovmspath_ts Perl_tovmspath_ts
84# define getredirection Perl_getredirection
85# define opendir Perl_opendir
86# define readdir Perl_readdir
87# define telldir Perl_telldir
88# define seekdir Perl_seekdir
89# define closedir Perl_closedir
90# define vmsreaddirversions Perl_vmsreaddirversions
91# define getredirection Perl_getredirection
92# define my_gmtime Perl_my_gmtime
93# define cando_by_name Perl_cando_by_name
94# define flex_fstat Perl_flex_fstat
95# define flex_stat Perl_flex_stat
96# define trim_unixpath Perl_trim_unixpath
0414b1a0 97# define my_vfork Perl_my_vfork
bf109933
PP
98# define vms_do_aexec Perl_vms_do_aexec
99# define vms_do_exec Perl_vms_do_exec
100# define do_aspawn Perl_do_aspawn
101# define do_spawn Perl_do_spawn
102# define my_fwrite Perl_my_fwrite
0414b1a0 103# define my_binmode Perl_my_binmode
bf109933
PP
104# define my_getpwnam Perl_my_getpwnam
105# define my_getpwuid Perl_my_getpwuid
106# define my_getpwent Perl_my_getpwent
107# define my_endpwent Perl_my_endpwent
108# define my_getlogin Perl_my_getlogin
109# define rmscopy Perl_rmscopy
110# define init_os_extras Perl_init_os_extras
111#endif
112
113/* Delete if at all possible, changing protections if necessary. */
748a9306
LW
114#define unlink kill_file
115
0414b1a0
PP
116/*
117 * Intercept calls to fork, so we know whether subsequent calls to
118 * exec should be handled in VMSish or Unixish style.
119 */
120#define fork my_vfork
121#ifndef __DONT_MASK_VFORK /* #defined in vms.c so we see real vfork */
122# ifdef vfork
123# undef vfork
124# endif
125# define vfork my_vfork
126#endif
127
128/* BIG_TIME:
129 * This symbol is defined if Time_t is an unsigned type on this system.
130 */
131#define BIG_TIME
132
133/* USE_STAT_RDEV:
134 * This symbol is defined if this system has a stat structure declaring
135 * st_rdev
e518068a 136 */
0414b1a0
PP
137#define USE_STAT_RDEV /**/
138
139/* ACME_MESS:
140 * This symbol, if defined, indicates that error messages should be
141 * should be generated in a format that allows the use of the Acme
142 * GUI/editor's autofind feature.
143 */
144#undef ACME_MESS /**/
e518068a 145
748a9306
LW
146/* Macros to set errno using the VAX thread-safe calls, if present */
147#if (defined(__DECC) || defined(__DECCXX)) && !defined(__ALPHA)
148# define set_errno(v) (cma$tis_errno_set_value(v))
149# define set_vaxc_errno(v) (vaxc$errno = (v))
150#else
151# define set_errno(v) (errno = (v))
152# define set_vaxc_errno(v) (vaxc$errno = (v))
153#endif
154
155/* Handy way to vet calls to VMS system services and RTL routines. */
bf109933 156#define _ckvmssts(call) STMT_START { register unsigned long int __ckvms_sts; \
748a9306
LW
157 if (!((__ckvms_sts=(call))&1)) { \
158 set_errno(EVMSERR); set_vaxc_errno(__ckvms_sts); \
e518068a 159 croak("Fatal VMS error (status=%d) at %s, line %d", \
bf109933 160 __ckvms_sts,__FILE__,__LINE__); } } STMT_END
a0d0e21e 161
0414b1a0
PP
162/* Same thing, but don't call back to Perl's croak(); useful for errors
163 * occurring during startup, before Perl's state is initialized */
164#define _ckvmssts_noperl(call) STMT_START { register unsigned long int __ckvms_sts; \
165 if (!((__ckvms_sts=(call))&1)) { \
166 set_errno(EVMSERR); set_vaxc_errno(__ckvms_sts); \
167 fprintf(Perl_debug_log,"Fatal VMS error (status=%d) at %s, line %d", \
168 __ckvms_sts,__FILE__,__LINE__); lib$signal(__ckvms_sts); } } STMT_END
169
a0d0e21e
LW
170#ifdef VMS_DO_SOCKETS
171#include "sockadapt.h"
172#endif
173
c07a80fd
PP
174#define BIT_BUCKET "_NLA0:"
175#define PERL_SYS_INIT(c,v) getredirection((c),(v))
bf109933
PP
176#define PERL_SYS_TERM()
177#define dXSUB_SYS int dummy
a0d0e21e
LW
178#define HAS_KILL
179#define HAS_WAIT
180
e518068a
PP
181/* VMS:
182 * This symbol, if defined, indicates that the program is running under
183 * VMS. It's a symbol automagically defined by all VMS C compilers I've seen.
184 * Just in case, however . . . */
185#ifndef VMS
186#define VMS /**/
187#endif
188
189/* HAS_IOCTL:
190 * This symbol, if defined, indicates that the ioctl() routine is
191 * available to set I/O characteristics
a0d0e21e 192 */
e518068a
PP
193#undef HAS_IOCTL /**/
194
195/* HAS_UTIME:
196 * This symbol, if defined, indicates that the routine utime() is
197 * available to update the access and modification times of files.
198 */
199#define HAS_UTIME /**/
a0d0e21e 200
e518068a
PP
201/* HAS_GROUP
202 * This symbol, if defined, indicates that the getgrnam(),
203 * getgrgid(), and getgrent() routines are available to
204 * get group entries.
205 */
206#undef HAS_GROUP /**/
207
208/* HAS_PASSWD
209 * This symbol, if defined, indicates that the getpwnam(),
210 * getpwuid(), and getpwent() routines are available to
211 * get password entries.
212 */
213#define HAS_PASSWD /**/
214
215#define HAS_KILL
216#define HAS_WAIT
217
0414b1a0
PP
218/* USEMYBINMODE
219 * This symbol, if defined, indicates that the program should
220 * use the routine my_binmode(FILE *fp, char iotype) to insure
221 * that a file is in "binary" mode -- that is, that no translation
222 * of bytes occurs on read or write operations.
223 */
224#define USEMYBINMODE
225
a0d0e21e
LW
226/*
227 * fwrite1() should be a routine with the same calling sequence as fwrite(),
228 * but which outputs all of the bytes requested as a single stream (unlike
229 * fwrite() itself, which on some systems outputs several distinct records
230 * if the number_of_items parameter is >1).
231 */
232#define fwrite1 my_fwrite
233
234/* Use our own rmdir() */
235#define rmdir(name) do_rmdir(name)
236
237/* Assorted fiddling with sigs . . . */
238# include <signal.h>
239#define ABORT() abort()
5f05dabc
PP
240 /* VAXC's signal.h doesn't #define SIG_ERR, but provides BADSIG instead. */
241#if !defined(SIG_ERR) && defined(BADSIG)
242# define SIG_ERR BADSIG
243#endif
244
a0d0e21e 245
748a9306
LW
246/* Used with our my_utime() routine in vms.c */
247struct utimbuf {
248 time_t actime;
249 time_t modtime;
250};
251#define utime my_utime
252
0414b1a0
PP
253/* This is what times() returns, but <times.h> calls it tbuffer_t on VMS
254 * prior to v7.0. We check the DECC manifest to see whether it's already
255 * done this for us, relying on the fact that perl.h #includes <time.h>
256 * before it #includes "vmsish.h".
257 */
a0d0e21e 258
0414b1a0
PP
259#ifndef __TMS
260 struct tms {
261 clock_t tms_utime; /* user time */
262 clock_t tms_stime; /* system time - always 0 on VMS */
263 clock_t tms_cutime; /* user time, children */
264 clock_t tms_cstime; /* system time, children - always 0 on VMS */
265 };
5f05dabc
PP
266#else
267 /* The new headers change the times() prototype to tms from tbuffer */
268# define tbuffer_t struct tms
0414b1a0 269#endif
a0d0e21e 270
e518068a
PP
271/* Prior to VMS 7.0, the CRTL gmtime() routine was a stub which always
272 * returned NULL. Substitute our own routine, which uses the logical
273 * SYS$TIMEZONE_DIFFERENTIAL, whcih the native UTC support routines
274 * in VMS 6.0 or later use.*
275 */
276#define gmtime(t) my_gmtime(t)
277
a0d0e21e
LW
278/* VMS doesn't use a real sys_nerr, but we need this when scanning for error
279 * messages in text strings . . .
280 */
281
282#define sys_nerr EVMSERR /* EVMSERR is as high as we can go. */
283
284/* Look up new %ENV values on the fly */
285#define DYNAMIC_ENV_FETCH 1
286#define ENV_HV_NAME "%EnV%VmS%"
287
c07a80fd
PP
288/* Thin jacket around cuserid() tomatch Unix' calling sequence */
289#define getlogin my_getlogin
290
291/* Ditto for sys$hash_passwrod() . . . */
292#define crypt my_crypt
293
a0d0e21e
LW
294/* Use our own stat() clones, which handle Unix-style directory names */
295#define Stat(name,bufptr) flex_stat(name,bufptr)
296#define Fstat(fd,bufptr) flex_fstat(fd,bufptr)
297
a5f75d66
AD
298/* By default, flush data all the way to disk, not just to RMS buffers */
299#define Fflush(fp) ((fflush(fp) || fsync(fileno(fp))) ? EOF : 0)
300
a0d0e21e
LW
301/* Setup for the dirent routines:
302 * opendir(), closedir(), readdir(), seekdir(), telldir(), and
303 * vmsreaddirversions(), and preprocessor stuff on which these depend:
304 * Written by Rich $alz, <rsalz@bbn.com> in August, 1990.
305 * This code has no copyright.
306 */
307 /* Data structure returned by READDIR(). */
308struct dirent {
309 char d_name[256]; /* File name */
310 int d_namlen; /* Length of d_name */
311 int vms_verscount; /* Number of versions */
312 int vms_versions[20]; /* Version numbers */
313};
314
315 /* Handle returned by opendir(), used by the other routines. You
316 * are not supposed to care what's inside this structure. */
317typedef struct _dirdesc {
318 long context;
319 int vms_wantversions;
320 unsigned long int count;
321 char *pattern;
322 struct dirent entry;
323 struct dsc$descriptor_s pat;
324} DIR;
325
326#define rewinddir(dirp) seekdir((dirp), 0)
327
748a9306
LW
328/* used for our emulation of getpw* */
329struct passwd {
330 char *pw_name; /* Username */
331 char *pw_passwd;
332 Uid_t pw_uid; /* UIC member number */
333 Gid_t pw_gid; /* UIC group number */
334 char *pw_comment; /* Default device/directory (Unix-style) */
335 char *pw_gecos; /* Owner */
336 char *pw_dir; /* Default device/directory (VMS-style) */
337 char *pw_shell; /* Default CLI name (eg. DCL) */
338};
339#define pw_unixdir pw_comment /* Default device/directory (Unix-style) */
340#define getpwnam my_getpwnam
341#define getpwuid my_getpwuid
342#define getpwent my_getpwent
343#define endpwent my_endpwent
344#define setpwent my_endpwent
345
346/* Our own stat_t substitute, since we play with st_dev and st_ino -
347 * we want atomic types so Unix-bound code which compares these fields
c07a80fd
PP
348 * for two files will work most of the time under VMS.
349 * N.B. 1. The st_ino hack assumes that sizeof(unsigned short[3]) ==
350 * sizeof(unsigned) + sizeof(unsigned short). We can't use a union type
351 * to map the unsigned int we want and the unsigned short[3] the CRTL
352 * returns into the same member, since gcc has different ideas than DECC
353 * and VAXC about sizing union types.
354 * N.B 2. The routine cando() in vms.c assumes that &stat.st_ino is the
355 * address of a FID.
748a9306
LW
356 */
357/* First, grab the system types, so we don't clobber them later */
358#include <stat.h>
359/* Since we've got to match the size of the CRTL's stat_t, we need
360 * to mimic DECC's alignment settings.
361 */
362#if defined(__DECC) || defined(__DECCXX)
363# pragma __member_alignment __save
364# pragma __nomember_alignment
365#endif
366#if defined(__DECC)
367# pragma __message __save
368# pragma __message disable (__MISALGNDSTRCT)
369# pragma __message disable (__MISALGNDMEM)
370#endif
371struct mystat
372{
373 char *st_devnam; /* pointer to device name */
c07a80fd
PP
374 unsigned st_ino; /* hack - CRTL uses unsigned short[3] for */
375 unsigned short rvn; /* FID (num,seq,rvn) */
748a9306
LW
376 unsigned short st_mode; /* file "mode" i.e. prot, dir, reg, etc. */
377 int st_nlink; /* for compatibility - not really used */
378 unsigned st_uid; /* from ACP - QIO uic field */
379 unsigned short st_gid; /* group number extracted from st_uid */
380 dev_t st_rdev; /* for compatibility - always zero */
381 off_t st_size; /* file size in bytes */
382 unsigned st_atime; /* file access time; always same as st_mtime */
383 unsigned st_mtime; /* last modification time */
384 unsigned st_ctime; /* file creation time */
385 char st_fab_rfm; /* record format */
386 char st_fab_rat; /* record attributes */
387 char st_fab_fsz; /* fixed header size */
388 unsigned st_dev; /* encoded device name */
389};
748a9306
LW
390#define stat mystat
391typedef unsigned mydev_t;
392#define dev_t mydev_t
c07a80fd 393typedef unsigned myino_t;
748a9306
LW
394#define ino_t myino_t
395#if defined(__DECC) || defined(__DECCXX)
396# pragma __member_alignment __restore
397#endif
398#if defined(__DECC)
399# pragma __message __restore
400#endif
401/* Cons up a 'delete' bit for testing access */
402#define S_IDUSR (S_IWUSR | S_IXUSR)
403#define S_IDGRP (S_IWGRP | S_IXGRP)
404#define S_IDOTH (S_IWOTH | S_IXOTH)
a0d0e21e
LW
405
406/* Prototypes for functions unique to vms.c. Don't include replacements
407 * for routines in the mainline source files excluded by #ifndef VMS;
408 * their prototypes are already in proto.h.
409 *
410 * In order to keep Gen_ShrFls.Pl happy, functions which are to be made
411 * available to images linked to PerlShr.Exe must be declared between the
412 * __VMS_PROTOTYPES__ and __VMS_SEPYTOTORP__ lines, and must be in the form
413 * <data type><TAB>name<WHITESPACE>_((<prototype args>));
414 */
94c456c4
PP
415
416void prime_env_iter _((void));
417void getredirection _((int *, char ***));
418void init_os_extras _(());
c07a80fd
PP
419/* prototype section start marker; `typedef' passes through cpp */
420typedef char __VMS_PROTOTYPES__;
421int my_trnlnm _((char *, char *, unsigned long int));
a0d0e21e 422char * my_getenv _((char *));
c07a80fd 423char * my_crypt _((const char *, const char *));
a0d0e21e 424unsigned long int waitpid _((unsigned long int, int *, int));
a0d0e21e
LW
425char * my_gconvert _((double, int, int, char *));
426int do_rmdir _((char *));
427int kill_file _((char *));
748a9306 428int my_utime _((char *, struct utimbuf *));
bbce6d69
PP
429char * rmsexpand _((char *, char *, char *, unsigned));
430char * rmsexpand_ts _((char *, char *, char *, unsigned));
a0d0e21e
LW
431char * fileify_dirspec _((char *, char *));
432char * fileify_dirspec_ts _((char *, char *));
433char * pathify_dirspec _((char *, char *));
434char * pathify_dirspec_ts _((char *, char *));
435char * tounixspec _((char *, char *));
436char * tounixspec_ts _((char *, char *));
437char * tovmsspec _((char *, char *));
438char * tovmsspec_ts _((char *, char *));
439char * tounixpath _((char *, char *));
440char * tounixpath_ts _((char *, char *));
441char * tovmspath _((char *, char *));
442char * tovmspath_ts _((char *, char *));
443void getredirection _(());
444DIR * opendir _((char *));
445struct dirent * readdir _((DIR *));
446long telldir _((DIR *));
447void seekdir _((DIR *, long));
448void closedir _((DIR *));
449void vmsreaddirversions _((DIR *, int));
e518068a 450struct tm *my_gmtime _((const time_t *));
748a9306
LW
451I32 cando_by_name _((I32, I32, char *));
452int flex_fstat _((int, struct stat *));
453int flex_stat _((char *, struct stat *));
a0d0e21e 454int trim_unixpath _((char *, char*));
0414b1a0 455int my_vfork _(());
748a9306 456bool vms_do_aexec _((SV *, SV **, SV **));
a0d0e21e 457bool vms_do_exec _((char *));
748a9306 458unsigned long int do_aspawn _((SV *, SV **, SV **));
a0d0e21e
LW
459unsigned long int do_spawn _((char *));
460int my_fwrite _((void *, size_t, size_t, FILE *));
0414b1a0 461FILE * my_binmode _((FILE *, char));
748a9306
LW
462struct passwd * my_getpwnam _((char *name));
463struct passwd * my_getpwuid _((Uid_t uid));
464struct passwd * my_getpwent _(());
465void my_endpwent _(());
c07a80fd 466char * my_getlogin _(());
bf109933 467int rmscopy _((char *, char *, int));
c07a80fd
PP
468typedef char __VMS_SEPYTOTORP__;
469/* prototype section end marker; `typedef' passes through cpp */
a0d0e21e
LW
470
471#ifndef VMS_DO_SOCKETS
748a9306
LW
472/* This relies on tricks in perl.h to pick up that these manifest constants
473 * are undefined and set up conversion routines. It will then redefine
474 * these manifest constants, so the actual values will match config.h
475 */
476#undef HAS_HTONS
477#undef HAS_NTOHS
478#undef HAS_HTONL
479#undef HAS_NTOHL
a0d0e21e
LW
480#endif
481
482b294c
PP
482#define TMPPATH "sys$scratch:perl-eXXXXXX"
483
a0d0e21e 484#endif /* __vmsish_h_included */