Add a "_up" -> "_up_ref" change to libeay.num that was missing from the
[openssl.git] / crypto / dso / dso_vms.c
1 /* dso_vms.c */
2 /* Written by Richard Levitte (richard@levitte.org) for the OpenSSL
3  * project 2000.
4  */
5 /* ====================================================================
6  * Copyright (c) 2000 The OpenSSL Project.  All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  *
12  * 1. Redistributions of source code must retain the above copyright
13  *    notice, this list of conditions and the following disclaimer. 
14  *
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in
17  *    the documentation and/or other materials provided with the
18  *    distribution.
19  *
20  * 3. All advertising materials mentioning features or use of this
21  *    software must display the following acknowledgment:
22  *    "This product includes software developed by the OpenSSL Project
23  *    for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
24  *
25  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
26  *    endorse or promote products derived from this software without
27  *    prior written permission. For written permission, please contact
28  *    licensing@OpenSSL.org.
29  *
30  * 5. Products derived from this software may not be called "OpenSSL"
31  *    nor may "OpenSSL" appear in their names without prior written
32  *    permission of the OpenSSL Project.
33  *
34  * 6. Redistributions of any form whatsoever must retain the following
35  *    acknowledgment:
36  *    "This product includes software developed by the OpenSSL Project
37  *    for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
38  *
39  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
40  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
41  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
42  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
43  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
44  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
45  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
46  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
47  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
48  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
49  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
50  * OF THE POSSIBILITY OF SUCH DAMAGE.
51  * ====================================================================
52  *
53  * This product includes cryptographic software written by Eric Young
54  * (eay@cryptsoft.com).  This product includes software written by Tim
55  * Hudson (tjh@cryptsoft.com).
56  *
57  */
58
59 #include <stdio.h>
60 #include <string.h>
61 #include <errno.h>
62 #include "cryptlib.h"
63 #include <openssl/dso.h>
64 #ifdef OPENSSL_SYS_VMS
65 #pragma message disable DOLLARID
66 #include <lib$routines.h>
67 #include <stsdef.h>
68 #include <descrip.h>
69 #include <starlet.h>
70 #endif
71
72 #ifndef OPENSSL_SYS_VMS
73 DSO_METHOD *DSO_METHOD_vms(void)
74         {
75         return NULL;
76         }
77 #else
78 #pragma message disable DOLLARID
79
80 static int vms_load(DSO *dso);
81 static int vms_unload(DSO *dso);
82 static void *vms_bind_var(DSO *dso, const char *symname);
83 static DSO_FUNC_TYPE vms_bind_func(DSO *dso, const char *symname);
84 #if 0
85 static int vms_unbind_var(DSO *dso, char *symname, void *symptr);
86 static int vms_unbind_func(DSO *dso, char *symname, DSO_FUNC_TYPE symptr);
87 static int vms_init(DSO *dso);
88 static int vms_finish(DSO *dso);
89 static long vms_ctrl(DSO *dso, int cmd, long larg, void *parg);
90 #endif
91 static char *vms_name_converter(DSO *dso, const char *filename);
92
93 static DSO_METHOD dso_meth_vms = {
94         "OpenSSL 'VMS' shared library method",
95         vms_load,
96         NULL, /* unload */
97         vms_bind_var,
98         vms_bind_func,
99 /* For now, "unbind" doesn't exist */
100 #if 0
101         NULL, /* unbind_var */
102         NULL, /* unbind_func */
103 #endif
104         NULL, /* ctrl */
105         vms_name_converter,
106         NULL, /* init */
107         NULL  /* finish */
108         };
109
110 /* On VMS, the only "handle" is the file name.  LIB$FIND_IMAGE_SYMBOL depends
111  * on the reference to the file name being the same for all calls regarding
112  * one shared image, so we'll just store it in an instance of the following
113  * structure and put a pointer to that instance in the meth_data stack.
114  */
115 typedef struct dso_internal_st
116         {
117         /* This should contain the name only, no directory,
118          * no extension, nothing but a name. */
119         struct dsc$descriptor_s filename_dsc;
120         char filename[FILENAME_MAX+1];
121         /* This contains whatever is not in filename, if needed.
122          * Normally not defined. */
123         struct dsc$descriptor_s imagename_dsc;
124         char imagename[FILENAME_MAX+1];
125         } DSO_VMS_INTERNAL;
126
127
128 DSO_METHOD *DSO_METHOD_vms(void)
129         {
130         return(&dso_meth_vms);
131         }
132
133 static int vms_load(DSO *dso)
134         {
135         void *ptr = NULL;
136         /* See applicable comments in dso_dl.c */
137         char *filename = DSO_convert_filename(dso, NULL);
138         DSO_VMS_INTERNAL *p;
139         const char *sp1, *sp2;  /* Search result */
140
141         if(filename == NULL)
142                 {
143                 DSOerr(DSO_F_DLFCN_LOAD,DSO_R_NO_FILENAME);
144                 goto err;
145                 }
146
147         /* A file specification may look like this:
148          *
149          *      node::dev:[dir-spec]name.type;ver
150          *
151          * or (for compatibility with TOPS-20):
152          *
153          *      node::dev:<dir-spec>name.type;ver
154          *
155          * and the dir-spec uses '.' as separator.  Also, a dir-spec
156          * may consist of several parts, with mixed use of [] and <>:
157          *
158          *      [dir1.]<dir2>
159          *
160          * We need to split the file specification into the name and
161          * the rest (both before and after the name itself).
162          */
163         /* Start with trying to find the end of a dir-spec, and save the
164            position of the byte after in sp1 */
165         sp1 = strrchr(filename, ']');
166         sp2 = strrchr(filename, '>');
167         if (sp1 == NULL) sp1 = sp2;
168         if (sp2 != NULL && sp2 > sp1) sp1 = sp2;
169         if (sp1 == NULL) sp1 = strrchr(filename, ':');
170         if (sp1 == NULL)
171                 sp1 = filename;
172         else
173                 sp1++;          /* The byte after the found character */
174         /* Now, let's see if there's a type, and save the position in sp2 */
175         sp2 = strchr(sp1, '.');
176         /* If we found it, that's where we'll cut.  Otherwise, look for a
177            version number and save the position in sp2 */
178         if (sp2 == NULL) sp2 = strchr(sp1, ';');
179         /* If there was still nothing to find, set sp2 to point at the end of
180            the string */
181         if (sp2 == NULL) sp2 = sp1 + strlen(sp1);
182
183         /* Check that we won't get buffer overflows */
184         if (sp2 - sp1 > FILENAME_MAX
185                 || (sp1 - filename) + strlen(sp2) > FILENAME_MAX)
186                 {
187                 DSOerr(DSO_F_VMS_LOAD,DSO_R_FILENAME_TOO_BIG);
188                 goto err;
189                 }
190
191         p = (DSO_VMS_INTERNAL *)OPENSSL_malloc(sizeof(DSO_VMS_INTERNAL));
192         if(p == NULL)
193                 {
194                 DSOerr(DSO_F_VMS_LOAD,ERR_R_MALLOC_FAILURE);
195                 goto err;
196                 }
197
198         strncpy(p->filename, sp1, sp2-sp1);
199         p->filename[sp2-sp1] = '\0';
200
201         strncpy(p->imagename, filename, sp1-filename);
202         p->imagename[sp1-filename] = '\0';
203         strcat(p->imagename, sp2);
204
205         p->filename_dsc.dsc$w_length = strlen(p->filename);
206         p->filename_dsc.dsc$b_dtype = DSC$K_DTYPE_T;
207         p->filename_dsc.dsc$b_class = DSC$K_CLASS_S;
208         p->filename_dsc.dsc$a_pointer = p->filename;
209         p->imagename_dsc.dsc$w_length = strlen(p->imagename);
210         p->imagename_dsc.dsc$b_dtype = DSC$K_DTYPE_T;
211         p->imagename_dsc.dsc$b_class = DSC$K_CLASS_S;
212         p->imagename_dsc.dsc$a_pointer = p->imagename;
213
214         if(!sk_push(dso->meth_data, (char *)p))
215                 {
216                 DSOerr(DSO_F_VMS_LOAD,DSO_R_STACK_ERROR);
217                 goto err;
218                 }
219
220         /* Success (for now, we lie.  We actually do not know...) */
221         dso->loaded_filename = filename;
222         return(1);
223 err:
224         /* Cleanup! */
225         if(p != NULL)
226                 OPENSSL_free(p);
227         if(filename != NULL)
228                 OPENSSL_free(filename);
229         return(0);
230         }
231
232 /* Note that this doesn't actually unload the shared image, as there is no
233  * such thing in VMS.  Next time it get loaded again, a new copy will
234  * actually be loaded.
235  */
236 static int vms_unload(DSO *dso)
237         {
238         DSO_VMS_INTERNAL *p;
239         if(dso == NULL)
240                 {
241                 DSOerr(DSO_F_VMS_UNLOAD,ERR_R_PASSED_NULL_PARAMETER);
242                 return(0);
243                 }
244         if(sk_num(dso->meth_data) < 1)
245                 return(1);
246         p = (DSO_VMS_INTERNAL *)sk_pop(dso->meth_data);
247         if(p == NULL)
248                 {
249                 DSOerr(DSO_F_VMS_UNLOAD,DSO_R_NULL_HANDLE);
250                 return(0);
251                 }
252         /* Cleanup */
253         OPENSSL_free(p);
254         return(1);
255         }
256
257 /* We must do this in a separate function because of the way the exception
258    handler works (it makes this function return */
259 static int do_find_symbol(DSO_VMS_INTERNAL *ptr,
260         struct dsc$descriptor_s *symname_dsc, void **sym,
261         unsigned long flags)
262         {
263         /* Make sure that signals are caught and returned instead of
264            aborting the program.  The exception handler gets unestablished
265            automatically on return from this function.  */
266         lib$establish(lib$sig_to_ret);
267
268         if(ptr->imagename_dsc.dsc$w_length)
269                 return lib$find_image_symbol(&ptr->filename_dsc,
270                         symname_dsc, sym,
271                         &ptr->imagename_dsc, flags);
272         else
273                 return lib$find_image_symbol(&ptr->filename_dsc,
274                         symname_dsc, sym,
275                         0, flags);
276         }
277
278 void vms_bind_sym(DSO *dso, const char *symname, void **sym)
279         {
280         DSO_VMS_INTERNAL *ptr;
281         int status;
282         int flags = (1<<4); /* LIB$M_FIS_MIXEDCASE, but this symbol isn't
283                                defined in VMS older than 7.0 or so */
284         struct dsc$descriptor_s symname_dsc;
285         *sym = NULL;
286
287         symname_dsc.dsc$w_length = strlen(symname);
288         symname_dsc.dsc$b_dtype = DSC$K_DTYPE_T;
289         symname_dsc.dsc$b_class = DSC$K_CLASS_S;
290         symname_dsc.dsc$a_pointer = (char *)symname; /* The cast is needed */
291
292         if((dso == NULL) || (symname == NULL))
293                 {
294                 DSOerr(DSO_F_VMS_BIND_VAR,ERR_R_PASSED_NULL_PARAMETER);
295                 return;
296                 }
297         if(sk_num(dso->meth_data) < 1)
298                 {
299                 DSOerr(DSO_F_VMS_BIND_VAR,DSO_R_STACK_ERROR);
300                 return;
301                 }
302         ptr = (DSO_VMS_INTERNAL *)sk_value(dso->meth_data,
303                 sk_num(dso->meth_data) - 1);
304         if(ptr == NULL)
305                 {
306                 DSOerr(DSO_F_VMS_BIND_VAR,DSO_R_NULL_HANDLE);
307                 return;
308                 }
309
310         if(dso->flags & DSO_FLAG_UPCASE_SYMBOL) flags = 0;
311
312         status = do_find_symbol(ptr, &symname_dsc, sym, flags);
313
314         if(!$VMS_STATUS_SUCCESS(status))
315                 {
316                 unsigned short length;
317                 char errstring[257];
318                 struct dsc$descriptor_s errstring_dsc;
319
320                 errstring_dsc.dsc$w_length = sizeof(errstring);
321                 errstring_dsc.dsc$b_dtype = DSC$K_DTYPE_T;
322                 errstring_dsc.dsc$b_class = DSC$K_CLASS_S;
323                 errstring_dsc.dsc$a_pointer = errstring;
324
325                 *sym = NULL;
326
327                 status = sys$getmsg(status, &length, &errstring_dsc, 1, 0);
328
329                 if (!$VMS_STATUS_SUCCESS(status))
330                         lib$signal(status); /* This is really bad.  Abort!  */
331                 else
332                         {
333                         errstring[length] = '\0';
334
335                         DSOerr(DSO_F_VMS_BIND_VAR,DSO_R_SYM_FAILURE);
336                         if (ptr->imagename_dsc.dsc$w_length)
337                                 ERR_add_error_data(9,
338                                         "Symbol ", symname,
339                                         " in ", ptr->filename,
340                                         " (", ptr->imagename, ")",
341                                         ": ", errstring);
342                         else
343                                 ERR_add_error_data(6,
344                                         "Symbol ", symname,
345                                         " in ", ptr->filename,
346                                         ": ", errstring);
347                         }
348                 return;
349                 }
350         return;
351         }
352
353 static void *vms_bind_var(DSO *dso, const char *symname)
354         {
355         void *sym = 0;
356         vms_bind_sym(dso, symname, &sym);
357         return sym;
358         }
359
360 static DSO_FUNC_TYPE vms_bind_func(DSO *dso, const char *symname)
361         {
362         DSO_FUNC_TYPE sym = 0;
363         vms_bind_sym(dso, symname, (void **)&sym);
364         return sym;
365         }
366
367 static char *vms_name_converter(DSO *dso, const char *filename)
368         {
369         int len = strlen(filename);
370         char *not_translated = OPENSSL_malloc(len+1);
371         strcpy(not_translated,filename);
372         return(not_translated);
373         }
374
375 #endif /* OPENSSL_SYS_VMS */