This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Fix an error, spotted by Tim Bunce.
[perl5.git] / vms / vmsish.h
index 41b2bb2..af70f06 100644 (file)
@@ -2,8 +2,12 @@
  *
  * VMS-specific C header file for perl5.
  *
- * Last revised: 16-Sep-1998 by Charles Bailey  bailey@newman.upenn.edu
+ * revised: 16-Sep-1998 by Charles Bailey  bailey@newman.upenn.edu
  * Version: 5.5.2
+ *
+ * Last revised: 10-Oct-2005 by John Malmberg (HP OpenVMS) wb8twy@qsl.net
+ *                          Add SYMLINK support, and updated Craig Berry's
+ *                          largefile support.
  */
 
 #ifndef __vmsish_h_included
 #  define DONT_MASK_RTL_CALLS
 #endif
 
+#include <namdef.h>
+
+/* Set the maximum filespec size here as it is larger for EFS file
+ * specifications.
+ */
+#ifndef __VAX
+#ifndef VMS_MAXRSS
+#ifdef NAML$C_MAXRSS
+#define VMS_MAXRSS (NAML$C_MAXRSS+1)
+#ifndef VMS_LONGNAME_SUPPORT
+#define VMS_LONGNAME_SUPPORT 1
+#endif /* VMS_LONGNAME_SUPPORT */
+#endif /* NAML$C_MAXRSS */
+#endif /* VMS_MAXRSS */
+#endif
+
+#ifndef VMS_MAXRSS
+#define VMS_MAXRSS (NAM$C_MAXRSS + 1)
+#endif
+
+#ifndef MAXPATHLEN
+#define MAXPATHLEN (VMS_MAXRSS - 1)
+#endif
+
+
 /* Note that we do, in fact, have this */
 #define HAS_GETENV_SV
 #define HAS_GETENV_LEN
 #define my_utime               Perl_my_utime
 #define my_chdir               Perl_my_chdir
 #define do_aspawn              Perl_do_aspawn
-#define seekdir                Perl_seekdir
+#define seekdir                        Perl_seekdir
 #define my_gmtime              Perl_my_gmtime
 #define my_localtime           Perl_my_localtime
-#define my_time                Perl_my_time
+#define my_time                        Perl_my_time
 #define do_spawn               Perl_do_spawn
 #define flex_fstat             Perl_flex_fstat
 #define flex_stat              Perl_flex_stat
+#define flex_lstat             Perl_flex_lstat
 #define cando_by_name          Perl_cando_by_name
 #define my_getpwnam            Perl_my_getpwnam
 #define my_getpwuid            Perl_my_getpwuid
 #define readdir_r(a,b,c)       Perl_readdir_r(aTHX_ a,b,c)
 #endif
 #define my_gconvert            Perl_my_gconvert
-#define telldir                Perl_telldir
+#define telldir                        Perl_telldir
 #define closedir               Perl_closedir
 #define vmsreaddirversions     Perl_vmsreaddirversions
 #define my_sigemptyset        Perl_my_sigemptyset
 #define my_getpwent()          Perl_my_getpwent(aTHX)
 #define my_endpwent()          Perl_my_endpwent(aTHX)
 #define my_getlogin            Perl_my_getlogin
-#define init_os_extras Perl_init_os_extras
+#define init_os_extras         Perl_init_os_extras
+#define vms_realpath(a, b)     Perl_vms_realpath(aTHX_ a,b)
+#define vms_case_tolerant(a)   Perl_vms_case_tolerant(a)
 
 /* Delete if at all possible, changing protections if necessary. */
 #define unlink kill_file
 #define HAVE_INTERP_INTERN
 struct interp_intern {
     int    hushed;
+    int           posix_exit;
     double inv_rand_max;
 };
 #define VMSISH_HUSHED     (PL_sys_intern.hushed)
 #define MY_INV_RAND_MAX   (PL_sys_intern.inv_rand_max)
+#define MY_POSIX_EXIT  (PL_sys_intern.posix_exit)
 
 /* Flags for vmstrnenv() */
 #define PERL__TRNENV_SECURE 0x01
