[p5sagit/p5-mst-13.2.git] / vms / vmsish.h

/*  vmsish.h
 *
 * VMS-specific C header file for perl5.
 *
 * Last revised: 12-Dec-1994 by Charles Bailey  bailey@genetics.upenn.edu
 */

#ifndef __vmsish_h_included
#define __vmsish_h_included

#include <descrip.h> /* for dirent struct definitions */
#include <libdef.h>  /* status codes for various places */
#include <rmsdef.h>  /* at which errno and vaxc$errno are */
#include <ssdef.h>   /* explicitly set in the perl source code */

/* DEC's C compilers and gcc use incompatible definitions of _to(upp|low)er() */
#ifdef _toupper
#  undef _toupper
#endif
#define _toupper(c) (((c) < 'a' || (c) > 'z') ? (c) : (c) & ~040)
#ifdef _tolower
#  undef _tolower
#endif
#define _tolower(c) (((c) < 'A' || (c) > 'Z') ? (c) : (c) | 040)

/* Assorted things to look like Unix */
#ifdef __GNUC__
#ifndef _IOLBF /* gcc's stdio.h doesn't define this */
#define _IOLBF 1
#endif
#endif
#include <processes.h> /* for vfork() */
#include <unixio.h>
#include <unixlib.h>
#include <file.h>  /* it's not <sys/file.h>, so don't use I_SYS_FILE */
#define unlink kill_file

/* Macros to set errno using the VAX thread-safe calls, if present */
#if (defined(__DECC) || defined(__DECCXX)) && !defined(__ALPHA)
#  define set_errno(v)      (cma$tis_errno_set_value(v))
#  define set_vaxc_errno(v) (vaxc$errno = (v))
#else
#  define set_errno(v)      (errno = (v))
#  define set_vaxc_errno(v) (vaxc$errno = (v))
#endif

/* Handy way to vet calls to VMS system services and RTL routines. */
#define _ckvmssts(call) { register unsigned long int __ckvms_sts; \
  if (!((__ckvms_sts=(call))&1)) { \
  set_errno(EVMSERR); set_vaxc_errno(__ckvms_sts); \
  croak("Fatal VMS error at %s, line %d",__FILE__,__LINE__); } }

#ifdef VMS_DO_SOCKETS
#include "sockadapt.h"
#endif

/*
 * The following symbols are defined (or undefined) according to the RTL
 * support VMS provides for the corresponding functions.  These don't
 * appear in config.h, so they're dealt with here.
 */
#define HAS_KILL
#define HAS_WAIT

/*  The VMS C RTL has vfork() but not fork().  Both actually work in a way
 *  that's somewhere between Unix vfork() and VMS lib$spawn(), so it's
 *  probably not a good idea to use them much.  That said, we'll try to
 *  use vfork() in either case.
 */
#define fork vfork

/*
 * fwrite1() should be a routine with the same calling sequence as fwrite(),
 * but which outputs all of the bytes requested as a single stream (unlike
 * fwrite() itself, which on some systems outputs several distinct records
 * if the number_of_items parameter is >1).
 */
#define fwrite1 my_fwrite

/* Use our own rmdir() */
#define rmdir(name) do_rmdir(name)

/* Assorted fiddling with sigs . . . */
# include <signal.h>
#define ABORT() abort()

/* Used with our my_utime() routine in vms.c */
struct utimbuf {
  time_t actime;
  time_t modtime;
};
#define utime my_utime

/* This is what times() returns, but <times.h> calls it tbuffer_t on VMS */

struct tms {
  clock_t tms_utime;    /* user time */
  clock_t tms_stime;    /* system time - always 0 on VMS */
  clock_t tms_cutime;   /* user time, children */
  clock_t tms_cstime;   /* system time, children - always 0 on VMS */
};

/* VMS doesn't use a real sys_nerr, but we need this when scanning for error
 * messages in text strings . . .
 */

#define sys_nerr EVMSERR  /* EVMSERR is as high as we can go. */

/* Look up new %ENV values on the fly */
#define DYNAMIC_ENV_FETCH 1
#define ENV_HV_NAME "%EnV%VmS%"

