/
packfile.h
1246 lines (1085 loc) · 42.3 KB
/
packfile.h
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-2012, Parrot Foundation.
*/
/* packfile.h
*
*
* History:
* Rework by Melvin; new bytecode format, make bytecode portable.
* (Do endian conversion and wordsize transforms on the fly.)
*/
#ifndef PARROT_PACKFILE_H_GUARD
#define PARROT_PACKFILE_H_GUARD
#include "parrot/parrot.h"
#define DIRECTORY_SEGMENT_NAME Parrot_str_new_constant(interp, "DIRECTORY")
#define FIXUP_TABLE_SEGMENT_NAME Parrot_str_new_constant(interp, "FIXUP")
#define CONSTANT_SEGMENT_NAME Parrot_str_new_constant(interp, "CONSTANT")
#define BYTE_CODE_SEGMENT_NAME Parrot_str_new_constant(interp, "BYTECODE")
#define FLOATTYPE_8 0
#define FLOATTYPE_8_NAME "IEEE-754 8 byte double"
#define FLOATTYPE_12 1
#define FLOATTYPE_12_NAME "x86 little endian 12 byte long double"
#define FLOATTYPE_16 2
#define FLOATTYPE_16_NAME "IEEE-754 16 byte long double"
/* Supported until here. */
#define FLOATTYPE_MAX 2
/* Non IEEE-754 versions, yet unsupported. */
/* NaN difference, but patches welcome */
#define FLOATTYPE_16MIPS 3
#define FLOATTYPE_16MIPS_NAME "MIPS 16 byte long double"
/* See http://www.ncsa.uiuc.edu/UserInfo/Resources/Hardware/IBMp690/IBM/usr/share/ ...
* man/info/en_US/a_doc_lib/aixprggd/genprogc/128bit_long_double_floating-point_datatype.htm */
#define FLOATTYPE_16AIX 4
#define FLOATTYPE_16AIX_NAME "AIX 16 byte long double"
/* IEEE-754 old and tiny, yet unsupported */
#define FLOATTYPE_4 5
#define FLOATTYPE_4_NAME "4-byte float"
/*
** Parrot_pbc_read() options:
** parrot, pbc_merge, parrot_debugger use 0
** pbc_dump, pbc_disassemble use 1 to skip the version check
** pbc_dump -h requires 2
*/
#define PFOPT_NONE 0
#define PFOPT_UTILS 1
#define PFOPT_HEADERONLY 2
#define PFOPT_PMC_FREEZE_ONLY 4
/*
** Enumerated constants
** Changes here require update PBC_COMPAT
** The preferred way to eliminate a value is just to stop using it without
** renumbering others, that helps to keep backward compatibility.
*/
/* Packfile segment types */
/* &gen_from_enum(packfile_segments.pasm) */
typedef enum {
PF_DIR_SEG = 0,
PF_UNKNOWN_SEG = 1,
PF_CONST_SEG = 2,
PF_BYTEC_SEG = 3,
PF_DEBUG_SEG = 4,
PF_ANNOTATIONS_SEG = 5,
PF_MAX_SEG = 6
} pack_file_types;
/* &end_gen */
#define PF_DIR_FORMAT 1
/*
** Structure Definitions:
*/
/*
** The number of bytes in the packfile header that we can read/write
** directly. This excludes the final element in the struct, which holds a
** pointer to the UUID data, if there is any.
*/
#define PACKFILE_HEADER_BYTES 18
typedef struct PackFile_Header {
/* Magic string to identify the PBC file. */
unsigned char magic[8];
/* Word size, byte ordering and floating point number format. */
unsigned char wordsize;
unsigned char byteorder;
unsigned char floattype;
/* Version of Parrot that wrote the bytecode file. */
unsigned char major;
unsigned char minor;
unsigned char patch;
/* Bytecode format version. */
unsigned char bc_major;
unsigned char bc_minor;
/* UUID type and length. */
unsigned char uuid_type;
unsigned char uuid_size;
/* The UUID data. */
unsigned char *uuid_data;
/* Directory format. */
opcode_t dir_format;
} PackFile_Header;
/*
** PackFile Segment:
* The base type of every section
* include it as first element of every derivated Segment
*/
typedef struct PackFile_Segment * (*PackFile_Segment_new_func_t)(PARROT_INTERP);
typedef void (*PackFile_Segment_destroy_func_t)
(PARROT_INTERP, ARGMOD(struct PackFile_Segment *segp));
typedef size_t (*PackFile_Segment_packed_size_func_t)
(PARROT_INTERP, ARGMOD(struct PackFile_Segment *segp));
typedef opcode_t * (*PackFile_Segment_pack_func_t)
(PARROT_INTERP, ARGMOD(struct PackFile_Segment *segp), ARGOUT(opcode_t *dest));
typedef const opcode_t * (*PackFile_Segment_unpack_func_t)
(PARROT_INTERP, ARGMOD(struct PackFile_Segment *segp), ARGIN(const opcode_t *packed));
typedef void (*PackFile_Segment_dump_func_t)
(PARROT_INTERP, ARGIN(const struct PackFile_Segment *));
typedef struct PackFile_funcs {
PackFile_Segment_new_func_t new_seg;
PackFile_Segment_destroy_func_t destroy;
PackFile_Segment_packed_size_func_t packed_size;
PackFile_Segment_pack_func_t pack;
PackFile_Segment_unpack_func_t unpack;
PackFile_Segment_dump_func_t dump;
} PackFile_funcs;
typedef struct PackFile_Segment {
struct PackFile * pf;
struct PackFile_Directory * dir;
/* directory information */
UINTVAL type; /* one of above defined types */
STRING *name;
size_t op_count; /* external size in ops */
size_t file_offset; /* offset in ops */
/* common payload of all bytecode chunks
* with the size above these four items are aligned to 16 byte */
opcode_t itype; /* internal type/version */
opcode_t id; /* internal id */
size_t size; /* internal oparray size */
opcode_t *data; /* oparray e.g. bytecode */
} PackFile_Segment;
typedef INTVAL (*PackFile_map_segments_func_t)(PARROT_INTERP,
ARGMOD(PackFile_Segment *seg), ARGIN_NULLOK(void *user_data));
typedef struct PackFile_ConstTagPair {
opcode_t tag_idx;
opcode_t const_idx;
} PackFile_ConstTagPair;
typedef struct PackFile_ConstTable {
PackFile_Segment base;
struct {
opcode_t const_count;
FLOATVAL *constants;
} num;
struct {
opcode_t const_count;
STRING **constants;
} str;
struct {
opcode_t const_count;
PMC **constants;
} pmc;
PackFile_ByteCode *code; /* where this segment belongs to */
Hash *string_hash; /* Hash for lookup of string indices */
Hash *pmc_hash; /* Hash for lookup of pmc indices */
PackFile_ConstTagPair *tag_map; /* n-m Mapping pmc constants to string tags */
opcode_t ntags; /* Number of tags */
} PackFile_ConstTable;
typedef struct PackFile_ByteCode_OpMappingEntry {
op_lib_t *lib; /* library for this entry */
opcode_t n_ops; /* number of ops used */
opcode_t *lib_ops; /* indices of ops within the library */
opcode_t *table_ops; /* indices of ops within the op table */
} PackFile_ByteCode_OpMappingEntry;
typedef struct PackFile_ByteCode_OpMapping {
opcode_t n_libs; /* number of library entries */
PackFile_ByteCode_OpMappingEntry *libs; /* opcode libraries used by this segment */
} PackFile_ByteCode_OpMapping;
struct PackFile_ByteCode {
PackFile_Segment base;
struct PackFile_Debug *debugs;
PackFile_ConstTable *const_table;
INTVAL main_sub; /* index into constant table of main sub */
struct PackFile_Annotations *annotations;
PackFile_ByteCode_OpMapping op_mapping; /* opcode mapping information */
size_t op_count; /* number of ops in the func table */
op_func_t *op_func_table; /* opcode dispatch table */
op_func_t *save_func_table; /* for when we hijack op_func_table */
op_info_t **op_info_table;
size_t n_libdeps; /* number of library dependancies */
STRING **libdeps; /* names of prerequisite libraries */
};
typedef struct PackFile_DebugFilenameMapping {
opcode_t offset;
opcode_t filename;
} PackFile_DebugFilenameMapping;
typedef struct PackFile_Debug {
PackFile_Segment base;
opcode_t num_mappings;
PackFile_DebugFilenameMapping *mappings;
PackFile_ByteCode *code; /* where this segment belongs to */
} PackFile_Debug;
#define ANN_ENTRY_OFF 0
#define ANN_ENTRY_VAL 1
/* &gen_from_def(packfile_annotation_keytype.pasm) */
/* Key types for annotation segment. */
typedef enum {
PF_ANNOTATION_KEY_TYPE_INT = 1,
PF_ANNOTATION_KEY_TYPE_STR = 2,
PF_ANNOTATION_KEY_TYPE_PMC = 3
} pf_ann_key_type_t;
/* &end_gen */
typedef struct PackFile_Annotations_Key {
UINTVAL name;
pf_ann_key_type_t type;
UINTVAL start;
UINTVAL len;
} PackFile_Annotations_Key;
typedef struct PackFile_Annotations {
PackFile_Segment base;
PackFile_ByteCode *code;
opcode_t num_keys;
PackFile_Annotations_Key *keys;
} PackFile_Annotations;
typedef struct PackFile_Directory {
PackFile_Segment base;
size_t num_segments;
PackFile_Segment **segments;
} PackFile_Directory;
typedef opcode_t (*packfile_fetch_op_t)(ARGIN(const unsigned char *));
typedef INTVAL (*packfile_fetch_iv_t)(ARGIN(const unsigned char *));
typedef void (*packfile_fetch_nv_t)(ARGOUT(unsigned char *), ARGIN(const unsigned char *));
typedef struct PackFile {
/* the packfile is its own directory */
PackFile_Directory directory;
PackFile_Directory *dirp; /* for freeing */
const opcode_t *src; /* possible mmap()ed start of the PF */
size_t size; /* size in bytes */
INTVAL is_mmap_ped; /* don't free it, munmap it at destroy */
PackFile_Header *header;
/* directory hold all Segments */
PackFile_funcs PackFuncs[PF_MAX_SEG];
PackFile_ByteCode *cur_cs; /* used during PF loading */
PMC *view; /* cached PMC used to reference this packfile */
INTVAL options;
INTVAL need_wordsize;
INTVAL need_endianize;
packfile_fetch_op_t fetch_op;
packfile_fetch_iv_t fetch_iv;
packfile_fetch_nv_t fetch_nv;
} PackFile;
typedef enum {
PBC_MAIN = 1,
PBC_LOADED = 2,
PBC_IMMEDIATE = 8,
PBC_POSTCOMP = 16,
PBC_INIT = 32
} pbc_action_enum_t;
/* HEADERIZER BEGIN: src/packfile/pf_items.c */
/* Don't modify between HEADERIZER BEGIN / HEADERIZER END. Your changes will be lost. */
void PackFile_assign_transforms(ARGMOD(PackFile *pf))
__attribute__nonnull__(1)
FUNC_MODIFIES(*pf);
PARROT_WARN_UNUSED_RESULT
PARROT_CANNOT_RETURN_NULL
STRING * PF_fetch_buf(PARROT_INTERP,
ARGIN_NULLOK(PackFile *pf),
ARGIN(const opcode_t **cursor))
__attribute__nonnull__(1)
__attribute__nonnull__(3);
PARROT_MALLOC
PARROT_CANNOT_RETURN_NULL
char * PF_fetch_cstring(PARROT_INTERP,
ARGIN(PackFile *pf),
ARGIN(const opcode_t **cursor))
__attribute__nonnull__(1)
__attribute__nonnull__(2)
__attribute__nonnull__(3);
PARROT_WARN_UNUSED_RESULT
INTVAL PF_fetch_integer(ARGIN(PackFile *pf), ARGIN(const opcode_t **stream))
__attribute__nonnull__(1)
__attribute__nonnull__(2);
PARROT_WARN_UNUSED_RESULT
FLOATVAL PF_fetch_number(
ARGIN_NULLOK(PackFile *pf),
ARGIN(const opcode_t **stream))
__attribute__nonnull__(2);
PARROT_CANNOT_RETURN_NULL
opcode_t PF_fetch_opcode(
ARGIN_NULLOK(const PackFile *pf),
ARGMOD(const opcode_t **stream))
__attribute__nonnull__(2)
FUNC_MODIFIES(*stream);
PARROT_WARN_UNUSED_RESULT
PARROT_CANNOT_RETURN_NULL
STRING * PF_fetch_string(PARROT_INTERP,
ARGIN_NULLOK(PackFile *pf),
ARGIN(const opcode_t **cursor))
__attribute__nonnull__(1)
__attribute__nonnull__(3);
PARROT_PURE_FUNCTION
size_t PF_size_buf(ARGIN(const STRING *s))
__attribute__nonnull__(1);
PARROT_PURE_FUNCTION
size_t PF_size_cstring(ARGIN(const char *s))
__attribute__nonnull__(1);
PARROT_CONST_FUNCTION
size_t PF_size_integer(void);
PARROT_CONST_FUNCTION
size_t PF_size_number(void);
PARROT_CONST_FUNCTION
PARROT_WARN_UNUSED_RESULT
size_t PF_size_opcode(void);
PARROT_PURE_FUNCTION
size_t PF_size_string(ARGIN(const STRING *s))
__attribute__nonnull__(1);
PARROT_CONST_FUNCTION
PARROT_WARN_UNUSED_RESULT
size_t PF_size_strlen(const UINTVAL len);
PARROT_WARN_UNUSED_RESULT
PARROT_CANNOT_RETURN_NULL
opcode_t* PF_store_buf(ARGOUT(opcode_t *cursor), ARGIN(const STRING *s))
__attribute__nonnull__(1)
__attribute__nonnull__(2)
FUNC_MODIFIES(*cursor);
PARROT_WARN_UNUSED_RESULT
PARROT_CANNOT_RETURN_NULL
opcode_t* PF_store_cstring(ARGOUT(opcode_t *cursor), ARGIN(const char *s))
__attribute__nonnull__(1)
__attribute__nonnull__(2)
FUNC_MODIFIES(*cursor);
PARROT_WARN_UNUSED_RESULT
PARROT_CANNOT_RETURN_NULL
opcode_t* PF_store_integer(ARGOUT(opcode_t *cursor), INTVAL val)
__attribute__nonnull__(1)
FUNC_MODIFIES(*cursor);
PARROT_WARN_UNUSED_RESULT
PARROT_CANNOT_RETURN_NULL
opcode_t* PF_store_number(
ARGOUT(opcode_t *cursor),
ARGIN(const FLOATVAL *val))
__attribute__nonnull__(1)
__attribute__nonnull__(2)
FUNC_MODIFIES(*cursor);
PARROT_WARN_UNUSED_RESULT
PARROT_CANNOT_RETURN_NULL
opcode_t* PF_store_opcode(ARGOUT(opcode_t *cursor), opcode_t val)
__attribute__nonnull__(1)
FUNC_MODIFIES(*cursor);
PARROT_WARN_UNUSED_RESULT
PARROT_CANNOT_RETURN_NULL
opcode_t* PF_store_string(ARGOUT(opcode_t *cursor), ARGIN(const STRING *s))
__attribute__nonnull__(1)
__attribute__nonnull__(2)
FUNC_MODIFIES(*cursor);
#define ASSERT_ARGS_PackFile_assign_transforms __attribute__unused__ int _ASSERT_ARGS_CHECK = (\
PARROT_ASSERT_ARG(pf))
#define ASSERT_ARGS_PF_fetch_buf __attribute__unused__ int _ASSERT_ARGS_CHECK = (\
PARROT_ASSERT_ARG(interp) \
, PARROT_ASSERT_ARG(cursor))
#define ASSERT_ARGS_PF_fetch_cstring __attribute__unused__ int _ASSERT_ARGS_CHECK = (\
PARROT_ASSERT_ARG(interp) \
, PARROT_ASSERT_ARG(pf) \
, PARROT_ASSERT_ARG(cursor))
#define ASSERT_ARGS_PF_fetch_integer __attribute__unused__ int _ASSERT_ARGS_CHECK = (\
PARROT_ASSERT_ARG(pf) \
, PARROT_ASSERT_ARG(stream))
#define ASSERT_ARGS_PF_fetch_number __attribute__unused__ int _ASSERT_ARGS_CHECK = (\
PARROT_ASSERT_ARG(stream))
#define ASSERT_ARGS_PF_fetch_opcode __attribute__unused__ int _ASSERT_ARGS_CHECK = (\
PARROT_ASSERT_ARG(stream))
#define ASSERT_ARGS_PF_fetch_string __attribute__unused__ int _ASSERT_ARGS_CHECK = (\
PARROT_ASSERT_ARG(interp) \
, PARROT_ASSERT_ARG(cursor))
#define ASSERT_ARGS_PF_size_buf __attribute__unused__ int _ASSERT_ARGS_CHECK = (\
PARROT_ASSERT_ARG(s))
#define ASSERT_ARGS_PF_size_cstring __attribute__unused__ int _ASSERT_ARGS_CHECK = (\
PARROT_ASSERT_ARG(s))
#define ASSERT_ARGS_PF_size_integer __attribute__unused__ int _ASSERT_ARGS_CHECK = (0)
#define ASSERT_ARGS_PF_size_number __attribute__unused__ int _ASSERT_ARGS_CHECK = (0)
#define ASSERT_ARGS_PF_size_opcode __attribute__unused__ int _ASSERT_ARGS_CHECK = (0)
#define ASSERT_ARGS_PF_size_string __attribute__unused__ int _ASSERT_ARGS_CHECK = (\
PARROT_ASSERT_ARG(s))
#define ASSERT_ARGS_PF_size_strlen __attribute__unused__ int _ASSERT_ARGS_CHECK = (0)
#define ASSERT_ARGS_PF_store_buf __attribute__unused__ int _ASSERT_ARGS_CHECK = (\
PARROT_ASSERT_ARG(cursor) \
, PARROT_ASSERT_ARG(s))
#define ASSERT_ARGS_PF_store_cstring __attribute__unused__ int _ASSERT_ARGS_CHECK = (\
PARROT_ASSERT_ARG(cursor) \
, PARROT_ASSERT_ARG(s))
#define ASSERT_ARGS_PF_store_integer __attribute__unused__ int _ASSERT_ARGS_CHECK = (\
PARROT_ASSERT_ARG(cursor))
#define ASSERT_ARGS_PF_store_number __attribute__unused__ int _ASSERT_ARGS_CHECK = (\
PARROT_ASSERT_ARG(cursor) \
, PARROT_ASSERT_ARG(val))
#define ASSERT_ARGS_PF_store_opcode __attribute__unused__ int _ASSERT_ARGS_CHECK = (\
PARROT_ASSERT_ARG(cursor))
#define ASSERT_ARGS_PF_store_string __attribute__unused__ int _ASSERT_ARGS_CHECK = (\
PARROT_ASSERT_ARG(cursor) \
, PARROT_ASSERT_ARG(s))
/* Don't modify between HEADERIZER BEGIN / HEADERIZER END. Your changes will be lost. */
/* HEADERIZER END: src/packfile/pf_items.c */
/* HEADERIZER BEGIN: frontend/pbc_dump/packdump.c */
/* Don't modify between HEADERIZER BEGIN / HEADERIZER END. Your changes will be lost. */
PARROT_EXPORT
void PackFile_ConstTable_dump(PARROT_INTERP,
ARGIN(const PackFile_ConstTable *self))
__attribute__nonnull__(1)
__attribute__nonnull__(2);
#define ASSERT_ARGS_PackFile_ConstTable_dump __attribute__unused__ int _ASSERT_ARGS_CHECK = (\
PARROT_ASSERT_ARG(interp) \
, PARROT_ASSERT_ARG(self))
/* Don't modify between HEADERIZER BEGIN / HEADERIZER END. Your changes will be lost. */
/* HEADERIZER END: frontend/pbc_dump/packdump.c */
/* HEADERIZER BEGIN: src/packfile/api.c */
/* Don't modify between HEADERIZER BEGIN / HEADERIZER END. Your changes will be lost. */
PARROT_EXPORT
void do_sub_pragmas(PARROT_INTERP,
ARGIN(PMC *pfpmc),
pbc_action_enum_t action,
PMC *eval_pmc)
__attribute__nonnull__(1)
__attribute__nonnull__(2);
PARROT_EXPORT
void PackFile_add_segment(PARROT_INTERP,
ARGMOD(PackFile_Directory *dir),
ARGMOD(PackFile_Segment *seg))
__attribute__nonnull__(1)
__attribute__nonnull__(2)
__attribute__nonnull__(3)
FUNC_MODIFIES(*dir)
FUNC_MODIFIES(*seg);
PARROT_EXPORT
void PackFile_Annotations_add_entry(PARROT_INTERP,
ARGMOD(PackFile_Annotations *self),
opcode_t offset,
opcode_t key,
opcode_t type,
opcode_t value)
__attribute__nonnull__(1)
__attribute__nonnull__(2)
FUNC_MODIFIES(*self);
PARROT_EXPORT
void PackFile_destroy(PARROT_INTERP, ARGMOD(PackFile *pf))
__attribute__nonnull__(1)
__attribute__nonnull__(2)
FUNC_MODIFIES(*pf);
PARROT_EXPORT
PARROT_WARN_UNUSED_RESULT
PARROT_CAN_RETURN_NULL
PackFile_Segment * PackFile_find_segment(PARROT_INTERP,
ARGIN_NULLOK(PackFile_Directory *dir),
ARGIN(const STRING *name),
int sub_dir)
__attribute__nonnull__(1)
__attribute__nonnull__(3);
PARROT_EXPORT
void PackFile_fixup_subs(PARROT_INTERP,
pbc_action_enum_t what,
ARGIN_NULLOK(PMC *eval))
__attribute__nonnull__(1);
PARROT_EXPORT
INTVAL PackFile_map_segments(PARROT_INTERP,
ARGIN(const PackFile_Directory *dir),
PackFile_map_segments_func_t callback,
ARGIN_NULLOK(void *user_data))
__attribute__nonnull__(1)
__attribute__nonnull__(2);
PARROT_EXPORT
PARROT_WARN_UNUSED_RESULT
PARROT_CANNOT_RETURN_NULL
PackFile * PackFile_new(PARROT_INTERP, INTVAL is_mapped)
__attribute__nonnull__(1);
PARROT_EXPORT
PARROT_WARN_UNUSED_RESULT
opcode_t PackFile_unpack(PARROT_INTERP,
ARGMOD(PackFile *self),
ARGIN(const opcode_t *packed),
size_t packed_size)
__attribute__nonnull__(1)
__attribute__nonnull__(2)
__attribute__nonnull__(3)
FUNC_MODIFIES(*self);
PARROT_EXPORT
void Parrot_debug_add_mapping(PARROT_INTERP,
ARGMOD(PackFile_Debug *debug),
opcode_t offset,
ARGIN(STRING *filename))
__attribute__nonnull__(1)
__attribute__nonnull__(2)
__attribute__nonnull__(4)
FUNC_MODIFIES(*debug);
PARROT_EXPORT
PARROT_WARN_UNUSED_RESULT
PARROT_CANNOT_RETURN_NULL
STRING * Parrot_debug_pc_to_filename(PARROT_INTERP,
ARGIN(const PackFile_Debug *debug),
opcode_t pc)
__attribute__nonnull__(1)
__attribute__nonnull__(2);
PARROT_EXPORT
void Parrot_load_bytecode(PARROT_INTERP,
ARGIN_NULLOK(Parrot_String file_str))
__attribute__nonnull__(1);
PARROT_EXPORT
void Parrot_load_language(PARROT_INTERP, ARGIN_NULLOK(STRING *lang_name))
__attribute__nonnull__(1);
PARROT_EXPORT
PARROT_WARN_UNUSED_RESULT
PARROT_CANNOT_RETURN_NULL
PackFile_Debug * Parrot_new_debug_seg(PARROT_INTERP,
ARGMOD(PackFile_ByteCode *cs),
size_t size)
__attribute__nonnull__(1)
__attribute__nonnull__(2)
FUNC_MODIFIES(*cs);
PARROT_EXPORT
PARROT_WARN_UNUSED_RESULT
PARROT_CANNOT_RETURN_NULL
PackFile_ByteCode * Parrot_pf_create_default_segments(PARROT_INTERP,
ARGIN(PMC * const pf_pmc),
ARGIN(STRING * file_name),
int add)
__attribute__nonnull__(1)
__attribute__nonnull__(2)
__attribute__nonnull__(3);
PARROT_EXPORT
PARROT_CANNOT_RETURN_NULL
PackFile * Parrot_pf_deserialize(PARROT_INTERP, ARGIN(STRING *str))
__attribute__nonnull__(1)
__attribute__nonnull__(2);
PARROT_EXPORT
void Parrot_pf_destroy(PARROT_INTERP, ARGMOD(PackFile *pf))
__attribute__nonnull__(1)
__attribute__nonnull__(2)
FUNC_MODIFIES(*pf);
PARROT_EXPORT
void Parrot_pf_execute_bytecode_program(PARROT_INTERP,
ARGMOD(PMC *pbc),
ARGMOD(PMC *args))
__attribute__nonnull__(1)
__attribute__nonnull__(2)
__attribute__nonnull__(3)
FUNC_MODIFIES(*pbc)
FUNC_MODIFIES(*args);
PARROT_EXPORT
PARROT_CANNOT_RETURN_NULL
PackFile_Annotations * Parrot_pf_get_annotations_segment(PARROT_INTERP,
ARGMOD(PackFile *pf),
ARGMOD_NULLOK(PackFile_ByteCode *bc))
__attribute__nonnull__(1)
__attribute__nonnull__(2)
FUNC_MODIFIES(*pf)
FUNC_MODIFIES(*bc);
PARROT_EXPORT
PARROT_CANNOT_RETURN_NULL
PMC * Parrot_pf_get_packfile_pmc(PARROT_INTERP,
ARGIN(PackFile *pf),
ARGIN(STRING *path))
__attribute__nonnull__(1)
__attribute__nonnull__(2)
__attribute__nonnull__(3);
PARROT_EXPORT
PARROT_CANNOT_RETURN_NULL
STRING * Parrot_pf_get_version_string(PARROT_INTERP, ARGIN(PMC * pbc))
__attribute__nonnull__(1)
__attribute__nonnull__(2);
PARROT_EXPORT
PARROT_CANNOT_RETURN_NULL
PMC * Parrot_pf_load_bytecode_search(PARROT_INTERP, ARGIN(STRING *file))
__attribute__nonnull__(1)
__attribute__nonnull__(2);
PARROT_EXPORT
PARROT_WARN_UNUSED_RESULT
PARROT_CANNOT_RETURN_NULL
PackFile * Parrot_pf_new(PARROT_INTERP, INTVAL is_mapped)
__attribute__nonnull__(1);
PARROT_EXPORT
void Parrot_pf_prepare_packfile_init(PARROT_INTERP,
ARGIN(PMC * const pfpmc))
__attribute__nonnull__(1)
__attribute__nonnull__(2);
PARROT_EXPORT
void Parrot_pf_prepare_packfile_load(PARROT_INTERP,
ARGIN(PMC * const pfpmc))
__attribute__nonnull__(1)
__attribute__nonnull__(2);
PARROT_EXPORT
PARROT_CANNOT_RETURN_NULL
PackFile * Parrot_pf_read_pbc_file(PARROT_INTERP,
ARGIN_NULLOK(STRING * const fullname))
__attribute__nonnull__(1);
PARROT_EXPORT
PARROT_CANNOT_RETURN_NULL
STRING * Parrot_pf_serialize(PARROT_INTERP, ARGIN(PackFile * const pf))
__attribute__nonnull__(1)
__attribute__nonnull__(2);
PARROT_EXPORT
INTVAL Parrot_pf_serialized_size(PARROT_INTERP, ARGMOD(PackFile *pf))
__attribute__nonnull__(1)
__attribute__nonnull__(2)
FUNC_MODIFIES(*pf);
PARROT_EXPORT
void Parrot_pf_set_current_packfile(PARROT_INTERP, ARGIN(PMC *pbc))
__attribute__nonnull__(1)
__attribute__nonnull__(2);
PARROT_EXPORT
PARROT_CANNOT_RETURN_NULL
PMC * Parrot_pf_single_sub_by_tag(PARROT_INTERP,
ARGIN(PMC * pfpmc),
ARGIN(STRING * flag))
__attribute__nonnull__(1)
__attribute__nonnull__(2)
__attribute__nonnull__(3);
PARROT_EXPORT
PARROT_CANNOT_RETURN_NULL
PMC * Parrot_pf_subs_by_tag(PARROT_INTERP,
ARGIN(PMC * pfpmc),
ARGIN(STRING * flag))
__attribute__nonnull__(1)
__attribute__nonnull__(2)
__attribute__nonnull__(3);
PARROT_EXPORT
void Parrot_pf_tag_constant(PARROT_INTERP,
ARGIN(PackFile_ConstTable *ct),
const int tag_idx,
const int const_idx)
__attribute__nonnull__(1)
__attribute__nonnull__(2);
PARROT_EXPORT
void Parrot_pf_write_pbc_file(PARROT_INTERP,
ARGIN(PMC *pf_pmc),
ARGIN(STRING *filename))
__attribute__nonnull__(1)
__attribute__nonnull__(2)
__attribute__nonnull__(3);
PARROT_EXPORT
PARROT_IGNORABLE_RESULT
PARROT_CANNOT_RETURN_NULL
PackFile_ByteCode * Parrot_switch_to_cs(PARROT_INTERP,
ARGIN(PackFile_ByteCode *new_cs),
int really)
__attribute__nonnull__(1)
__attribute__nonnull__(2);
PARROT_CANNOT_RETURN_NULL
PMC * PackFile_Annotations_lookup(PARROT_INTERP,
ARGIN(PackFile_Annotations *self),
opcode_t offset,
ARGIN_NULLOK(STRING *name))
__attribute__nonnull__(1)
__attribute__nonnull__(2);
PARROT_CANNOT_RETURN_NULL
PARROT_WARN_UNUSED_RESULT
PMC * Parrot_pf_all_subs(PARROT_INTERP, ARGIN(PMC *pfpmc))
__attribute__nonnull__(1)
__attribute__nonnull__(2);
PARROT_CANNOT_RETURN_NULL
PARROT_WARN_UNUSED_RESULT
PMC * Parrot_pf_all_tagged_pmcs(PARROT_INTERP, ARGIN(PMC * pfpmc))
__attribute__nonnull__(1)
__attribute__nonnull__(2);
PARROT_CANNOT_RETURN_NULL
PARROT_WARN_UNUSED_RESULT
PMC * Parrot_pf_all_tags_list(PARROT_INTERP, ARGIN(PMC * pfpmc))
__attribute__nonnull__(1)
__attribute__nonnull__(2);
PARROT_PURE_FUNCTION
PARROT_CANNOT_RETURN_NULL
PackFile_ByteCode * Parrot_pf_get_current_code_segment(PARROT_INTERP)
__attribute__nonnull__(1);
PARROT_PURE_FUNCTION
PARROT_CANNOT_RETURN_NULL
PMC * Parrot_pf_get_current_packfile(PARROT_INTERP)
__attribute__nonnull__(1);
PARROT_CANNOT_RETURN_NULL
PMC * Parrot_pf_get_packfile_main_sub(PARROT_INTERP, ARGIN(PMC * pbc))
__attribute__nonnull__(1)
__attribute__nonnull__(2);
void Parrot_pf_mark_packfile(PARROT_INTERP, ARGMOD_NULLOK(PackFile * pf))
__attribute__nonnull__(1)
FUNC_MODIFIES(* pf);
#define ASSERT_ARGS_do_sub_pragmas __attribute__unused__ int _ASSERT_ARGS_CHECK = (\
PARROT_ASSERT_ARG(interp) \
, PARROT_ASSERT_ARG(pfpmc))
#define ASSERT_ARGS_PackFile_add_segment __attribute__unused__ int _ASSERT_ARGS_CHECK = (\
PARROT_ASSERT_ARG(interp) \
, PARROT_ASSERT_ARG(dir) \
, PARROT_ASSERT_ARG(seg))
#define ASSERT_ARGS_PackFile_Annotations_add_entry \
__attribute__unused__ int _ASSERT_ARGS_CHECK = (\
PARROT_ASSERT_ARG(interp) \
, PARROT_ASSERT_ARG(self))
#define ASSERT_ARGS_PackFile_destroy __attribute__unused__ int _ASSERT_ARGS_CHECK = (\
PARROT_ASSERT_ARG(interp) \
, PARROT_ASSERT_ARG(pf))
#define ASSERT_ARGS_PackFile_find_segment __attribute__unused__ int _ASSERT_ARGS_CHECK = (\
PARROT_ASSERT_ARG(interp) \
, PARROT_ASSERT_ARG(name))
#define ASSERT_ARGS_PackFile_fixup_subs __attribute__unused__ int _ASSERT_ARGS_CHECK = (\
PARROT_ASSERT_ARG(interp))
#define ASSERT_ARGS_PackFile_map_segments __attribute__unused__ int _ASSERT_ARGS_CHECK = (\
PARROT_ASSERT_ARG(interp) \
, PARROT_ASSERT_ARG(dir))
#define ASSERT_ARGS_PackFile_new __attribute__unused__ int _ASSERT_ARGS_CHECK = (\
PARROT_ASSERT_ARG(interp))
#define ASSERT_ARGS_PackFile_unpack __attribute__unused__ int _ASSERT_ARGS_CHECK = (\
PARROT_ASSERT_ARG(interp) \
, PARROT_ASSERT_ARG(self) \
, PARROT_ASSERT_ARG(packed))
#define ASSERT_ARGS_Parrot_debug_add_mapping __attribute__unused__ int _ASSERT_ARGS_CHECK = (\
PARROT_ASSERT_ARG(interp) \
, PARROT_ASSERT_ARG(debug) \
, PARROT_ASSERT_ARG(filename))
#define ASSERT_ARGS_Parrot_debug_pc_to_filename __attribute__unused__ int _ASSERT_ARGS_CHECK = (\
PARROT_ASSERT_ARG(interp) \
, PARROT_ASSERT_ARG(debug))
#define ASSERT_ARGS_Parrot_load_bytecode __attribute__unused__ int _ASSERT_ARGS_CHECK = (\
PARROT_ASSERT_ARG(interp))
#define ASSERT_ARGS_Parrot_load_language __attribute__unused__ int _ASSERT_ARGS_CHECK = (\
PARROT_ASSERT_ARG(interp))
#define ASSERT_ARGS_Parrot_new_debug_seg __attribute__unused__ int _ASSERT_ARGS_CHECK = (\
PARROT_ASSERT_ARG(interp) \
, PARROT_ASSERT_ARG(cs))
#define ASSERT_ARGS_Parrot_pf_create_default_segments \
__attribute__unused__ int _ASSERT_ARGS_CHECK = (\
PARROT_ASSERT_ARG(interp) \
, PARROT_ASSERT_ARG(pf_pmc) \
, PARROT_ASSERT_ARG(file_name))
#define ASSERT_ARGS_Parrot_pf_deserialize __attribute__unused__ int _ASSERT_ARGS_CHECK = (\
PARROT_ASSERT_ARG(interp) \
, PARROT_ASSERT_ARG(str))
#define ASSERT_ARGS_Parrot_pf_destroy __attribute__unused__ int _ASSERT_ARGS_CHECK = (\
PARROT_ASSERT_ARG(interp) \
, PARROT_ASSERT_ARG(pf))
#define ASSERT_ARGS_Parrot_pf_execute_bytecode_program \
__attribute__unused__ int _ASSERT_ARGS_CHECK = (\
PARROT_ASSERT_ARG(interp) \
, PARROT_ASSERT_ARG(pbc) \
, PARROT_ASSERT_ARG(args))
#define ASSERT_ARGS_Parrot_pf_get_annotations_segment \
__attribute__unused__ int _ASSERT_ARGS_CHECK = (\
PARROT_ASSERT_ARG(interp) \
, PARROT_ASSERT_ARG(pf))
#define ASSERT_ARGS_Parrot_pf_get_packfile_pmc __attribute__unused__ int _ASSERT_ARGS_CHECK = (\
PARROT_ASSERT_ARG(interp) \
, PARROT_ASSERT_ARG(pf) \
, PARROT_ASSERT_ARG(path))
#define ASSERT_ARGS_Parrot_pf_get_version_string __attribute__unused__ int _ASSERT_ARGS_CHECK = (\
PARROT_ASSERT_ARG(interp) \
, PARROT_ASSERT_ARG(pbc))
#define ASSERT_ARGS_Parrot_pf_load_bytecode_search \
__attribute__unused__ int _ASSERT_ARGS_CHECK = (\
PARROT_ASSERT_ARG(interp) \
, PARROT_ASSERT_ARG(file))
#define ASSERT_ARGS_Parrot_pf_new __attribute__unused__ int _ASSERT_ARGS_CHECK = (\
PARROT_ASSERT_ARG(interp))
#define ASSERT_ARGS_Parrot_pf_prepare_packfile_init \
__attribute__unused__ int _ASSERT_ARGS_CHECK = (\
PARROT_ASSERT_ARG(interp) \
, PARROT_ASSERT_ARG(pfpmc))
#define ASSERT_ARGS_Parrot_pf_prepare_packfile_load \
__attribute__unused__ int _ASSERT_ARGS_CHECK = (\
PARROT_ASSERT_ARG(interp) \
, PARROT_ASSERT_ARG(pfpmc))
#define ASSERT_ARGS_Parrot_pf_read_pbc_file __attribute__unused__ int _ASSERT_ARGS_CHECK = (\
PARROT_ASSERT_ARG(interp))
#define ASSERT_ARGS_Parrot_pf_serialize __attribute__unused__ int _ASSERT_ARGS_CHECK = (\
PARROT_ASSERT_ARG(interp) \
, PARROT_ASSERT_ARG(pf))
#define ASSERT_ARGS_Parrot_pf_serialized_size __attribute__unused__ int _ASSERT_ARGS_CHECK = (\
PARROT_ASSERT_ARG(interp) \
, PARROT_ASSERT_ARG(pf))
#define ASSERT_ARGS_Parrot_pf_set_current_packfile \
__attribute__unused__ int _ASSERT_ARGS_CHECK = (\
PARROT_ASSERT_ARG(interp) \
, PARROT_ASSERT_ARG(pbc))
#define ASSERT_ARGS_Parrot_pf_single_sub_by_tag __attribute__unused__ int _ASSERT_ARGS_CHECK = (\
PARROT_ASSERT_ARG(interp) \
, PARROT_ASSERT_ARG(pfpmc) \
, PARROT_ASSERT_ARG(flag))
#define ASSERT_ARGS_Parrot_pf_subs_by_tag __attribute__unused__ int _ASSERT_ARGS_CHECK = (\
PARROT_ASSERT_ARG(interp) \
, PARROT_ASSERT_ARG(pfpmc) \
, PARROT_ASSERT_ARG(flag))
#define ASSERT_ARGS_Parrot_pf_tag_constant __attribute__unused__ int _ASSERT_ARGS_CHECK = (\
PARROT_ASSERT_ARG(interp) \
, PARROT_ASSERT_ARG(ct))
#define ASSERT_ARGS_Parrot_pf_write_pbc_file __attribute__unused__ int _ASSERT_ARGS_CHECK = (\
PARROT_ASSERT_ARG(interp) \
, PARROT_ASSERT_ARG(pf_pmc) \
, PARROT_ASSERT_ARG(filename))
#define ASSERT_ARGS_Parrot_switch_to_cs __attribute__unused__ int _ASSERT_ARGS_CHECK = (\
PARROT_ASSERT_ARG(interp) \
, PARROT_ASSERT_ARG(new_cs))
#define ASSERT_ARGS_PackFile_Annotations_lookup __attribute__unused__ int _ASSERT_ARGS_CHECK = (\
PARROT_ASSERT_ARG(interp) \
, PARROT_ASSERT_ARG(self))
#define ASSERT_ARGS_Parrot_pf_all_subs __attribute__unused__ int _ASSERT_ARGS_CHECK = (\
PARROT_ASSERT_ARG(interp) \
, PARROT_ASSERT_ARG(pfpmc))
#define ASSERT_ARGS_Parrot_pf_all_tagged_pmcs __attribute__unused__ int _ASSERT_ARGS_CHECK = (\
PARROT_ASSERT_ARG(interp) \
, PARROT_ASSERT_ARG(pfpmc))
#define ASSERT_ARGS_Parrot_pf_all_tags_list __attribute__unused__ int _ASSERT_ARGS_CHECK = (\
PARROT_ASSERT_ARG(interp) \
, PARROT_ASSERT_ARG(pfpmc))
#define ASSERT_ARGS_Parrot_pf_get_current_code_segment \
__attribute__unused__ int _ASSERT_ARGS_CHECK = (\
PARROT_ASSERT_ARG(interp))
#define ASSERT_ARGS_Parrot_pf_get_current_packfile \
__attribute__unused__ int _ASSERT_ARGS_CHECK = (\
PARROT_ASSERT_ARG(interp))
#define ASSERT_ARGS_Parrot_pf_get_packfile_main_sub \
__attribute__unused__ int _ASSERT_ARGS_CHECK = (\
PARROT_ASSERT_ARG(interp) \
, PARROT_ASSERT_ARG(pbc))
#define ASSERT_ARGS_Parrot_pf_mark_packfile __attribute__unused__ int _ASSERT_ARGS_CHECK = (\
PARROT_ASSERT_ARG(interp))
/* Don't modify between HEADERIZER BEGIN / HEADERIZER END. Your changes will be lost. */
/* HEADERIZER END: src/packfile/api.c */
/* HEADERIZER BEGIN: src/packfile/output.c */
/* Don't modify between HEADERIZER BEGIN / HEADERIZER END. Your changes will be lost. */
PARROT_EXPORT
PARROT_WARN_UNUSED_RESULT
PARROT_CANNOT_RETURN_NULL
opcode_t * PackFile_ConstTable_pack(PARROT_INTERP,
ARGMOD(PackFile_Segment *seg),
ARGOUT(opcode_t *cursor))
__attribute__nonnull__(1)
__attribute__nonnull__(2)
__attribute__nonnull__(3)
FUNC_MODIFIES(*seg)
FUNC_MODIFIES(*cursor);
PARROT_EXPORT
size_t PackFile_ConstTable_pack_size(PARROT_INTERP,
ARGMOD(PackFile_Segment *seg))
__attribute__nonnull__(1)
__attribute__nonnull__(2)
FUNC_MODIFIES(*seg);
PARROT_EXPORT
int PackFile_ConstTable_rlookup_num(PARROT_INTERP,
ARGIN(const PackFile_ConstTable *ct),
FLOATVAL n)
__attribute__nonnull__(2);
PARROT_EXPORT
int PackFile_ConstTable_rlookup_pmc(PARROT_INTERP,
ARGIN(PackFile_ConstTable *ct),
ARGIN(PMC *v),
ARGOUT(INTVAL *constno),
ARGOUT(INTVAL *idx))
__attribute__nonnull__(1)
__attribute__nonnull__(2)
__attribute__nonnull__(3)
__attribute__nonnull__(4)
__attribute__nonnull__(5)
FUNC_MODIFIES(*constno)
FUNC_MODIFIES(*idx);
PARROT_EXPORT
int PackFile_ConstTable_rlookup_str(PARROT_INTERP,
ARGIN(const PackFile_ConstTable *ct),
ARGIN(STRING *s))
__attribute__nonnull__(1)
__attribute__nonnull__(2)
__attribute__nonnull__(3);
PARROT_EXPORT
void PackFile_pack(PARROT_INTERP,
ARGMOD(PackFile *self),
ARGOUT(opcode_t *cursor))
__attribute__nonnull__(1)
__attribute__nonnull__(2)
__attribute__nonnull__(3)