-
Notifications
You must be signed in to change notification settings - Fork 138
/
api.c
2755 lines (2114 loc) · 80.5 KB
/
api.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
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
Copyright (C) 2001-2011, Parrot Foundation.
This program is free software. It is subject to the same license as
Parrot itself.
=head1 NAME
src/packfile.c - Parrot PackFile API
=head1 DESCRIPTION
This file represents the public API for the packfile subsystem. It provides
several routines for working with PackFile* structures, and various
packfile-related PMC types. Any PMC type for which VTABLE_get_pointer returns
a PackFile* structure, and VTABLE_set_pointer takes a PackFile* can be used
with this system to represent a PackFile*.
See F<docs/pdds/pdd13_bytecode.pod> for details about the subsystem and the
format of bytecode.
=head2 PackFile Manipulation Functions
=over 4
=cut
*/
#include "pf_private.h"
#include "api.str"
#include "pmc/pmc_sub.h"
#include "pmc/pmc_packfileview.h"
/* HEADERIZER HFILE: include/parrot/packfile.h */
/* HEADERIZER BEGIN: static */
/* Don't modify between HEADERIZER BEGIN / HEADERIZER END. Your changes will be lost. */
static void compile_file(PARROT_INTERP, ARGIN(STRING *path), INTVAL is_pasm)
__attribute__nonnull__(1)
__attribute__nonnull__(2);
PARROT_WARN_UNUSED_RESULT
PARROT_CANNOT_RETURN_NULL
static PackFile_Segment * create_seg(PARROT_INTERP,
ARGMOD(PackFile_Directory *dir),
pack_file_types t,
ARGIN(STRING *name),
ARGIN(STRING *file_name),
int add)
__attribute__nonnull__(1)
__attribute__nonnull__(2)
__attribute__nonnull__(4)
__attribute__nonnull__(5)
FUNC_MODIFIES(*dir);
PARROT_WARN_UNUSED_RESULT
PARROT_CAN_RETURN_NULL
static PMC* do_1_sub_pragma(PARROT_INTERP,
ARGMOD(PMC *sub_pmc),
pbc_action_enum_t action)
__attribute__nonnull__(1)
__attribute__nonnull__(2)
FUNC_MODIFIES(*sub_pmc);
static INTVAL find_const_iter(PARROT_INTERP,
ARGMOD(PackFile_Segment *seg),
ARGIN_NULLOK(void *user_data))
__attribute__nonnull__(1)
__attribute__nonnull__(2)
FUNC_MODIFIES(*seg);
PARROT_PURE_FUNCTION
PARROT_WARN_UNUSED_RESULT
static INTVAL find_pf_ann_idx(
ARGIN(PackFile_Annotations *pfa),
ARGIN(PackFile_Annotations_Key *key),
UINTVAL offs)
__attribute__nonnull__(1)
__attribute__nonnull__(2);
static void load_file(PARROT_INTERP, ARGIN(STRING *path))
__attribute__nonnull__(1)
__attribute__nonnull__(2);
static void mark_1_bc_seg(PARROT_INTERP, ARGMOD(PackFile_ByteCode *bc))
__attribute__nonnull__(1)
__attribute__nonnull__(2)
FUNC_MODIFIES(*bc);
static void mark_1_ct_seg(PARROT_INTERP, ARGMOD(PackFile_ConstTable *ct))
__attribute__nonnull__(1)
__attribute__nonnull__(2)
FUNC_MODIFIES(*ct);
static void PackFile_Header_read_uuid(PARROT_INTERP,
ARGMOD(PackFile_Header *self),
ARGIN(const opcode_t *packed),
size_t packed_size)
__attribute__nonnull__(1)
__attribute__nonnull__(2)
__attribute__nonnull__(3)
FUNC_MODIFIES(*self);
PARROT_WARN_UNUSED_RESULT
static int PackFile_Header_unpack(PARROT_INTERP,
ARGMOD(PackFile_Header *self),
ARGIN(const opcode_t *packed),
size_t packed_size,
INTVAL pf_options)
__attribute__nonnull__(1)
__attribute__nonnull__(2)
__attribute__nonnull__(3)
FUNC_MODIFIES(*self);
static void PackFile_Header_validate(PARROT_INTERP,
ARGIN(const PackFile_Header *self),
INTVAL pf_options)
__attribute__nonnull__(1)
__attribute__nonnull__(2);
PARROT_CANNOT_RETURN_NULL
static PMC * packfile_main(ARGIN(PackFile_ByteCode *bc))
__attribute__nonnull__(1);
static void PackFile_set_header(ARGOUT(PackFile_Header *header))
__attribute__nonnull__(1)
FUNC_MODIFIES(*header);
static void push_context(PARROT_INTERP)
__attribute__nonnull__(1);
PARROT_CAN_RETURN_NULL
static char * read_pbc_file_bytes_handle(PARROT_INTERP,
PIOHANDLE io,
INTVAL program_size)
__attribute__nonnull__(1);
PARROT_CAN_RETURN_NULL
static PackFile * read_pbc_file_packfile(PARROT_INTERP,
ARGIN(STRING * const fullname),
INTVAL program_size)
__attribute__nonnull__(1)
__attribute__nonnull__(2);
PARROT_CANNOT_RETURN_NULL
static PackFile* read_pbc_file_packfile_handle(PARROT_INTERP,
ARGIN(STRING * const fullname),
PIOHANDLE io,
INTVAL program_size)
__attribute__nonnull__(1)
__attribute__nonnull__(2);
PARROT_CANNOT_RETURN_NULL
static PMC* set_current_sub(PARROT_INTERP)
__attribute__nonnull__(1);
static int sub_pragma(PARROT_INTERP,
pbc_action_enum_t action,
ARGIN(const PMC *sub_pmc))
__attribute__nonnull__(1)
__attribute__nonnull__(3);
#define ASSERT_ARGS_compile_file __attribute__unused__ int _ASSERT_ARGS_CHECK = (\
PARROT_ASSERT_ARG(interp) \
, PARROT_ASSERT_ARG(path))
#define ASSERT_ARGS_create_seg __attribute__unused__ int _ASSERT_ARGS_CHECK = (\
PARROT_ASSERT_ARG(interp) \
, PARROT_ASSERT_ARG(dir) \
, PARROT_ASSERT_ARG(name) \
, PARROT_ASSERT_ARG(file_name))
#define ASSERT_ARGS_do_1_sub_pragma __attribute__unused__ int _ASSERT_ARGS_CHECK = (\
PARROT_ASSERT_ARG(interp) \
, PARROT_ASSERT_ARG(sub_pmc))
#define ASSERT_ARGS_find_const_iter __attribute__unused__ int _ASSERT_ARGS_CHECK = (\
PARROT_ASSERT_ARG(interp) \
, PARROT_ASSERT_ARG(seg))
#define ASSERT_ARGS_find_pf_ann_idx __attribute__unused__ int _ASSERT_ARGS_CHECK = (\
PARROT_ASSERT_ARG(pfa) \
, PARROT_ASSERT_ARG(key))
#define ASSERT_ARGS_load_file __attribute__unused__ int _ASSERT_ARGS_CHECK = (\
PARROT_ASSERT_ARG(interp) \
, PARROT_ASSERT_ARG(path))
#define ASSERT_ARGS_mark_1_bc_seg __attribute__unused__ int _ASSERT_ARGS_CHECK = (\
PARROT_ASSERT_ARG(interp) \
, PARROT_ASSERT_ARG(bc))
#define ASSERT_ARGS_mark_1_ct_seg __attribute__unused__ int _ASSERT_ARGS_CHECK = (\
PARROT_ASSERT_ARG(interp) \
, PARROT_ASSERT_ARG(ct))
#define ASSERT_ARGS_PackFile_Header_read_uuid __attribute__unused__ int _ASSERT_ARGS_CHECK = (\
PARROT_ASSERT_ARG(interp) \
, PARROT_ASSERT_ARG(self) \
, PARROT_ASSERT_ARG(packed))
#define ASSERT_ARGS_PackFile_Header_unpack __attribute__unused__ int _ASSERT_ARGS_CHECK = (\
PARROT_ASSERT_ARG(interp) \
, PARROT_ASSERT_ARG(self) \
, PARROT_ASSERT_ARG(packed))
#define ASSERT_ARGS_PackFile_Header_validate __attribute__unused__ int _ASSERT_ARGS_CHECK = (\
PARROT_ASSERT_ARG(interp) \
, PARROT_ASSERT_ARG(self))
#define ASSERT_ARGS_packfile_main __attribute__unused__ int _ASSERT_ARGS_CHECK = (\
PARROT_ASSERT_ARG(bc))
#define ASSERT_ARGS_PackFile_set_header __attribute__unused__ int _ASSERT_ARGS_CHECK = (\
PARROT_ASSERT_ARG(header))
#define ASSERT_ARGS_push_context __attribute__unused__ int _ASSERT_ARGS_CHECK = (\
PARROT_ASSERT_ARG(interp))
#define ASSERT_ARGS_read_pbc_file_bytes_handle __attribute__unused__ int _ASSERT_ARGS_CHECK = (\
PARROT_ASSERT_ARG(interp))
#define ASSERT_ARGS_read_pbc_file_packfile __attribute__unused__ int _ASSERT_ARGS_CHECK = (\
PARROT_ASSERT_ARG(interp) \
, PARROT_ASSERT_ARG(fullname))
#define ASSERT_ARGS_read_pbc_file_packfile_handle __attribute__unused__ int _ASSERT_ARGS_CHECK = (\
PARROT_ASSERT_ARG(interp) \
, PARROT_ASSERT_ARG(fullname))
#define ASSERT_ARGS_set_current_sub __attribute__unused__ int _ASSERT_ARGS_CHECK = (\
PARROT_ASSERT_ARG(interp))
#define ASSERT_ARGS_sub_pragma __attribute__unused__ int _ASSERT_ARGS_CHECK = (\
PARROT_ASSERT_ARG(interp) \
, PARROT_ASSERT_ARG(sub_pmc))
/* Don't modify between HEADERIZER BEGIN / HEADERIZER END. Your changes will be lost. */
/* HEADERIZER END: static */
/*
=item C<void Parrot_pf_destroy(PARROT_INTERP, PackFile *pf)>
Destroys a C<PackFile>, and frees resources. This does not automatically free
garbage collectable objects contained in that packfile (STRING and PMC) if
they are referenced from other places.
Notice that this can cause problems, if a Packfile is destroyed, but some of
its contents are not destroyed, but those contents contain indirect references
to other things in the packfile which are destroyed. Use with caution.
=item C<void PackFile_destroy(PARROT_INTERP, PackFile *pf)>
Deprecated. Same as C<Parrot_pf_destroy>. Use Parrot_pf_destroy instead.
=cut
*/
PARROT_EXPORT
void
Parrot_pf_destroy(PARROT_INTERP, ARGMOD(PackFile *pf))
{
ASSERT_ARGS(Parrot_pf_destroy)
#ifdef PARROT_HAS_HEADER_SYSMMAN
if (pf->is_mmap_ped) {
DECL_CONST_CAST;
/* Cast the result to void to avoid a warning with
* some not-so-standard mmap headers
*/
munmap((void *)PARROT_const_cast(opcode_t *, pf->src), pf->size);
}
#endif
mem_gc_free(interp, pf->header);
pf->header = NULL;
mem_gc_free(interp, pf->dirp);
pf->dirp = NULL;
PackFile_Segment_destroy(interp, &pf->directory.base);
return;
}
PARROT_EXPORT
void
PackFile_destroy(PARROT_INTERP, ARGMOD(PackFile *pf))
{
ASSERT_ARGS(PackFile_destroy)
Parrot_pf_destroy(interp, pf);
}
/*
=item C<INTVAL Parrot_pf_serialized_size(PARROT_INTERP, PackFile * pf)>
Returns the size, in bytes, that a packfile will be if serialized
=item C<STRING * Parrot_pf_serialize(PARROT_INTERP, PackFile * const pf)>
Serialize a PackFile * into a STRING buffer
=item C<PackFile * Parrot_pf_deserialize(PARROT_INTERP, STRING *str)>
Deserialize a packfile which is stored in a STRING buffer
=cut
*/
PARROT_EXPORT
INTVAL
Parrot_pf_serialized_size(PARROT_INTERP, ARGIN(PackFile * pf))
{
ASSERT_ARGS(Parrot_pf_serialized_size)
return PackFile_pack_size(interp, pf);
}
PARROT_EXPORT
PARROT_CANNOT_RETURN_NULL
STRING *
Parrot_pf_serialize(PARROT_INTERP, ARGIN(PackFile * const pf))
{
ASSERT_ARGS(Parrot_pf_serialize)
STRING *str;
/* Calculate required memory */
const opcode_t length = PackFile_pack_size(interp, pf) * sizeof (opcode_t);
opcode_t * const ptr = (opcode_t*)Parrot_gc_allocate_memory_chunk(interp, length);
/* And pack it! */
PackFile_pack(interp, pf, ptr);
str = Parrot_str_new_init(interp, (const char*)ptr, length,
Parrot_binary_encoding_ptr, 0);
Parrot_gc_free_memory_chunk(interp, ptr);
return str;
}
PARROT_EXPORT
PARROT_CANNOT_RETURN_NULL
PackFile *
Parrot_pf_deserialize(PARROT_INTERP, ARGIN(STRING *str))
{
ASSERT_ARGS(Parrot_pf_deserialize)
PackFile * const pf = PackFile_new(interp, 0);
const opcode_t * const ptr =
(const opcode_t *)Parrot_str_cstring(interp, str);
const int length = Parrot_str_byte_length(interp, str);
if (!PackFile_unpack(interp, pf, ptr, length)) {
PackFile_destroy(interp, pf);
Parrot_ex_throw_from_c_args(interp, NULL,
EXCEPTION_MALFORMED_PACKFILE, "Can't unpack packfile.");
}
return pf;
}
/*
=item C<void Parrot_pf_tag_constant(PARROT_INTERP, PackFile_ConstTable *ct,
const int tag_idx, const int const_idx)>
Tag a constant PMC with a constant STRING
=cut
*/
void
Parrot_pf_tag_constant(PARROT_INTERP, ARGIN(PackFile_ConstTable *ct),
const int tag_idx, const int const_idx)
{
ASSERT_ARGS(Parrot_pf_tag_constant)
int lo, hi, cur;
const STRING *tag = ct->str.constants[tag_idx];
/* allocate space */
if (ct->tag_map == NULL) {
ct->tag_map = mem_gc_allocate_n_zeroed_typed(interp, 1, PackFile_ConstTagPair);
ct->ntags = 1;
}
else {
ct->tag_map = mem_gc_realloc_n_typed_zeroed(interp, ct->tag_map, ct->ntags + 1, ct->ntags,
PackFile_ConstTagPair);
ct->ntags++;
}
/* find the slot to insert into */
lo = 0;
cur = 0;
hi = ct->ntags - 1;
while (lo < hi) {
cur = (lo + hi)/2;
switch (STRING_compare(interp, tag, ct->str.constants[ct->tag_map[cur].tag_idx])) {
case -1:
lo = ++cur;
break;
case 0:
lo = hi = cur;
break;
case 1:
hi = cur;
break;
}
}
mem_sys_memmove(&ct->tag_map[cur + 1], &ct->tag_map[cur],
((ct->ntags - 1) - cur) * sizeof (PackFile_ConstTagPair));
ct->tag_map[cur].tag_idx = tag_idx;
ct->tag_map[cur].const_idx = const_idx;
}
/*
=item C<PMC * Parrot_pf_subs_by_tag(PARROT_INTERP, PMC * pfpmc, STRING * flag)>
Get an array of Subs in the packfile by named flag.
=cut
*/
PARROT_EXPORT
PARROT_CANNOT_RETURN_NULL
PMC *
Parrot_pf_subs_by_tag(PARROT_INTERP, ARGIN(PMC * pfpmc), ARGIN(STRING * flag))
{
ASSERT_ARGS(Parrot_pf_subs_by_tag)
PackFile * const pf = (PackFile*)VTABLE_get_pointer(interp, pfpmc);
int mode = 0;
PMC * const subs = Parrot_pmc_new(interp, enum_class_ResizablePMCArray);
if (!pf || !pf->cur_cs || !pf->cur_cs->const_table)
Parrot_ex_throw_from_c_args(interp, NULL, EXCEPTION_UNEXPECTED_NULL,
"NULL or invalid packfile");
if (STRING_equal(interp, flag, CONST_STRING(interp, "load")))
mode = 1;
else if (STRING_equal(interp, flag, CONST_STRING(interp, "init")))
mode = 2;
{
PackFile_ConstTable * const ct = pf->cur_cs->const_table;
opcode_t flag_idx = -1;
int bottom_lo, bottom_hi, top_lo, top_hi, cur;
int i;
bottom_lo = top_lo = cur = 0;
bottom_hi = top_hi = ct->ntags;
/* find the first match (if any) */
while (flag_idx < 0) {
if (bottom_lo == top_hi) {
/* tag not present */
goto done_find_bounds;
}
cur = (bottom_lo + top_hi)/2;
switch (STRING_compare(interp, flag, ct->str.constants[ct->tag_map[cur].tag_idx])) {
case -1:
bottom_lo = cur + 1;
break;
case 0:
flag_idx = ct->tag_map[cur].tag_idx;
bottom_hi = cur;
top_lo = cur + 1;
break;
case 1:
top_hi = cur;
break;
}
}
/* find the bottom of the map's range with this tag */
while (bottom_lo < bottom_hi) {
cur = (bottom_lo + bottom_hi)/2;
if (ct->tag_map[cur].tag_idx == flag_idx)
bottom_hi = cur;
else
bottom_lo = cur + 1;
}
/* find the top */
while (top_lo < top_hi) {
cur = (top_lo + top_hi)/2;
if (ct->tag_map[cur].tag_idx == flag_idx)
top_lo = cur + 1;
else
top_hi = cur;
}
done_find_bounds:
for (i = bottom_lo; i < top_hi; i++)
VTABLE_push_pmc(interp, subs, ct->pmc.constants[ct->tag_map[i].const_idx]);
}
/* Backwards compatibility. :load is equivalent to "load" tag. :init is
equivalent to "init" tag */
if (mode == 1 || mode == 2) {
PackFile_ByteCode * const self = pf->cur_cs;
PackFile_ConstTable * const ct = self->const_table;
STRING * const SUB = CONST_STRING(interp, "Sub");
opcode_t i;
for (i = 0; i < ct->pmc.const_count; ++i) {
PMC * const sub_pmc = ct->pmc.constants[i];
Parrot_Sub_attributes *sub;
int pragmas;
if (!VTABLE_isa(interp, sub_pmc, SUB))
continue;
PMC_get_sub(interp, sub_pmc, sub);
pragmas = PObj_get_FLAGS(sub_pmc) & SUB_FLAG_PF_MASK & ~SUB_FLAG_IS_OUTER;
if (mode == 1 && (pragmas & SUB_FLAG_PF_LOAD))
VTABLE_push_pmc(interp, subs, sub_pmc);
else if (mode == 2 && Sub_comp_INIT_TEST(sub))
VTABLE_push_pmc(interp, subs, sub_pmc);
}
}
return subs;
}
/*
=item C<static int sub_pragma(PARROT_INTERP, pbc_action_enum_t action, const PMC
*sub_pmc)>
Checks B<sub_pmc>'s pragmas (e.g. flags like C<:load>, C<:main>, etc.)
returning 1 if the sub should be run for C<action>, a C<pbc_action_enum_t>.
=cut
*/
static int
sub_pragma(PARROT_INTERP, pbc_action_enum_t action, ARGIN(const PMC *sub_pmc))
{
ASSERT_ARGS(sub_pragma)
/* Note: the const casting is only needed because of the
* internal details of the Sub_comp macros.
* The assumption is that the TEST versions are in fact const,
* so the casts are safe.
* These casts are a quick fix to allow parrot build with c++,
* a refactor of the macros will be a cleaner solution. */
DECL_CONST_CAST;
Parrot_Sub_attributes *sub;
int todo = 0;
const int pragmas = PObj_get_FLAGS(sub_pmc) & SUB_FLAG_PF_MASK
& ~SUB_FLAG_IS_OUTER;
PMC_get_sub(interp, PARROT_const_cast(PMC *, sub_pmc), sub);
if (!pragmas && !Sub_comp_INIT_TEST(sub))
return 0;
switch (action) {
case PBC_MAIN:
/* denote MAIN entry in first loaded PASM */
if (interp->resume_flag & RESUME_INITIAL)
todo = 1;
/* :init functions need to be called at MAIN time, so return 1 */
/* symreg.h:P_INIT */
if (Sub_comp_INIT_TEST(sub))
todo = 1;
break;
case PBC_LOADED:
/* symreg.h:P_LOAD */
if (pragmas & SUB_FLAG_PF_LOAD)
todo = 1;
break;
default:
break;
}
if (pragmas & (SUB_FLAG_PF_IMMEDIATE | SUB_FLAG_PF_POSTCOMP))
todo = 1;
return todo;
}
/*
=item C<static PMC* do_1_sub_pragma(PARROT_INTERP, PMC *sub_pmc,
pbc_action_enum_t action)>
Runs autoloaded or immediate bytecode, marking the MAIN subroutine entry.
=cut
*/
PARROT_WARN_UNUSED_RESULT
PARROT_CAN_RETURN_NULL
static PMC*
do_1_sub_pragma(PARROT_INTERP, ARGMOD(PMC *sub_pmc), pbc_action_enum_t action)
{
ASSERT_ARGS(do_1_sub_pragma)
Parrot_Sub_attributes *sub;
PMC_get_sub(interp, sub_pmc, sub);
switch (action) {
case PBC_IMMEDIATE:
/* run IMMEDIATE sub */
if (PObj_get_FLAGS(sub_pmc) & SUB_FLAG_PF_IMMEDIATE) {
void * const lo_var_ptr = interp->lo_var_ptr;
PMC *result = PMCNULL;
PObj_get_FLAGS(sub_pmc) &= ~SUB_FLAG_PF_IMMEDIATE;
Parrot_pcc_invoke_sub_from_c_args(interp, sub_pmc, "->P", &result);
/* reset initial flag so MAIN detection works
* and reset lo_var_ptr to prev */
interp->resume_flag = RESUME_INITIAL;
interp->lo_var_ptr = lo_var_ptr;
return result;
}
break;
case PBC_POSTCOMP:
/* run POSTCOMP sub */
if (PObj_get_FLAGS(sub_pmc) & SUB_FLAG_PF_POSTCOMP) {
PObj_get_FLAGS(sub_pmc) &= ~SUB_FLAG_PF_POSTCOMP;
Parrot_pcc_invoke_sub_from_c_args(interp, sub_pmc, "->");
/* reset initial flag so MAIN detection works */
interp->resume_flag = RESUME_INITIAL;
return NULL;
}
break;
case PBC_LOADED:
if (PObj_get_FLAGS(sub_pmc) & SUB_FLAG_PF_LOAD) {
/* only run :init/:load subs once */
Sub_comp_INIT_CLEAR(sub);
PObj_get_FLAGS(sub_pmc) &= ~SUB_FLAG_PF_LOAD;
Parrot_pcc_invoke_sub_from_c_args(interp, sub_pmc, "->");
}
break;
case PBC_MAIN:
/* run :init/:load tagged functions */
if (Sub_comp_INIT_TEST(sub)) {
/* only run :init/:load subs once */
Sub_comp_INIT_CLEAR(sub);
PObj_get_FLAGS(sub_pmc) &= ~SUB_FLAG_PF_LOAD;
Parrot_pcc_invoke_sub_from_c_args(interp, sub_pmc, "->");
interp->resume_flag = RESUME_INITIAL;
}
break;
default:
break;
}
return NULL;
}
/*
=item C<static void mark_1_ct_seg(PARROT_INTERP, PackFile_ConstTable *ct)>
Mark one ConstTable segment for GC.
=cut
*/
static void
mark_1_ct_seg(PARROT_INTERP, ARGMOD(PackFile_ConstTable *ct))
{
ASSERT_ARGS(mark_1_ct_seg)
opcode_t i;
if (ct->string_hash)
Parrot_hash_mark(interp, ct->string_hash);
if (ct->pmc_hash)
Parrot_hash_mark(interp, ct->pmc_hash);
for (i = 0; i < ct->str.const_count; i++)
Parrot_gc_mark_STRING_alive(interp, ct->str.constants[i]);
for (i = 0; i < ct->pmc.const_count; i++)
Parrot_gc_mark_PMC_alive(interp, ct->pmc.constants[i]);
}
/*
=item C<static void mark_1_bc_seg(PARROT_INTERP, PackFile_ByteCode *bc)>
Mark gcables in bytecode header.
=cut
*/
static void
mark_1_bc_seg(PARROT_INTERP, ARGMOD(PackFile_ByteCode *bc))
{
ASSERT_ARGS(mark_1_bc_seg)
size_t i;
for (i = 0; i < bc->n_libdeps; i++)
Parrot_gc_mark_STRING_alive(interp, bc->libdeps[i]);
}
/*
=item C<static INTVAL find_const_iter(PARROT_INTERP, PackFile_Segment *seg, void
*user_data)>
Iterates over a PackFile_Directory, marking any constant segments. Internal
use only.
=cut
*/
static INTVAL
find_const_iter(PARROT_INTERP, ARGMOD(PackFile_Segment *seg), ARGIN_NULLOK(void *user_data))
{
ASSERT_ARGS(find_const_iter)
Parrot_gc_mark_STRING_alive(interp, seg->name);
switch (seg->type) {
case PF_DIR_SEG:
PackFile_map_segments(interp, (const PackFile_Directory *)seg,
find_const_iter, user_data);
break;
case PF_CONST_SEG:
mark_1_ct_seg(interp, (PackFile_ConstTable *)seg);
break;
case PF_BYTEC_SEG:
mark_1_bc_seg(interp, (PackFile_ByteCode *)seg);
break;
default:
break;
}
return 0;
}
/*
=item C<void Parrot_pf_mark_packfile(PARROT_INTERP, PackFile * pf)>
Mark the contents of a C<PackFile>.
=cut
*/
void
Parrot_pf_mark_packfile(PARROT_INTERP, ARGMOD_NULLOK(PackFile * pf))
{
ASSERT_ARGS(Parrot_pf_mark_packfile)
if (!pf)
return;
else {
/* locate top level dir */
PackFile_Directory * const dir = &pf->directory;
/* iterate over all dir/segs */
PackFile_map_segments(interp, dir, find_const_iter, NULL);
}
}
/*
=item C<PMC * Parrot_pf_get_packfile_main_sub(PARROT_INTERP, PMC * pbc)>
Get the main function of the bytecode segment, if any.
=item C<static PMC * packfile_main(PackFile_ByteCode *bc)>
Access the main function of a bytecode segment.
=cut
*/
PARROT_CANNOT_RETURN_NULL
PMC *
Parrot_pf_get_packfile_main_sub(PARROT_INTERP, ARGIN(PMC * pbc))
{
ASSERT_ARGS(Parrot_pf_get_packfile_main_sub)
PackFile * const pf = (PackFile*)VTABLE_get_pointer(interp, pbc);
if (pf == NULL || pf->cur_cs == NULL || pf->cur_cs->const_table == NULL)
Parrot_ex_throw_from_c_args(interp, NULL, EXCEPTION_UNEXPECTED_NULL,
"Null or invalid PackFile");
return packfile_main(pf->cur_cs);
}
PARROT_CANNOT_RETURN_NULL
static PMC *
packfile_main(ARGIN(PackFile_ByteCode *bc))
{
ASSERT_ARGS(packfile_main)
const PackFile_ConstTable * const ct = bc->const_table;
return ct->pmc.constants[bc->main_sub];
}
/*
=item C<void do_sub_pragmas(PARROT_INTERP, PMC *pfpmc, pbc_action_enum_t action,
PMC *eval_pmc)>
C<action> is one of C<PBC_LOADED>, C<PBC_INIT>, or C<PBC_MAIN>.
These determine which subs get executed at this point. Some rules:
:immediate subs always execute immediately
:postcomp subs always execute immediately
:main subs execute when we have the PBC_MAIN action
:init subs execute when :main does
:load subs execute on PBC_LOAD
Also store the C<eval_pmc> in the sub structure, so that the eval PMC is kept
alive by living subs.
This function and the entire underlying mechanism should be deprecated and
removed. See GH #428 for details.
=cut
*/
PARROT_EXPORT
void
do_sub_pragmas(PARROT_INTERP, ARGIN(PMC *pfpmc),
pbc_action_enum_t action, ARGIN_NULLOK(PMC *eval_pmc))
{
ASSERT_ARGS(do_sub_pragmas)
PackFile * const pf = (PackFile*)VTABLE_get_pointer(interp, pfpmc);
PackFile_ByteCode * const self = pf->cur_cs;
PackFile_ConstTable * const ct = self->const_table;
opcode_t i;
for (i = 0; i < ct->pmc.const_count; ++i) {
STRING * const SUB = CONST_STRING(interp, "Sub");
PMC * const sub_pmc = ct->pmc.constants[i];
if (VTABLE_isa(interp, sub_pmc, SUB)) {
Parrot_Sub_attributes *sub;
PMC_get_sub(interp, sub_pmc, sub);
if (action == 0)
continue;
if (((PObj_get_FLAGS(sub_pmc) & SUB_FLAG_PF_MASK)
|| (Sub_comp_get_FLAGS(sub) & SUB_COMP_FLAG_MASK))
&& sub_pragma(interp, action, sub_pmc)) {
PMC * const result = do_1_sub_pragma(interp, sub_pmc, action);
/* replace Sub PMC with computation results */
if (action == PBC_IMMEDIATE && !PMC_IS_NULL(result)) {
ct->pmc.constants[i] = result;
PARROT_GC_WRITE_BARRIER(interp, pfpmc);
}
}
}
}
if (interp->resume_flag & RESUME_INITIAL) {
if (action == PBC_MAIN) {
if (self->main_sub < 0)
Parrot_ex_throw_from_c_args(interp, NULL, EXCEPTION_LIBRARY_ERROR,
"No main sub found");
{
PMC * const mainsub = packfile_main(self);
opcode_t * const ptr = (opcode_t *)VTABLE_get_pointer(interp, mainsub);
Parrot_Sub_attributes *main_attrs;
PMC_get_sub(interp, mainsub, main_attrs);
interp->resume_offset = (ptr - main_attrs->seg->base.data);
}
}
}
}
/*
=item C<static void PackFile_Header_validate(PARROT_INTERP, const
PackFile_Header *self, INTVAL pf_options)>
Validates a C<PackFile_Header>, ensuring that the magic number is valid and
that Parrot can read this bytecode version.
Raises an exception if the header doesn't validate.
=cut
*/
static void
PackFile_Header_validate(PARROT_INTERP, ARGIN(const PackFile_Header *self),
INTVAL pf_options)
{
ASSERT_ARGS(PackFile_Header_validate)
/* Ensure the magic is correct. */
if (memcmp(self->magic, "\376PBC\r\n\032\n", 8) != 0) {
Parrot_ex_throw_from_c_args(interp, NULL, EXCEPTION_MALFORMED_PACKFILE,
"PackFile_Header_validate: This is not a valid Parrot bytecode file.");
}
/* Ensure the bytecode version is one we can read. Currently, we only
* support bytecode versions matching the current one.
*
* tools/dev/pbc_header.pl --upd t/native_pbc/(ASTERISK).pbc
* stamps version and fingerprint in the native tests.
* NOTE: (ASTERISK) is *, we don't want to fool the C preprocessor. */
if (self->bc_major != PARROT_PBC_MAJOR
|| self->bc_minor != PARROT_PBC_MINOR) {
if (!(pf_options & PFOPT_UTILS))
Parrot_ex_throw_from_c_args(interp, NULL, EXCEPTION_PARROT_USAGE_ERROR,
"PackFile_Header_validate: This Parrot cannot read bytecode "
"files with version %d.%d.",
self->bc_major, self->bc_minor);
}
/* Check wordsize, byte order and floating point number type are valid. */
if (self->wordsize != 4 && self->wordsize != 8) {
Parrot_ex_throw_from_c_args(interp, NULL, EXCEPTION_MALFORMED_PACKFILE,
"PackFile_Header_validate: Invalid wordsize %d\n", self->wordsize);
}
if (self->byteorder != 0 && self->byteorder != 1) {
Parrot_ex_throw_from_c_args(interp, NULL, EXCEPTION_MALFORMED_PACKFILE,
"PackFile_Header_validate: Invalid byte ordering %d\n", self->byteorder);
}
if (self->floattype > FLOATTYPE_MAX) {
Parrot_ex_throw_from_c_args(interp, NULL, EXCEPTION_MALFORMED_PACKFILE,
"PackFile_Header_validate: Invalid floattype %d\n", self->floattype);
}
}
/*
=item C<static void PackFile_Header_read_uuid(PARROT_INTERP, PackFile_Header
*self, const opcode_t *packed, size_t packed_size)>
Reads a C<PackFile_Header>'s UUID from a block of memory and verifies that it
is valid.
=cut
*/
static void
PackFile_Header_read_uuid(PARROT_INTERP, ARGMOD(PackFile_Header *self),
ARGIN(const opcode_t *packed), size_t packed_size)
{
ASSERT_ARGS(PackFile_Header_read_uuid)
/* Check the UUID type is valid and, if needed, read a UUID. */
if (self->uuid_type == 0) {
/* No UUID; fine, nothing more to do. */
}
else if (self->uuid_type == 1) {
if (packed_size < (size_t) PACKFILE_HEADER_BYTES + self->uuid_size) {
Parrot_ex_throw_from_c_args(interp, NULL, EXCEPTION_MALFORMED_PACKFILE,
"PackFile_Header_read_uuid: Buffer length %d is shorter than PACKFILE_HEADER_BYTES "
"+ uuid_size %d\n", packed_size, PACKFILE_HEADER_BYTES + self->uuid_size);
}
/* Read in the UUID. We'll put it in a NULL-terminated string, just in
* case people use it that way. */
self->uuid_data = mem_gc_allocate_n_typed(interp,
self->uuid_size + 1, unsigned char);
memcpy(self->uuid_data, packed + PACKFILE_HEADER_BYTES,
self->uuid_size);
/* NULL terminate */
self->uuid_data[self->uuid_size] = '\0';
}
else
/* Don't know this UUID type. */
Parrot_ex_throw_from_c_args(interp, NULL, EXCEPTION_MALFORMED_PACKFILE,
"PackFile_unpack: Invalid UUID type %d\n", self->uuid_type);
}
/*
=item C<static int PackFile_Header_unpack(PARROT_INTERP, PackFile_Header *self,
const opcode_t *packed, size_t packed_size, INTVAL pf_options)>
Unpacks a C<PackFile_Header> from a block of memory and perform some validation
to check that the head is correct.
Returns size of unpacked header.
=cut
*/
PARROT_WARN_UNUSED_RESULT
static int
PackFile_Header_unpack(PARROT_INTERP, ARGMOD(PackFile_Header *self),
ARGIN(const opcode_t *packed), size_t packed_size,
INTVAL pf_options)
{
ASSERT_ARGS(PackFile_Header_unpack)
/* Verify that the packfile isn't too small to contain a proper header */
if (packed_size < PACKFILE_HEADER_BYTES) {