/* Use our own stat() clones, which handle Unix-style directory names */
#define Stat(name,bufptr) flex_stat(name,bufptr)
#define Fstat(fd,bufptr) flex_fstat(fd,bufptr)

/* Setup for the dirent routines:
 * opendir(), closedir(), readdir(), seekdir(), telldir(), and
 * vmsreaddirversions(), and preprocessor stuff on which these depend:
 *    Written by Rich $alz, <rsalz@bbn.com> in August, 1990.
 *    This code has no copyright.
 */
    /* Data structure returned by READDIR(). */
struct dirent {
    char	d_name[256];		/* File name		*/
    int		d_namlen;			/* Length of d_name */
    int		vms_verscount;		/* Number of versions	*/
    int		vms_versions[20];	/* Version numbers	*/
};

    /* Handle returned by opendir(), used by the other routines.  You
     * are not supposed to care what's inside this structure. */
typedef struct _dirdesc {
    long			context;
    int				vms_wantversions;
    unsigned long int           count;
    char			*pattern;
    struct dirent		entry;
    struct dsc$descriptor_s	pat;
} DIR;

#define rewinddir(dirp)		seekdir((dirp), 0)

/* used for our emulation of getpw* */
struct passwd {
        char    *pw_name;    /* Username */
        char    *pw_passwd;
        Uid_t   pw_uid;      /* UIC member number */
        Gid_t   pw_gid;      /* UIC group  number */
        char    *pw_comment; /* Default device/directory (Unix-style) */
        char    *pw_gecos;   /* Owner */
        char    *pw_dir;     /* Default device/directory (VMS-style) */
        char    *pw_shell;   /* Default CLI name (eg. DCL) */
};
#define pw_unixdir pw_comment  /* Default device/directory (Unix-style) */
#define getpwnam my_getpwnam
#define getpwuid my_getpwuid
#define getpwent my_getpwent
#define endpwent my_endpwent
#define setpwent my_endpwent

/* Our own stat_t substitute, since we play with st_dev and st_ino -
 * we want atomic types so Unix-bound code which compares these fields
 * for two files will work most of the time under VMS
 */
/* First, grab the system types, so we don't clobber them later */
#include <stat.h>
/* Since we've got to match the size of the CRTL's stat_t, we need
 * to mimic DECC's alignment settings.
 */
#if defined(__DECC) || defined(__DECCXX)
#  pragma __member_alignment __save
#  pragma __nomember_alignment
#endif
#if defined(__DECC) 
#  pragma __message __save
#  pragma __message disable (__MISALGNDSTRCT)
#  pragma __message disable (__MISALGNDMEM)
#endif
struct mystat
{
        char *st_devnam;  /* pointer to device name */
        union {
          unsigned short fid[3];
          unsigned long st_ino_mostly;
        } st_inode_u;
        unsigned short st_mode;	/* file "mode" i.e. prot, dir, reg, etc. */
        int	st_nlink;	/* for compatibility - not really used */
        unsigned st_uid;	/* from ACP - QIO uic field */
        unsigned short st_gid;	/* group number extracted from st_uid */
        dev_t   st_rdev;	/* for compatibility - always zero */
        off_t   st_size;	/* file size in bytes */
        unsigned st_atime;	/* file access time; always same as st_mtime */
        unsigned st_mtime;	/* last modification time */
        unsigned st_ctime;	/* file creation time */
        char	st_fab_rfm;	/* record format */
        char	st_fab_rat;	/* record attributes */
        char	st_fab_fsz;	/* fixed header size */
        unsigned st_dev;	/* encoded device name */
};
#ifdef st_ino
#  undef st_ino
#endif
#define st_ino st_inode_u.st_ino_mostly
#define stat mystat
typedef unsigned mydev_t;
#define dev_t mydev_t
typedef unsigned long myino_t;
#define ino_t myino_t
#if defined(__DECC) || defined(__DECCXX)
#  pragma __member_alignment __restore
#endif
#if defined(__DECC) 
#  pragma __message __restore
#endif
/* Cons up a 'delete' bit for testing access */
#define S_IDUSR (S_IWUSR | S_IXUSR)
#define S_IDGRP (S_IWGRP | S_IXGRP)
#define S_IDOTH (S_IWOTH | S_IXOTH)

