-
Notifications
You must be signed in to change notification settings - Fork 138
/
dynext.c
717 lines (556 loc) · 20.5 KB
/
dynext.c
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
/*
Copyright (C) 2001-2012, Parrot Foundation.
=head1 NAME
src/dynext.c - Dynamic extensions to Parrot
=head1 DESCRIPTION
Functions for loading and initializing dynamic link libraries.
=head2 Functions
=over 4
=cut
*/
#include "parrot/parrot.h"
#include "parrot/dynext.h"
#include "dynext.str"
#include "pmc/pmc_parrotlibrary.h"
#include "pmc/pmc_callcontext.h"
/* HEADERIZER HFILE: include/parrot/dynext.h */
/* HEADERIZER BEGIN: static */
/* Don't modify between HEADERIZER BEGIN / HEADERIZER END. Your changes will be lost. */
PARROT_WARN_UNUSED_RESULT
PARROT_CANNOT_RETURN_NULL
static STRING * clone_string_into(
ARGMOD(Interp *d),
ARGIN(Interp *s),
ARGIN(PMC *value))
__attribute__nonnull__(1)
__attribute__nonnull__(2)
__attribute__nonnull__(3)
FUNC_MODIFIES(*d);
PARROT_WARN_UNUSED_RESULT
PARROT_CAN_RETURN_NULL
static void * dlopen_string(PARROT_INTERP,
Parrot_dlopen_flags flags,
ARGIN(const STRING *path))
__attribute__nonnull__(1)
__attribute__nonnull__(3);
PARROT_WARN_UNUSED_RESULT
PARROT_CAN_RETURN_NULL
static STRING * get_path(PARROT_INTERP,
ARGIN_NULLOK(STRING *lib),
Parrot_dlopen_flags flags,
ARGOUT(void **handle),
ARGIN(const STRING *wo_ext),
ARGIN_NULLOK(const STRING *ext))
__attribute__nonnull__(1)
__attribute__nonnull__(4)
__attribute__nonnull__(5)
FUNC_MODIFIES(*handle);
PARROT_WARN_UNUSED_RESULT
PARROT_CAN_RETURN_NULL
static PMC* is_loaded(PARROT_INTERP, ARGIN(STRING *path))
__attribute__nonnull__(1)
__attribute__nonnull__(2);
PARROT_CANNOT_RETURN_NULL
static PMC * run_init_lib(PARROT_INTERP,
ARGIN(void *handle),
ARGIN(STRING *lib_name),
ARGIN(STRING *wo_ext))
__attribute__nonnull__(1)
__attribute__nonnull__(2)
__attribute__nonnull__(3)
__attribute__nonnull__(4);
static void set_cstring_prop(PARROT_INTERP,
ARGMOD(PMC *lib_pmc),
ARGIN(const char *what),
ARGIN(STRING *name))
__attribute__nonnull__(1)
__attribute__nonnull__(2)
__attribute__nonnull__(3)
__attribute__nonnull__(4)
FUNC_MODIFIES(*lib_pmc);
static void store_lib_pmc(PARROT_INTERP,
ARGIN(PMC *lib_pmc),
ARGIN(STRING *path),
ARGIN(STRING *type),
ARGIN(STRING *lib_name))
__attribute__nonnull__(1)
__attribute__nonnull__(2)
__attribute__nonnull__(3)
__attribute__nonnull__(4)
__attribute__nonnull__(5);
#define ASSERT_ARGS_clone_string_into __attribute__unused__ int _ASSERT_ARGS_CHECK = (\
PARROT_ASSERT_ARG(d) \
, PARROT_ASSERT_ARG(s) \
, PARROT_ASSERT_ARG(value))
#define ASSERT_ARGS_dlopen_string __attribute__unused__ int _ASSERT_ARGS_CHECK = (\
PARROT_ASSERT_ARG(interp) \
, PARROT_ASSERT_ARG(path))
#define ASSERT_ARGS_get_path __attribute__unused__ int _ASSERT_ARGS_CHECK = (\
PARROT_ASSERT_ARG(interp) \
, PARROT_ASSERT_ARG(handle) \
, PARROT_ASSERT_ARG(wo_ext))
#define ASSERT_ARGS_is_loaded __attribute__unused__ int _ASSERT_ARGS_CHECK = (\
PARROT_ASSERT_ARG(interp) \
, PARROT_ASSERT_ARG(path))
#define ASSERT_ARGS_run_init_lib __attribute__unused__ int _ASSERT_ARGS_CHECK = (\
PARROT_ASSERT_ARG(interp) \
, PARROT_ASSERT_ARG(handle) \
, PARROT_ASSERT_ARG(lib_name) \
, PARROT_ASSERT_ARG(wo_ext))
#define ASSERT_ARGS_set_cstring_prop __attribute__unused__ int _ASSERT_ARGS_CHECK = (\
PARROT_ASSERT_ARG(interp) \
, PARROT_ASSERT_ARG(lib_pmc) \
, PARROT_ASSERT_ARG(what) \
, PARROT_ASSERT_ARG(name))
#define ASSERT_ARGS_store_lib_pmc __attribute__unused__ int _ASSERT_ARGS_CHECK = (\
PARROT_ASSERT_ARG(interp) \
, PARROT_ASSERT_ARG(lib_pmc) \
, PARROT_ASSERT_ARG(path) \
, PARROT_ASSERT_ARG(type) \
, PARROT_ASSERT_ARG(lib_name))
/* Don't modify between HEADERIZER BEGIN / HEADERIZER END. Your changes will be lost. */
/* HEADERIZER END: static */
/* _PARROTLIB is now the default */
/*#define _PARROTLIB not working: "make testr" */
/*
=item C<static void set_cstring_prop(PARROT_INTERP, PMC *lib_pmc, const char
*what, STRING *name)>
Sets a property C<name> with value C<what> on the C<ParrotLibrary> C<lib_pmc>.
=cut
*/
static void
set_cstring_prop(PARROT_INTERP, ARGMOD(PMC *lib_pmc), ARGIN(const char *what),
ARGIN(STRING *name))
{
ASSERT_ARGS(set_cstring_prop)
STRING * const key = Parrot_str_new_constant(interp, what);
PMC * const prop = Parrot_pmc_new(interp, enum_class_String);
VTABLE_set_string_native(interp, prop, name);
Parrot_pmc_setprop(interp, lib_pmc, key, prop);
}
/*
=item C<static void store_lib_pmc(PARROT_INTERP, PMC *lib_pmc, STRING *path,
STRING *type, STRING *lib_name)>
Stores a C<ParrotLibrary> PMC in the interpreter's C<iglobals>.
=cut
*/
static void
store_lib_pmc(PARROT_INTERP, ARGIN(PMC *lib_pmc), ARGIN(STRING *path),
ARGIN(STRING *type), ARGIN(STRING *lib_name))
{
ASSERT_ARGS(store_lib_pmc)
PMC * const iglobals = interp->iglobals;
PMC * const dyn_libs = VTABLE_get_pmc_keyed_int(interp, iglobals,
IGLOBALS_DYN_LIBS);
/* remember path/file in props */
set_cstring_prop(interp, lib_pmc, "_filename", path);
set_cstring_prop(interp, lib_pmc, "_type", type);
if (!STRING_IS_NULL(lib_name))
set_cstring_prop(interp, lib_pmc, "_lib_name", lib_name);
VTABLE_set_pmc_keyed_str(interp, dyn_libs, path, lib_pmc);
}
/*
=item C<static PMC* is_loaded(PARROT_INTERP, STRING *path)>
Returns a C<ParrotLibrary> PMC with the given filename path, if it exists.
Otherwise returns PMCNULL.
=cut
*/
PARROT_WARN_UNUSED_RESULT
PARROT_CAN_RETURN_NULL
static PMC*
is_loaded(PARROT_INTERP, ARGIN(STRING *path))
{
ASSERT_ARGS(is_loaded)
PMC * const iglobals = interp->iglobals;
PMC * const dyn_libs = VTABLE_get_pmc_keyed_int(interp, iglobals,
IGLOBALS_DYN_LIBS);
return VTABLE_get_pmc_keyed_str(interp, dyn_libs, path);
}
/*
=item C<static void * dlopen_string(PARROT_INTERP, Parrot_dlopen_flags flags,
const STRING *path)>
Calls C<Parrot_dlopen> with the path argument converted to a C string. The
flags argument will be converted into native form and used if applicable.
=cut
*/
PARROT_WARN_UNUSED_RESULT
PARROT_CAN_RETURN_NULL
static void *
dlopen_string(PARROT_INTERP, Parrot_dlopen_flags flags, ARGIN(const STRING *path))
{
ASSERT_ARGS(dlopen_string)
char * const pathstr = Parrot_str_to_cstring(interp, path);
void * const handle = Parrot_dlopen(pathstr, flags);
Parrot_str_free_cstring(pathstr);
return handle;
}
/*
=item C<static STRING * get_path(PARROT_INTERP, STRING *lib, Parrot_dlopen_flags
flags, void **handle, const STRING *wo_ext, const STRING *ext)>
Returns path and handle of a dynamic lib, setting lib_name to just the filestem
(i.e. without path or extension) as a freshly-allocated C string.
=cut
*/
PARROT_WARN_UNUSED_RESULT
PARROT_CAN_RETURN_NULL
static STRING *
get_path(PARROT_INTERP, ARGIN_NULLOK(STRING *lib), Parrot_dlopen_flags flags,
ARGOUT(void **handle), ARGIN(const STRING *wo_ext), ARGIN_NULLOK(const STRING *ext))
{
ASSERT_ARGS(get_path)
PMC * const iglobals = interp->iglobals;
PMC * const lib_paths = VTABLE_get_pmc_keyed_int(interp, iglobals,
IGLOBALS_LIB_PATHS);
PMC * const share_ext = VTABLE_get_pmc_keyed_int(interp, lib_paths,
PARROT_LIB_DYN_EXTS);
STRING *path, *full_name;
if (STRING_IS_NULL(lib)) {
*handle = Parrot_dlopen((char *)NULL, flags);
if (*handle)
return CONST_STRING(interp, "");
else {
const char *err = Parrot_dlerror();
Parrot_warn(interp, PARROT_WARNINGS_DYNEXT_FLAG,
"Couldn't dlopen(NULL): %s\n",
err ? err : "unknown reason");
/* clear the error memory */
(void)Parrot_dlerror();
return STRINGNULL;
}
}
/* first, try to add an extension to the file if it has none */
if (STRING_IS_NULL(ext)) {
const INTVAL n = VTABLE_elements(interp, share_ext);
INTVAL i;
for (i = 0; i < n; ++i) {
ext = VTABLE_get_string_keyed_int(interp, share_ext, i);
full_name = Parrot_str_concat(interp, wo_ext, ext);
path = Parrot_locate_runtime_file_str(interp, full_name,
PARROT_RUNTIME_FT_DYNEXT);
if (!STRING_IS_NULL(path)) {
*handle = dlopen_string(interp, flags, path);
if (*handle)
return path;
else {
const char * const err = Parrot_dlerror();
Parrot_warn(interp, PARROT_WARNINGS_DYNEXT_FLAG,
"Couldn't load '%Ss': %s\n",
full_name, err ? err : "unknown reason");
/* clear the error memory */
(void)Parrot_dlerror();
return STRINGNULL;
}
}
/* File not found with extension and prefix; try file.extension */
*handle = dlopen_string(interp, flags, full_name);
if (*handle)
return full_name;
}
}
/*
* finally, try the given file name as is. We still use
* Parrot_locate_runtime_file so that (a) relative pathnames are searched in
* the standard locations, and (b) the angle of the slashes are adjusted as
* required for non-Unix systems.
*/
full_name = Parrot_locate_runtime_file_str(interp, lib,
PARROT_RUNTIME_FT_DYNEXT);
if (!STRING_IS_NULL(full_name)) {
*handle = dlopen_string(interp, flags, full_name);
if (*handle)
return full_name;
}
/*
* and on windows strip a leading "lib"
* [shouldn't this happen in Parrot_locate_runtime_file instead?]
*/
#ifdef WIN32
if (STRING_length(lib) >= 3
&& STRING_ord(interp, lib, 0) == 'l'
&& STRING_ord(interp, lib, 1) == 'i'
&& STRING_ord(interp, lib, 2) == 'b') {
path = STRING_substr(interp, lib, 3, STRING_length(lib) - 3);
*handle = dlopen_string(interp, flags, path);
if (*handle)
return path;
}
#endif
/* And on cygwin replace a leading "lib" by "cyg". */
#ifdef __CYGWIN__
if (STRING_length(lib) >= 3
&& STRING_ord(interp, lib, 0) == 'l'
&& STRING_ord(interp, lib, 1) == 'i'
&& STRING_ord(interp, lib, 2) == 'b') {
path = Parrot_str_concat(interp, CONST_STRING(interp, "cyg"),
STRING_substr(interp, lib, 3, STRING_length(lib) - 3));
*handle = dlopen_string(interp, flags, path);
if (*handle)
return path;
}
#endif
if (STRING_length(lib)) {
*handle = dlopen_string(interp, flags, lib);
if (*handle)
return lib;
}
/* And after-finally, let the OS use his own search */
{
const char * const err = Parrot_dlerror();
Parrot_warn(interp, PARROT_WARNINGS_DYNEXT_FLAG,
"Couldn't load '%Ss': %s\n",
lib, err ? err : "unknown reason");
/* clear the error memory */
(void)Parrot_dlerror();
return STRINGNULL;
}
}
/*
=item C<PMC * Parrot_dyn_init_lib(PARROT_INTERP, dynext_load_func load_func,
dynext_init_func init_func)>
Initializes a new library. First, calls C<load_func> to load the library
(if C<load_func> is provided) and then calls C<init_func>. Returns a
ParrotLibrary PMC object that represents the initialized library.
=cut
*/
PARROT_EXPORT
PARROT_CANNOT_RETURN_NULL
PMC *
Parrot_dyn_init_lib(PARROT_INTERP,
NULLOK(dynext_load_func load_func),
NULLOK(dynext_init_func init_func))
{
ASSERT_ARGS(Parrot_dyn_init_lib)
PMC *lib_pmc = NULL;
if (load_func)
lib_pmc = (*load_func)(interp);
/* seems to be a native/NCI lib */
if (!load_func || !lib_pmc)
lib_pmc = Parrot_pmc_new(interp, enum_class_ParrotLibrary);
/* Call init, if it exists */
if (init_func)
(init_func)(interp, lib_pmc);
return lib_pmc;
}
/*
=item C<void * Parrot_dyn_dlsym_str(PARROT_INTERP, void *handle, const STRING
*symbol)>
Loads a symbol named C<symbol> from the shared library represented by
C<handle>.
=cut
*/
PARROT_EXPORT
PARROT_CAN_RETURN_NULL
void *
Parrot_dyn_dlsym_str(PARROT_INTERP,
ARGIN_NULLOK(void *handle), ARGIN_NULLOK(const STRING *symbol))
{
ASSERT_ARGS(Parrot_dyn_dlsym_str)
if (STRING_IS_NULL(symbol))
return NULL;
else {
char * const symbol_cs = Parrot_str_to_cstring(interp, symbol);
void * const ptr = Parrot_dlsym(handle, symbol_cs);
Parrot_str_free_cstring(symbol_cs);
return ptr;
}
}
/*
=item C<static PMC * run_init_lib(PARROT_INTERP, void *handle, STRING *lib_name,
STRING *wo_ext)>
Loads and initializes a new library and returns a ParrotLibrary PMC. Takes the
name of a library C<lib_name>, that is loaded with handle C<handle>. Calls the
necessary initialization routines, if any.
=cut
*/
PARROT_CANNOT_RETURN_NULL
static PMC *
run_init_lib(PARROT_INTERP, ARGIN(void *handle), ARGIN(STRING *lib_name), ARGIN(STRING *wo_ext))
{
ASSERT_ARGS(run_init_lib)
STRING *type;
PMC *(*load_func)(PARROT_INTERP);
void (*init_func)(PARROT_INTERP, PMC *);
PMC *lib_pmc;
UINTVAL regs_used[] = { 2, 2, 2, 2 }; /* Arbitrary values */
const int parrot_hll_id = 0;
PMC * const context = Parrot_push_context(interp, regs_used);
Parrot_pcc_set_HLL(interp, context, parrot_hll_id);
Parrot_pcc_set_namespace(interp, context,
Parrot_hll_get_HLL_namespace(interp, parrot_hll_id));
if (!STRING_IS_NULL(lib_name)) {
STRING * const load_name = Parrot_sprintf_c(interp,
"Parrot_lib_%Ss_load", lib_name);
STRING * const init_func_name = Parrot_sprintf_c(interp,
"Parrot_lib_%Ss_init", lib_name);
/* get load_func */
void * dlsymfunc = Parrot_dyn_dlsym_str(interp, handle, load_name);
load_func = (PMC * (*)(PARROT_INTERP)) D2FPTR(dlsymfunc);
/* get init_func */
dlsymfunc = Parrot_dyn_dlsym_str(interp, handle, init_func_name);
init_func = (void (*)(PARROT_INTERP, PMC *)) D2FPTR(dlsymfunc);
}
else {
load_func = NULL;
init_func = NULL;
}
lib_pmc = Parrot_dyn_init_lib(interp, load_func, init_func);
VTABLE_set_pointer(interp, lib_pmc, handle);
if (!load_func)
type = CONST_STRING(interp, "NCI");
else {
if (((Parrot_ParrotLibrary_attributes *)PMC_data(lib_pmc))->oplib_init)
type = CONST_STRING(interp, "Ops");
else
type = CONST_STRING(interp, "PMC");
}
/* remember lib_pmc in iglobals */
store_lib_pmc(interp, lib_pmc, wo_ext, type, lib_name);
Parrot_pop_context(interp);
return lib_pmc;
}
/*
=item C<static STRING * clone_string_into(Interp *d, Interp *s, PMC *value)>
Extracts a STRING value from PMC C<value> in interpreter C<s>. Copies that
string into the pool of interpreter C<d> using the default encoding.
=cut
*/
PARROT_WARN_UNUSED_RESULT
PARROT_CANNOT_RETURN_NULL
static STRING *
clone_string_into(ARGMOD(Interp *d), ARGIN(Interp *s), ARGIN(PMC *value))
{
ASSERT_ARGS(clone_string_into)
STRING * const str = VTABLE_get_string(s, value);
return Parrot_str_new_init(d, str->strstart, str->bufused,
str->encoding, PObj_constant_FLAG);
}
/*
=item C<PMC * Parrot_dyn_clone_lib_into(Interp *d, Interp *s, PMC *lib_pmc)>
Clones a ParrotLibrary PMC C<lib_pmc> from interpreter C<s> into interpreter
C<d>.
=cut
*/
PARROT_EXPORT
PARROT_WARN_UNUSED_RESULT
PARROT_CANNOT_RETURN_NULL
PMC *
Parrot_dyn_clone_lib_into(ARGMOD(Interp *d), ARGMOD(Interp *s), ARGIN(PMC *lib_pmc))
{
ASSERT_ARGS(Parrot_dyn_clone_lib_into)
STRING * const filename = CONST_STRING(s, "_filename");
STRING * const libname = CONST_STRING(s, "_lib_name");
STRING * const type_str = CONST_STRING(s, "_type");
STRING * const ops = CONST_STRING(s, "Ops");
STRING * const wo_ext = clone_string_into(d, s,
Parrot_pmc_getprop(s, lib_pmc, filename));
STRING * const lib_name = clone_string_into(d, s,
Parrot_pmc_getprop(s, lib_pmc, libname));
void * const handle = VTABLE_get_pointer(s, lib_pmc);
STRING * const type =
VTABLE_get_string(s, Parrot_pmc_getprop(s, lib_pmc, type_str));
if (STRING_equal(s, type, ops)) {
/* we can't clone oplibs in the normal way, since they're actually
* shared between interpreters dynop_register modifies the (statically
* allocated) op_lib_t structure from core_ops.c, for example.
* Anyways, if we hope to share bytecode at runtime, we need to have
* them have identical opcodes anyways.
*/
PMC * const new_lib_pmc = Parrot_pmc_new(d, enum_class_ParrotLibrary);
PMC_data(new_lib_pmc) = handle;
Parrot_pmc_setprop(d, new_lib_pmc, CONST_STRING(s, "_filename"), Parrot_pmc_box_string(d, wo_ext));
Parrot_pmc_setprop(d, new_lib_pmc, CONST_STRING(s, "_lib_name"), Parrot_pmc_box_string(d, lib_name));
Parrot_pmc_setprop(d, new_lib_pmc, CONST_STRING(s, "_type"), Parrot_pmc_box_string(d, ops));
/* fixup d->all_op_libs, if necessary */
if (d->n_libs != s->n_libs) {
INTVAL i;
if (d->all_op_libs)
d->all_op_libs
= (op_lib_t **)mem_internal_realloc(d->all_op_libs,
sizeof (op_lib_t *) * s->n_libs);
else
d->all_op_libs
= (op_lib_t **)mem_internal_allocate(sizeof (op_lib_t *) *
s->n_libs);
for (i = d->n_libs; i < s->n_libs; ++i)
d->all_op_libs[i] = s->all_op_libs[i];
d->n_libs = s->n_libs;
}
return new_lib_pmc;
}
return run_init_lib(d, handle, lib_name, wo_ext);
}
/*
=item C<PMC * Parrot_dyn_load_lib(PARROT_INTERP, STRING *lib, PMC *parameters)>
Dynamic library loader.
C<parameters>, if not null, points to something which controls library
loading and initialization. Currently just its integer value is used,
interpreted as C<Parrot_dlopen_flags>.
Calls C<Parrot_lib_%s_load()> which performs the registration of the lib
once C<Parrot_lib_%s_init()> gets called (if exists) to perform thread
specific setup. In both functions C<%s> is the name of the library.
If Parrot_lib_%s_load() succeeds, it should either return a
ParrotLibrary PMC, which is then used as the handle for this library
or NULL, in which case parrot creates a handle for the library.
If either Parrot_lib_%s_load() or Parrot_lib_%s_init() detects an error
condition, an exception should be thrown.
TODO: fetch Parrot_lib load/init handler exceptions
=cut
*/
PARROT_EXPORT
PARROT_WARN_UNUSED_RESULT
PARROT_CANNOT_RETURN_NULL
PMC *
Parrot_dyn_load_lib(PARROT_INTERP,
ARGIN_NULLOK(STRING *lib),
ARGIN_NULLOK(PMC *parameters))
{
ASSERT_ARGS(Parrot_dyn_load_lib)
/* NULL intialize handle to protect against pitfalls in called functions.
* This function should not be so speed critical that this has any impact.
*/
void *handle = NULL;
PMC *lib_pmc;
STRING *path;
STRING *lib_name, *wo_ext, *ext; /* library stem without path
* or extension. */
int flags = 0;
/* Find the pure library name, without path or extension. */
/*
* TODO move the class_count_mutex here
*
* LOCK()
*/
if (!STRING_IS_NULL(lib))
lib_name = parrot_split_path_ext(interp, lib, &wo_ext, &ext);
else {
wo_ext = CONST_STRING(interp, "");
lib_name = STRINGNULL;
ext = STRINGNULL;
}
lib_pmc = is_loaded(interp, wo_ext);
/* UNLOCK() */
if (!PMC_IS_NULL(lib_pmc))
return lib_pmc;
if (!PMC_IS_NULL(parameters))
flags = VTABLE_get_integer(interp, parameters);
path = get_path(interp, lib, (Parrot_dlopen_flags)flags, &handle, wo_ext, ext);
/*
* XXX Parrot_ex_throw_from_c_args? return PMCNULL?
* PMC Undef seems convenient, because it can be queried with get_bool()
*/
if (STRING_IS_NULL(path) || !handle)
return Parrot_pmc_new(interp, enum_class_Undef);
return run_init_lib(interp, handle, lib_name, wo_ext);
}
/*
=back
=head1 SEE ALSO
F<include/parrot/dynext.h> and F<src/pmc/parrotlibrary.pmc>.
=cut
*/
/*
* Local variables:
* c-file-style: "parrot"
* End:
* vim: expandtab shiftwidth=4 cinoptions='\:2=2' :
*/