ext/DynaLoader/dl_vms.xs

   1 /* dl_vms.xs
   2  *
   3  * Platform:  OpenVMS, VAX or AXP or IA64
   4  * Author:    Charles Bailey  bailey@newman.upenn.edu
   5  * Revised:   See http://public.activestate.com/cgi-bin/perlbrowse
   6  *
   7  *                           Implementation Note
   8  *     This section is added as an aid to users and DynaLoader developers, in
   9  * order to clarify the process of dynamic linking under VMS.
  10  *     dl_vms.xs uses the supported VMS dynamic linking call, which allows
  11  * a running program to map an arbitrary file of executable code and call
  12  * routines within that file.  This is done via the VMS RTL routine
  13  * lib$find_image_symbol, whose calling sequence is as follows:
  14  *   status = lib$find_image_symbol(imgname,symname,symval,defspec);
  15  *   where
  16  *     status  = a standard VMS status value (unsigned long int)
  17  *     imgname = a fixed-length string descriptor, passed by
  18  *               reference, containing the NAME ONLY of the image
  19  *               file to be mapped.  An attempt will be made to
  20  *               translate this string as a logical name, so it may
  21  *               not contain any characters which are not allowed in
  22  *               logical names.  If no translation is found, imgname
  23  *               is used directly as the name of the image file.
  24  *     symname = a fixed-length string descriptor, passed by
  25  *               reference, containing the name of the routine
  26  *               to be located.
  27  *     symval  = an unsigned long int, passed by reference, into
  28  *               which is written the entry point address of the
  29  *               routine whose name is specified in symname.
  30  *     defspec = a fixed-length string descriptor, passed by
  31  *               reference, containing a default file specification
  32  *               whichis used to fill in any missing parts of the
  33  *               image file specification after the imgname argument
  34  *               is processed.
  35  * In order to accommodate the handling of the imgname argument, the routine
  36  * dl_expandspec() is provided for use by perl code (e.g. dl_findfile)
  37  * which wants to see what image file lib$find_image_symbol would use if
  38  * it were passed a given file specification.  The file specification passed
  39  * to dl_expandspec() and dl_load_file() can be partial or complete, and can
  40  * use VMS or Unix syntax; these routines perform the necessary conversions.
  41  *    In general, writers of perl extensions need only conform to the
  42  * procedures set out in the DynaLoader documentation, and let the details
  43  * be taken care of by the routines here and in DynaLoader.pm.  If anyone
  44  * comes across any incompatibilities, please let me know.  Thanks.
  45  *
  46  */
  47
  48 #include "EXTERN.h"
  49 #include "perl.h"
  50 #include "XSUB.h"
  51
  52 #include <descrip.h>
  53 #include <fscndef.h>
  54 #include <lib$routines.h>
  55 #include <rms.h>
  56 #include <ssdef.h>
  57 #include <starlet.h>
  58
  59 #if defined(VMS_WE_ARE_CASE_SENSITIVE)
  60 #define DL_CASE_SENSITIVE 1<<4
  61 #else
  62 #define DL_CASE_SENSITIVE 0
  63 #endif
  64
  65 typedef unsigned long int vmssts;
  66
  67 struct libref {
  68   struct dsc$descriptor_s name;
  69   struct dsc$descriptor_s defspec;
  70 };
  71
  72 typedef struct {
  73     AV *        x_require_symbols;
  74 /* "Static" data for dl_expand_filespec() - This is static to save
  75  * initialization on each call; if you need context-independence,
  76  * just make these auto variables in dl_expandspec() and dl_load_file()
  77  */
  78     char        x_esa[NAM$C_MAXRSS];
  79     char        x_rsa[NAM$C_MAXRSS];
  80     struct FAB  x_fab;
  81     struct NAM  x_nam;
  82 } my_cxtx_t;            /* this *must* be named my_cxtx_t */
  83
  84 #define DL_CXT_EXTRA    /* ask for dl_cxtx to be defined in dlutils.c */
  85 #include "dlutils.c"    /* dl_debug, dl_last_error; SaveError not used  */
  86
  87 #define dl_require_symbols      (dl_cxtx.x_require_symbols)
  88 #define dl_esa                  (dl_cxtx.x_esa)
  89 #define dl_rsa                  (dl_cxtx.x_rsa)
  90 #define dl_fab                  (dl_cxtx.x_fab)
  91 #define dl_nam                  (dl_cxtx.x_nam)
  92
  93 /* $PutMsg action routine - records error message in dl_last_error */
  94 static vmssts
  95 copy_errmsg(msg,unused)
  96     struct dsc$descriptor_s *   msg;
  97     vmssts  unused;
  98 {
  99     dTHX;
 100     dMY_CXT;
 101     if (*(msg->dsc$a_pointer) == '%') { /* first line */
 102       if (dl_last_error)
 103         strncpy((dl_last_error = saferealloc(dl_last_error,msg->dsc$w_length+1)),
 104                  msg->dsc$a_pointer, msg->dsc$w_length);
 105       else
 106         strncpy((dl_last_error = safemalloc(msg->dsc$w_length+1)),
 107                  msg->dsc$a_pointer, msg->dsc$w_length);
 108       dl_last_error[msg->dsc$w_length] = '\0';
 109     }
 110     else { /* continuation line */
 111       int errlen = strlen(dl_last_error);
 112       dl_last_error = saferealloc(dl_last_error, errlen + msg->dsc$w_length + 2);
 113       dl_last_error[errlen] = '\n';  dl_last_error[errlen+1] = '\0';
 114       strncat(dl_last_error, msg->dsc$a_pointer, msg->dsc$w_length);
 115       dl_last_error[errlen+msg->dsc$w_length+1] = '\0';
 116     }
 117     DLDEBUG(2,PerlIO_printf(Perl_debug_log, "Saved error message: %s\n", dl_last_error));
 118     return 0;
 119 }
 120
 121 /* Use $PutMsg to retrieve error message for failure status code */
 122 static void
 123 dl_set_error(sts,stv)
 124     vmssts  sts;
 125     vmssts  stv;
 126 {
 127     vmssts vec[3];
 128     dTHX;
 129
 130     vec[0] = stv ? 2 : 1;
 131     vec[1] = sts;  vec[2] = stv;
 132     _ckvmssts(sys$putmsg(vec,copy_errmsg,0,0));
 133 }
 134
 135 /* wrapper for lib$find_image_symbol, so signalled errors can be saved
 136  * for dl_error and then returned */
 137 static unsigned long int
 138 my_find_image_symbol(struct dsc$descriptor_s *imgname,
 139                      struct dsc$descriptor_s *symname,
 140                      void (**entry)(),
 141                      struct dsc$descriptor_s *defspec)
 142 {
 143   unsigned long int retsts;
 144   VAXC$ESTABLISH(lib$sig_to_ret);
 145   retsts = lib$find_image_symbol(imgname,symname,entry,defspec,DL_CASE_SENSITIVE);
 146   return retsts;
 147 }
 148
 149
 150 static void
 151 dl_private_init(pTHX)
 152 {
 153     dl_generic_private_init(aTHX);
 154     {
 155         dMY_CXT;
 156         dl_require_symbols = get_av("DynaLoader::dl_require_symbols", 0x4);
 157         /* Set up the static control blocks for dl_expand_filespec() */
 158         dl_fab = cc$rms_fab;
 159         dl_nam = cc$rms_nam;
 160         dl_fab.fab$l_nam = &dl_nam;
 161         dl_nam.nam$l_esa = dl_esa;
 162         dl_nam.nam$b_ess = sizeof dl_esa;
 163         dl_nam.nam$l_rsa = dl_rsa;
 164         dl_nam.nam$b_rss = sizeof dl_rsa;
 165     }
 166 }
 167 MODULE = DynaLoader PACKAGE = DynaLoader
 168
 169 BOOT:
 170     (void)dl_private_init(aTHX);
 171
 172 void
 173 dl_expandspec(filespec)
 174     char *      filespec
 175     CODE:
 176     char vmsspec[NAM$C_MAXRSS], defspec[NAM$C_MAXRSS];
 177     size_t deflen;
 178     vmssts sts;
 179     dMY_CXT;
 180
 181     tovmsspec(filespec,vmsspec);
 182     dl_fab.fab$l_fna = vmsspec;
 183     dl_fab.fab$b_fns = strlen(vmsspec);
 184     dl_fab.fab$l_dna = 0;
 185     dl_fab.fab$b_dns = 0;
 186     DLDEBUG(1,PerlIO_printf(Perl_debug_log, "dl_expand_filespec(%s):\n",vmsspec));
 187     /* On the first pass, just parse the specification string */
 188     dl_nam.nam$b_nop = NAM$M_SYNCHK;
 189     sts = sys$parse(&dl_fab);
 190     DLDEBUG(2,PerlIO_printf(Perl_debug_log, "\tSYNCHK sys$parse = %d\n",sts));
 191     if (!(sts & 1)) {
 192       dl_set_error(dl_fab.fab$l_sts,dl_fab.fab$l_stv);
 193       ST(0) = &PL_sv_undef;
 194     }
 195     else {
 196       /* Now set up a default spec - everything but the name */
 197       deflen = dl_nam.nam$l_name - dl_esa;
 198       memcpy(defspec,dl_esa,deflen);
 199       memcpy(defspec+deflen,dl_nam.nam$l_type,
 200              dl_nam.nam$b_type + dl_nam.nam$b_ver);
 201       deflen += dl_nam.nam$b_type + dl_nam.nam$b_ver;
 202       memcpy(vmsspec,dl_nam.nam$l_name,dl_nam.nam$b_name);
 203       DLDEBUG(2,PerlIO_printf(Perl_debug_log, "\tsplit filespec: name = %.*s, default = %.*s\n",
 204                         dl_nam.nam$b_name,vmsspec,deflen,defspec));
 205       /* . . . and go back to expand it */
 206       dl_nam.nam$b_nop = 0;
 207       dl_fab.fab$l_dna = defspec;
 208       dl_fab.fab$b_dns = deflen;
 209       dl_fab.fab$b_fns = dl_nam.nam$b_name;
 210       sts = sys$parse(&dl_fab);
 211       DLDEBUG(2,PerlIO_printf(Perl_debug_log, "\tname/default sys$parse = %d\n",sts));
 212       if (!(sts & 1)) {
 213         dl_set_error(dl_fab.fab$l_sts,dl_fab.fab$l_stv);
 214         ST(0) = &PL_sv_undef;
 215       }
 216       else {
 217         /* Now find the actual file */
 218         sts = sys$search(&dl_fab);
 219         DLDEBUG(2,PerlIO_printf(Perl_debug_log, "\tsys$search = %d\n",sts));
 220         if (!(sts & 1)) {
 221           dl_set_error(dl_fab.fab$l_sts,dl_fab.fab$l_stv);
 222           ST(0) = &PL_sv_undef;
 223         }
 224         else {
 225           ST(0) = sv_2mortal(newSVpvn(dl_nam.nam$l_rsa,dl_nam.nam$b_rsl));
 226           DLDEBUG(1,PerlIO_printf(Perl_debug_log, "\tresult = \\%.*s\\\n",
 227                             dl_nam.nam$b_rsl,dl_nam.nam$l_rsa));
 228         }
 229       }
 230     }
 231
 232 void
 233 dl_load_file(filename, flags=0)
 234     char *      filename
 235     int         flags
 236     PREINIT:
 237     dTHX;
 238     dMY_CXT;
 239     char vmsspec[NAM$C_MAXRSS];
 240     SV *reqSV, **reqSVhndl;
 241     STRLEN deflen;
 242     struct dsc$descriptor_s
 243       specdsc = {0, DSC$K_DTYPE_T, DSC$K_CLASS_S, 0},
 244       symdsc  = {0, DSC$K_DTYPE_T, DSC$K_CLASS_S, 0};
 245     struct fscnlst {
 246       unsigned short int len;
 247       unsigned short int code;
 248       char *string;
 249     }  namlst[2] = {{0,FSCN$_NAME,0},{0,0,0}};
 250     struct libref *dlptr;
 251     vmssts sts, failed = 0;
 252     void (*entry)();
 253     CODE:
 254
 255     DLDEBUG(1,PerlIO_printf(Perl_debug_log, "dl_load_file(%s,%x):\n", filename,flags));
 256     specdsc.dsc$a_pointer = tovmsspec(filename,vmsspec);
 257     specdsc.dsc$w_length = strlen(specdsc.dsc$a_pointer);
 258     if (specdsc.dsc$w_length == 0) { /* undef in, empty out */
 259         XSRETURN_EMPTY;
 260     }
 261     DLDEBUG(2,PerlIO_printf(Perl_debug_log, "\tVMS-ified filename is %s\n",
 262                       specdsc.dsc$a_pointer));
 263     Newx(dlptr,1,struct libref);
 264     dlptr->name.dsc$b_dtype = dlptr->defspec.dsc$b_dtype = DSC$K_DTYPE_T;
 265     dlptr->name.dsc$b_class = dlptr->defspec.dsc$b_class = DSC$K_CLASS_S;
 266     sts = sys$filescan(&specdsc,namlst,0);
 267     DLDEBUG(2,PerlIO_printf(Perl_debug_log, "\tsys$filescan: returns %d, name is %.*s\n",
 268                       sts,namlst[0].len,namlst[0].string));
 269     if (!(sts & 1)) {
 270       failed = 1;
 271       dl_set_error(sts,0);
 272     }
 273     else {
 274       dlptr->name.dsc$w_length = namlst[0].len;
 275       dlptr->name.dsc$a_pointer = savepvn(namlst[0].string,namlst[0].len);
 276       dlptr->defspec.dsc$w_length = specdsc.dsc$w_length - namlst[0].len;
 277       Newx(dlptr->defspec.dsc$a_pointer, dlptr->defspec.dsc$w_length + 1, char);
 278       deflen = namlst[0].string - specdsc.dsc$a_pointer;
 279       memcpy(dlptr->defspec.dsc$a_pointer,specdsc.dsc$a_pointer,deflen);
 280       memcpy(dlptr->defspec.dsc$a_pointer + deflen,
 281              namlst[0].string + namlst[0].len,
 282              dlptr->defspec.dsc$w_length - deflen);
 283       DLDEBUG(2,PerlIO_printf(Perl_debug_log, "\tlibref = name: %s, defspec: %.*s\n",
 284                         dlptr->name.dsc$a_pointer,
 285                         dlptr->defspec.dsc$w_length,
 286                         dlptr->defspec.dsc$a_pointer));
 287       if (!(reqSVhndl = av_fetch(dl_require_symbols,0,FALSE)) || !(reqSV = *reqSVhndl)) {
 288         DLDEBUG(2,PerlIO_printf(Perl_debug_log, "\t@dl_require_symbols empty, returning untested libref\n"));
 289       }
 290       else {
 291         symdsc.dsc$w_length = SvCUR(reqSV);
 292         symdsc.dsc$a_pointer = SvPVX(reqSV);
 293         DLDEBUG(2,PerlIO_printf(Perl_debug_log, "\t$dl_require_symbols[0] = %.*s\n",
 294                           symdsc.dsc$w_length, symdsc.dsc$a_pointer));
 295         sts = my_find_image_symbol(&(dlptr->name),&symdsc,
 296                                     &entry,&(dlptr->defspec));
 297         DLDEBUG(2,PerlIO_printf(Perl_debug_log, "\tlib$find_image_symbol returns %d\n",sts));
 298         if (!(sts&1)) {
 299           failed = 1;
 300           dl_set_error(sts,0);
 301         }
 302       }
 303     }
 304
 305     if (failed) {
 306       Safefree(dlptr->name.dsc$a_pointer);
 307       Safefree(dlptr->defspec.dsc$a_pointer);
 308       Safefree(dlptr);
 309       ST(0) = &PL_sv_undef;
 310     }
 311     else {
 312       ST(0) = sv_2mortal(newSViv(PTR2IV(dlptr)));
 313     }
 314
 315
 316 void
 317 dl_find_symbol(librefptr,symname)
 318     void *      librefptr
 319     SV *        symname
 320     CODE:
 321     struct libref thislib = *((struct libref *)librefptr);
 322     struct dsc$descriptor_s
 323       symdsc = {SvCUR(symname),DSC$K_DTYPE_T,DSC$K_CLASS_S,SvPVX(symname)};
 324     void (*entry)();
 325     vmssts sts;
 326
 327     DLDEBUG(1,PerlIO_printf(Perl_debug_log, "dl_find_symbol(%.*s,%.*s):\n",
 328                       thislib.name.dsc$w_length, thislib.name.dsc$a_pointer,
 329                       symdsc.dsc$w_length,symdsc.dsc$a_pointer));
 330     sts = my_find_image_symbol(&(thislib.name),&symdsc,
 331                                &entry,&(thislib.defspec));
 332     DLDEBUG(2,PerlIO_printf(Perl_debug_log, "\tlib$find_image_symbol returns %d\n",sts));
 333     DLDEBUG(2,PerlIO_printf(Perl_debug_log, "\tentry point is %d\n",
 334                       (unsigned long int) entry));
 335     if (!(sts & 1)) {
 336       dl_set_error(sts,0);
 337       ST(0) = &PL_sv_undef;
 338     }
 339     else ST(0) = sv_2mortal(newSViv(PTR2IV(entry)));
 340
 341
 342 void
 343 dl_undef_symbols()
 344     PPCODE:
 345
 346
 347 # These functions should not need changing on any platform:
 348
 349 void
 350 dl_install_xsub(perl_name, symref, filename="$Package")
 351     char *      perl_name
 352     void *      symref
 353     const char *        filename
 354     CODE:
 355     DLDEBUG(2,PerlIO_printf(Perl_debug_log, "dl_install_xsub(name=%s, symref=%x)\n",
 356         perl_name, symref));
 357     ST(0) = sv_2mortal(newRV((SV*)newXS_flags(perl_name,
 358                                               (void(*)(pTHX_ CV *))symref,
 359                                               filename, NULL,
 360                                               XS_DYNAMIC_FILENAME)));
 361
 362
 363 char *
 364 dl_error()
 365     CODE:
 366     dMY_CXT;
 367     RETVAL = dl_last_error ;
 368     OUTPUT:
 369       RETVAL
 370
 371 # end.