/* Prototypes for functions unique to vms.c.  Don't include replacements
 * for routines in the mainline source files excluded by #ifndef VMS;
 * their prototypes are already in proto.h.
 *
 * In order to keep Gen_ShrFls.Pl happy, functions which are to be made
 * available to images linked to PerlShr.Exe must be declared between the
 * __VMS_PROTOTYPES__ and __VMS_SEPYTOTORP__ lines, and must be in the form
 *    <data type><TAB>name<WHITESPACE>_((<prototype args>));
 */
typedef char  __VMS_PROTOTYPES__; /* prototype section start marker */
char *	my_getenv _((char *));
unsigned long int	waitpid _((unsigned long int, int *, int));
char *	my_gconvert _((double, int, int, char *));
int	do_rmdir _((char *));
int	kill_file _((char *));
int	my_utime _((char *, struct utimbuf *));
char *	fileify_dirspec _((char *, char *));
char *	fileify_dirspec_ts _((char *, char *));
char *	pathify_dirspec _((char *, char *));
char *	pathify_dirspec_ts _((char *, char *));
char *	tounixspec _((char *, char *));
char *	tounixspec_ts _((char *, char *));
char *	tovmsspec _((char *, char *));
char *	tovmsspec_ts _((char *, char *));
char *	tounixpath _((char *, char *));
char *	tounixpath_ts _((char *, char *));
char *	tovmspath _((char *, char *));
char *	tovmspath_ts _((char *, char *));
void	getredirection _(());
DIR *	opendir _((char *));
struct dirent *	readdir _((DIR *));
long	telldir _((DIR *));
void	seekdir _((DIR *, long));
void	closedir _((DIR *));
void	vmsreaddirversions _((DIR *, int));
void	getredirection _((int *, char ***));
I32	cando_by_name _((I32, I32, char *));
int	flex_fstat _((int, struct stat *));
int	flex_stat _((char *, struct stat *));
int	trim_unixpath _((char *, char*));
bool	vms_do_aexec _((SV *, SV **, SV **));
bool	vms_do_exec _((char *));
unsigned long int	do_aspawn _((SV *, SV **, SV **));
unsigned long int	do_spawn _((char *));
int	my_fwrite _((void *, size_t, size_t, FILE *));
struct passwd *	my_getpwnam _((char *name));
struct passwd *	my_getpwuid _((Uid_t uid));
struct passwd *	my_getpwent _(());
void	my_endpwent _(());
void	init_os_extras _(());
typedef char __VMS_SEPYTOTORP__; /* prototype section end marker */

#ifndef VMS_DO_SOCKETS
/* This relies on tricks in perl.h to pick up that these manifest constants
 * are undefined and set up conversion routines.  It will then redefine
 * these manifest constants, so the actual values will match config.h
 */
#undef HAS_HTONS
#undef HAS_NTOHS
#undef HAS_HTONL
#undef HAS_NTOHL
#endif

#endif  /* __vmsish_h_included */
Commit	Line	Data
a0d0e21e	1	/* vmsish.h
	2	*
	3	* VMS-specific C header file for perl5.
	4	*
748a9306	5	* Last revised: 12-Dec-1994 by Charles Bailey bailey@genetics.upenn.edu
a0d0e21e	6	*/
	7
	8	#ifndef __vmsish_h_included
	9	#define __vmsish_h_included
	10
	11	#include <descrip.h> /* for dirent struct definitions */
748a9306	12	#include <libdef.h> /* status codes for various places */
	13	#include <rmsdef.h> /* at which errno and vaxc$errno are */
	14	#include <ssdef.h> /* explicitly set in the perl source code */
	15
	16	/* DEC's C compilers and gcc use incompatible definitions of _to(upp\|low)er() */
	17	#ifdef _toupper
	18	# undef _toupper
	19	#endif
	20	#define _toupper(c) (((c) < 'a' \|\| (c) > 'z') ? (c) : (c) & ~040)
	21	#ifdef _tolower
	22	# undef _tolower
	23	#endif
	24	#define _tolower(c) (((c) < 'A' \|\| (c) > 'Z') ? (c) : (c) \| 040)