@@ -330,9 +364,13 @@ struct interp_intern {
 #define PERL_SOCK_SYSWRITE_IS_SEND
 #endif
 
+#if __CRTL_VER < 70000000
 #define BIT_BUCKET "_NLA0:"
+#else
+#define BIT_BUCKET "/dev/null"
+#endif
 #define PERL_SYS_INIT(c,v)     MALLOC_CHECK_TAINT2(*c,*v) vms_image_init((c),(v)); MALLOC_INIT
-#define PERL_SYS_TERM()                OP_REFCNT_TERM; MALLOC_TERM
+#define PERL_SYS_TERM()                HINTS_REFCNT_TERM; OP_REFCNT_TERM; MALLOC_TERM
 #define dXSUB_SYS
 #define HAS_KILL
 #define HAS_WAIT
@@ -414,6 +452,12 @@ struct interp_intern {
 *      This symbol is defined if this system has a stat structure declaring
 *      st_rdev
 *      VMS: Field exists in POSIXish version of struct stat(), but is not used.
+*
+*  No definition of what value an operating system or file system should
+*  put in the st_rdev field has been found by me so far.  Examination of
+*  LINUX source code indicates that the value is both very platform and
+*  file system specific, with many filesystems just putting 1 or 0 in it.
+*  J. Malmberg.
 */
 #undef USE_STAT_RDEV           /**/
 
@@ -437,18 +481,26 @@ struct interp_intern {
 #define Fflush(fp) my_flush(fp)
 
 /* Use our own rmdir() */
+#ifndef DONT_MASK_RTL_CALLS
 #define rmdir(name) do_rmdir(name)
+#endif
 
 /* Assorted fiddling with sigs . . . */
 # include <signal.h>
 #define ABORT() abort()
 
+#ifdef I_UTIME
+#include <utime.h>
+#else
 /* Used with our my_utime() routine in vms.c */
 struct utimbuf {
   time_t actime;
   time_t modtime;
 };
+#endif
+#ifndef DONT_MASK_RTL_CALLS
 #define utime my_utime
+#endif
 
 /* This is what times() returns, but <times.h> calls it tbuffer_t on VMS
  * prior to v7.0.  We check the DECC manifest to see whether it's already
@@ -548,16 +600,26 @@ struct utimbuf {
 /* Use our own stat() clones, which handle Unix-style directory names */
 #define Stat(name,bufptr) flex_stat(name,bufptr)
 #define Fstat(fd,bufptr) Perl_flex_fstat(aTHX_ fd,bufptr)
+#ifndef DONT_MASK_RTL_CALLS
+#define lstat(name, bufptr) Perl_flex_lstat(name, bufptr)
+#endif
 
 /* 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.
+ *
  */
+
+/* Flags for the _dirdesc structure */
+#define PERL_VMSDIR_M_VERSIONS         0x02 /* Want VMS versions */
+#define PERL_VMSDIR_M_UNIXSPECS                0x04 /* Want UNIX specifications */
+
+
     /* Data structure returned by READDIR(). */
 struct dirent {
     char       d_name[256];            /* File name            */
-    int                d_namlen;                       /* Length of d_name */
+    int                d_namlen;               /* Length of d_name */
     int                vms_verscount;          /* Number of versions   */
     int                vms_versions[20];       /* Version numbers      */
 };
@@ -566,7 +628,7 @@ struct dirent {
      * are not supposed to care what's inside this structure. */
 typedef struct _dirdesc {
     long                       context;
-    int                                vms_wantversions;
+    int                                flags;
     unsigned long int           count;
     char                       *pattern;
     struct dirent              entry;
@@ -574,6 +636,7 @@ typedef struct _dirdesc {
     void                       *mutex;
 } DIR;
 
+
 #define rewinddir(dirp)                seekdir((dirp), 0)
 
 /* used for our emulation of getpw* */
@@ -609,96 +672,61 @@ struct passwd {
 #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.
+ *
+ * The simplest thing is to just put a wrapper around the stat structure
+ * supplied by the CRTL and use #defines to redirect references to the
+ * members to the real names.
  */
-#ifdef USE_LARGE_FILES
-/* Mimic the new stat structure, filler fields, and alignment. */
+
 #if defined(__DECC) || defined(__DECCXX)
 #  pragma __member_alignment __save
 #  pragma member_alignment
 #endif
 
-struct mystat
-{
-        char *st_devnam;       /* pointer to device name */
-        char *st_fill_dev;
-        unsigned st_ino;        /* hack - CRTL uses unsigned short[3] for */
-        unsigned short rvn;     /* FID (num,seq,rvn) */
-        unsigned short st_fill_ino;
-        unsigned short st_mode; /* file "mode" i.e. prot, dir, reg, etc. */
-        unsigned short st_fill_mode;
-        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 */
-        unsigned short st_fill_gid;
-        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_fill_atime;
-        unsigned st_mtime;      /* last modification time */
-        unsigned st_fill_mtime;
-        unsigned st_ctime;      /* file creation time */
-        unsigned st_fill_ctime;
-        char    st_fab_rfm;     /* record format */
-        char    st_fab_rat;     /* record attributes */
-        char    st_fab_fsz;     /* fixed header size */
-        char    st_fab_fill;
-        unsigned st_fab_mrs;    /* record size */
-        int st_fill_expand[7];  /* will probably fill from beginning, so put our st_dev at end */
-        unsigned st_dev;        /* encoded device name */
-};
-
-#else /* !defined(USE_LARGE_FILES) */
-
-#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)
+typedef unsigned mydev_t;
+#ifndef _LARGEFILE
+typedef unsigned myino_t;
+#else
+typedef __ino64_t myino_t;
 #endif
 
 struct mystat
 {
-        char *st_devnam;  /* pointer to device name */
-        unsigned st_ino;    /* hack - CRTL uses unsigned short[3] for */
-        unsigned short rvn; /* FID (num,seq,rvn) */
-        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 */
-        /* Pad struct out to integral number of longwords, since DECC 5.6/VAX
-         * has a bug in dealing with offsets in structs in which are embedded
-         * other structs whose size is an odd number of bytes.  (An even
-         * number of bytes is enough to make it happy, but we go for natural
-         * alignment anyhow.)
-         */
-        char   st_fill1[sizeof(void *) - (3*sizeof(unsigned short) + 3*sizeof(char))%sizeof(void *)];
+    struct stat crtl_stat;
+    myino_t st_ino;
+#ifndef _LARGEFILE
+    unsigned rvn; /* FID (num,seq,rvn) + pad */
+#endif
+    mydev_t st_dev;
+    char st_devnam[256]; /* Cache the (short) VMS name */
 };
 
-#if defined(__DECC) 
-#  pragma __message __restore
+#define st_mode crtl_stat.st_mode
+#define st_nlink crtl_stat.st_nlink
+#define st_uid crtl_stat.st_uid
+#define st_gid crtl_stat.st_gid
+#define st_rdev crtl_stat.st_rdev
+#define st_size crtl_stat.st_size
+#define st_atime crtl_stat.st_atime
+#define st_mtime crtl_stat.st_mtime
+#define st_ctime crtl_stat.st_ctime
+#define st_fab_rfm crtl_stat.st_fab_rfm
+#define st_fab_rat crtl_stat.st_fab_rat
+#define st_fab_fsz crtl_stat.st_fab_fsz
+#define st_fab_mrs crtl_stat.st_fab_mrs
+
+#ifdef _USE_STD_STAT
+#define VMS_INO_T_COMPARE(__a, __b) (__a != __b)
+#define VMS_INO_T_COPY(__a, __b) __a = __b
+#else
+#define VMS_INO_T_COMPARE(__a, __b) memcmp(&__a, &__b, 6)
+#define VMS_INO_T_COPY(__a, __b) memcpy(&__a, &__b, 6)
 #endif
 
-#endif /* defined(USE_LARGE_FILES) */
-
 #if defined(__DECC) || defined(__DECCXX)
 #  pragma __member_alignment __restore
 #endif
 
-typedef unsigned mydev_t;
-typedef unsigned myino_t;
-
 /*
  * DEC C previous to 6.0 corrupts the behavior of the /prefix
  * qualifier with the extern prefix pragma.  This provisional
@@ -762,11 +790,14 @@ typedef unsigned myino_t;
 
 void   prime_env_iter (void);
 void   init_os_extras (void);
-int    vms_status_to_unix(int vms_status);
+int    Perl_vms_status_to_unix(int vms_status, int child_flag);
+int    Perl_unix_status_to_vms(int unix_status);
 /* prototype section start marker; `typedef' passes through cpp */
 typedef char  __VMS_PROTOTYPES__;
 int    Perl_vmstrnenv (const char *, char *, unsigned long int, struct dsc$descriptor_s **, unsigned long int);
+char * Perl_vms_realpath (pTHX_ const char *, char *);
 #if !defined(PERL_IMPLICIT_CONTEXT)
+int    Perl_vms_case_tolerant(void);
 char * Perl_my_getenv (const char *, bool);
 int    Perl_my_trnlnm (const char *, char *, unsigned long int);
 char * Perl_tounixspec (const char *, char *);
@@ -785,7 +816,7 @@ char *      Perl_pathify_dirspec_ts (const char *, char *);
 char * Perl_rmsexpand (const char *, char *, const char *, unsigned);
 char * Perl_rmsexpand_ts (const char *, char *, const char *, unsigned);
 int    Perl_trim_unixpath (char *, const char*, int);
-DIR  Perl_opendir (const char *);
+DIR  * Perl_opendir (const char *);
 int    Perl_rmscopy (const char *, const char *, int);
 int    Perl_my_mkdir (const char *, Mode_t);
 bool   Perl_vms_do_aexec (SV *, SV **, SV **);
@@ -808,11 +839,12 @@ char *    Perl_pathify_dirspec_ts (pTHX_ const char *, char *);
 char * Perl_rmsexpand (pTHX_ const char *, char *, const char *, unsigned);
 char * Perl_rmsexpand_ts (pTHX_ const char *, char *, const char *, unsigned);
 int    Perl_trim_unixpath (pTHX_ char *, const char*, int);
-DIR *  Perl_opendir (pTHX_ const char *);
+DIR * Perl_opendir (pTHX_ const char *);
 int    Perl_rmscopy (pTHX_ const char *, const char *, int);
 int    Perl_my_mkdir (pTHX_ const char *, Mode_t);
 bool   Perl_vms_do_aexec (pTHX_ SV *, SV **, SV **);
 #endif
+int    Perl_vms_case_tolerant(void);
 char * Perl_my_getenv_len (pTHX_ const char *, unsigned long *, bool);
 int    Perl_vmssetenv (pTHX_ const char *, const char *, struct dsc$descriptor_s **);
 void   Perl_vmssetuserlnm(pTHX_ const char *name, const char *eqv);
@@ -834,9 +866,9 @@ int Perl_my_utime (pTHX_ const char *, const struct utimbuf *);
 void   Perl_vms_image_init (int *, char ***);
 struct dirent *        Perl_readdir (pTHX_ DIR *);
 int    Perl_readdir_r(pTHX_ DIR *, struct dirent *, struct dirent **);
-long   telldir (DIR *);
+long   Perl_telldir (DIR *);
 void   Perl_seekdir (pTHX_ DIR *, long);
-void   closedir (DIR *);
+void   Perl_closedir (DIR *);
 void   vmsreaddirversions (DIR *, int);
 struct tm *    Perl_my_gmtime (pTHX_ const time_t *);
 struct tm *    Perl_my_localtime (pTHX_ const time_t *);
@@ -849,8 +881,9 @@ int     my_sigdelset   (sigset_t *, int);
 int     my_sigismember (sigset_t *, int);
 int     my_sigprocmask (int, sigset_t *, sigset_t *);
 #endif
-I32    Perl_cando_by_name (pTHX_ I32, Uid_t, const char *);
+I32    Perl_cando_by_name (pTHX_ I32, bool, const char *);
 int    Perl_flex_fstat (pTHX_ int, Stat_t *);
+int    Perl_flex_lstat (pTHX_ const char *, Stat_t *);
 int    Perl_flex_stat (pTHX_ const char *, Stat_t *);
 int    my_vfork (void);
 bool   Perl_vms_do_exec (pTHX_ const char *);
@@ -900,4 +933,10 @@ typedef char __VMS_SEPYTOTORP__;
 
 #define NO_ENVIRON_ARRAY
 
+/* RMSEXPAND options */
+#define PERL_RMSEXPAND_M_VMS           0x02 /* Force output to VMS format */
+#define PERL_RMSEXPAND_M_LONG          0x04 /* Expand to long name format */
+#define PERL_RMSEXPAND_M_VMS_IN                0x08 /* Assume input is VMS already */
+#define PERL_RMSEXPAND_M_SYMLINK       0x20 /* Use symbolic link, not target */
+
 #endif  /* __vmsish_h_included */