a0d0e21e	25
	26	/* Assorted things to look like Unix */
	27	#ifdef __GNUC__
	28	#ifndef _IOLBF /* gcc's stdio.h doesn't define this */
	29	#define _IOLBF 1
	30	#endif
748a9306	31	#endif
a0d0e21e	32	#include <processes.h> /* for vfork() */
a0d0e21e	33	#include <unixio.h>
a0d0e21e	34	#include <unixlib.h>
a0d0e21e	35	#include <file.h> /* it's not <sys/file.h>, so don't use I_SYS_FILE */
748a9306	36	#define unlink kill_file
	37
	38	/* Macros to set errno using the VAX thread-safe calls, if present */
	39	#if (defined(__DECC) \|\| defined(__DECCXX)) && !defined(__ALPHA)
	40	# define set_errno(v) (cma$tis_errno_set_value(v))
	41	# define set_vaxc_errno(v) (vaxc$errno = (v))
	42	#else
	43	# define set_errno(v) (errno = (v))
	44	# define set_vaxc_errno(v) (vaxc$errno = (v))
	45	#endif
	46
	47	/* Handy way to vet calls to VMS system services and RTL routines. */
	48	#define _ckvmssts(call) { register unsigned long int __ckvms_sts; \
	49	if (!((__ckvms_sts=(call))&1)) { \
	50	set_errno(EVMSERR); set_vaxc_errno(__ckvms_sts); \
	51	croak("Fatal VMS error at %s, line %d",__FILE__,__LINE__); } }
a0d0e21e	52
	53	#ifdef VMS_DO_SOCKETS
	54	#include "sockadapt.h"
	55	#endif
	56
	57	/*
	58	* The following symbols are defined (or undefined) according to the RTL
	59	* support VMS provides for the corresponding functions. These don't
	60	* appear in config.h, so they're dealt with here.
	61	*/
	62	#define HAS_KILL
	63	#define HAS_WAIT
	64
	65	/* The VMS C RTL has vfork() but not fork(). Both actually work in a way
	66	* that's somewhere between Unix vfork() and VMS lib$spawn(), so it's
	67	* probably not a good idea to use them much. That said, we'll try to
	68	* use vfork() in either case.
	69	*/
	70	#define fork vfork
	71
	72	/*
	73	* fwrite1() should be a routine with the same calling sequence as fwrite(),
	74	* but which outputs all of the bytes requested as a single stream (unlike
	75	* fwrite() itself, which on some systems outputs several distinct records
	76	* if the number_of_items parameter is >1).
	77	*/
	78	#define fwrite1 my_fwrite
	79
	80	/* Use our own rmdir() */
	81	#define rmdir(name) do_rmdir(name)
	82
	83	/* Assorted fiddling with sigs . . . */
	84	# include <signal.h>
	85	#define ABORT() abort()
	86
748a9306	87	/* Used with our my_utime() routine in vms.c */
	88	struct utimbuf {
	89	time_t actime;
	90	time_t modtime;
	91	};
	92	#define utime my_utime
	93
a0d0e21e	94	/* This is what times() returns, but <times.h> calls it tbuffer_t on VMS */
	95
	96	struct tms {
	97	clock_t tms_utime; /* user time */
	98	clock_t tms_stime; /* system time - always 0 on VMS */
	99	clock_t tms_cutime; /* user time, children */
	100	clock_t tms_cstime; /* system time, children - always 0 on VMS */
	101	};
	102
	103	/* VMS doesn't use a real sys_nerr, but we need this when scanning for error
	104	* messages in text strings . . .
	105	*/
	106
	107	#define sys_nerr EVMSERR /* EVMSERR is as high as we can go. */
	108
	109	/* Look up new %ENV values on the fly */
	110	#define DYNAMIC_ENV_FETCH 1
	111	#define ENV_HV_NAME "%EnV%VmS%"
	112
	113	/* Use our own stat() clones, which handle Unix-style directory names */
	114	#define Stat(name,bufptr) flex_stat(name,bufptr)
	115	#define Fstat(fd,bufptr) flex_fstat(fd,bufptr)
	116
	117	/* Setup for the dirent routines:
	118	* opendir(), closedir(), readdir(), seekdir(), telldir(), and
	119	* vmsreaddirversions(), and preprocessor stuff on which these depend:
	120	* Written by Rich $alz, <rsalz@bbn.com> in August, 1990.
	121	* This code has no copyright.
	122	*/
	123	/* Data structure returned by READDIR(). */
	124	struct dirent {
	125	char d_name[256]; /* File name */
	126	int d_namlen; /* Length of d_name */
	127	int vms_verscount; /* Number of versions */
	128	int vms_versions[20]; /* Version numbers */
	129	};
	130
	131	/* Handle returned by opendir(), used by the other routines. You
	132	* are not supposed to care what's inside this structure. */
	133	typedef struct _dirdesc {
	134	long context;
	135	int vms_wantversions;
	136	unsigned long int count;
	137	char *pattern;
	138	struct dirent entry;
	139	struct dsc$descriptor_s pat;
	140	} DIR;
	141
	142	#define rewinddir(dirp) seekdir((dirp), 0)
	143
748a9306	144	/* used for our emulation of getpw* */
	145	struct passwd {
	146	char pw_name; / Username */
	147	char *pw_passwd;
	148	Uid_t pw_uid; /* UIC member number */
	149	Gid_t pw_gid; /* UIC group number */
	150	char pw_comment; / Default device/directory (Unix-style) */
	151	char pw_gecos; / Owner */
	152	char pw_dir; / Default device/directory (VMS-style) */
	153	char pw_shell; / Default CLI name (eg. DCL) */
	154	};
	155	#define pw_unixdir pw_comment /* Default device/directory (Unix-style) */
	156	#define getpwnam my_getpwnam
	157	#define getpwuid my_getpwuid
	158	#define getpwent my_getpwent
	159	#define endpwent my_endpwent
	160	#define setpwent my_endpwent
	161
	162	/* Our own stat_t substitute, since we play with st_dev and st_ino -
	163	* we want atomic types so Unix-bound code which compares these fields
	164	* for two files will work most of the time under VMS
	165	*/
	166	/* First, grab the system types, so we don't clobber them later */
	167	#include <stat.h>
	168	/* Since we've got to match the size of the CRTL's stat_t, we need
	169	* to mimic DECC's alignment settings.
	170	*/
	171	#if defined(__DECC) \|\| defined(__DECCXX)
	172	# pragma __member_alignment __save
	173	# pragma __nomember_alignment
	174	#endif
	175	#if defined(__DECC)
	176	# pragma __message __save
	177	# pragma __message disable (__MISALGNDSTRCT)
	178	# pragma __message disable (__MISALGNDMEM)
	179	#endif
	180	struct mystat
	181	{
	182	char st_devnam; / pointer to device name */
	183	union {
	184	unsigned short fid[3];
	185	unsigned long st_ino_mostly;
	186	} st_inode_u;
	187	unsigned short st_mode; /* file "mode" i.e. prot, dir, reg, etc. */
	188	int st_nlink; /* for compatibility - not really used */
	189	unsigned st_uid; /* from ACP - QIO uic field */
	190	unsigned short st_gid; /* group number extracted from st_uid */
	191	dev_t st_rdev; /* for compatibility - always zero */
	192	off_t st_size; /* file size in bytes */
	193	unsigned st_atime; /* file access time; always same as st_mtime */
	194	unsigned st_mtime; /* last modification time */
	195	unsigned st_ctime; /* file creation time */
	196	char st_fab_rfm; /* record format */
	197	char st_fab_rat; /* record attributes */
	198	char st_fab_fsz; /* fixed header size */
	199	unsigned st_dev; /* encoded device name */
	200	};
	201	#ifdef st_ino
	202	# undef st_ino
	203	#endif
	204	#define st_ino st_inode_u.st_ino_mostly
	205	#define stat mystat
	206	typedef unsigned mydev_t;
	207	#define dev_t mydev_t
208	typedef unsigned long myino_t;
209	#define ino_t myino_t
210	#if defined(__DECC) \|\| defined(__DECCXX)
211	# pragma __member_alignment __restore
212	#endif
213	#if defined(__DECC)
214	# pragma __message __restore
215	#endif
216	/* Cons up a 'delete' bit for testing access */
217	#define S_IDUSR (S_IWUSR \| S_IXUSR)
218	#define S_IDGRP (S_IWGRP \| S_IXGRP)
219	#define S_IDOTH (S_IWOTH \| S_IXOTH)
a0d0e21e	220
	221	/* Prototypes for functions unique to vms.c. Don't include replacements
	222	* for routines in the mainline source files excluded by #ifndef VMS;
	223	* their prototypes are already in proto.h.
	224	*
	225	* In order to keep Gen_ShrFls.Pl happy, functions which are to be made
	226	* available to images linked to PerlShr.Exe must be declared between the
	227	* __VMS_PROTOTYPES__ and __VMS_SEPYTOTORP__ lines, and must be in the form
	228	* <data type><TAB>name<WHITESPACE>_((<prototype args>));
	229	*/
	230	typedef char __VMS_PROTOTYPES__; /* prototype section start marker */
	231	char * my_getenv _((char *));
a0d0e21e	232	unsigned long int waitpid _((unsigned long int, int *, int));
a0d0e21e	233	char * my_gconvert _((double, int, int, char *));
	234	int do_rmdir _((char *));
	235	int kill_file _((char *));
748a9306	236	int my_utime _((char , struct utimbuf ));
a0d0e21e	237	char * fileify_dirspec _((char , char ));
	238	char * fileify_dirspec_ts _((char , char ));
	239	char * pathify_dirspec _((char , char ));
	240	char * pathify_dirspec_ts _((char , char ));
	241	char * tounixspec _((char , char ));
	242	char * tounixspec_ts _((char , char ));
	243	char * tovmsspec _((char , char ));
	244	char * tovmsspec_ts _((char , char ));
	245	char * tounixpath _((char , char ));
	246	char * tounixpath_ts _((char , char ));
	247	char * tovmspath _((char , char ));
	248	char * tovmspath_ts _((char , char ));
	249	void getredirection _(());
	250	DIR * opendir _((char *));
	251	struct dirent * readdir _((DIR *));
	252	long telldir _((DIR *));
	253	void seekdir _((DIR *, long));
	254	void closedir _((DIR *));
	255	void vmsreaddirversions _((DIR *, int));
	256	void getredirection _((int , char **));
748a9306	257	I32 cando_by_name _((I32, I32, char *));
	258	int flex_fstat _((int, struct stat *));
	259	int flex_stat _((char , struct stat ));
a0d0e21e	260	int trim_unixpath _((char , char));
748a9306	261	bool vms_do_aexec _((SV , SV , SV *));
a0d0e21e	262	bool vms_do_exec _((char *));
748a9306	263	unsigned long int do_aspawn _((SV , SV , SV *));
a0d0e21e	264	unsigned long int do_spawn _((char *));
a0d0e21e	265	int my_fwrite _((void , size_t, size_t, FILE ));
748a9306	266	struct passwd * my_getpwnam _((char *name));
	267	struct passwd * my_getpwuid _((Uid_t uid));
	268	struct passwd * my_getpwent _(());
	269	void my_endpwent _(());
	270	void init_os_extras _(());
a0d0e21e	271	typedef char __VMS_SEPYTOTORP__; /* prototype section end marker */
	272
	273	#ifndef VMS_DO_SOCKETS
748a9306	274	/* This relies on tricks in perl.h to pick up that these manifest constants
	275	* are undefined and set up conversion routines. It will then redefine
	276	* these manifest constants, so the actual values will match config.h
	277	*/
	278	#undef HAS_HTONS
	279	#undef HAS_NTOHS
	280	#undef HAS_HTONL
	281	#undef HAS_NTOHL
a0d0e21e	282	#endif
	283
	284	#endif /* __vmsish_h_included */