/
structview.pmc
1212 lines (1000 loc) · 38.2 KB
/
structview.pmc
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.
=head1 NAME
src/pmc/structview.pmc - View pointers as C structs
=head1 DESCRIPTION
PMC class to view pointers as C C<struct>s. This includes read, write, allocate,
and deallocate operations. Bounds checking is implemented where the pointer
class reports a non-zero bound. Recursive definition through nesting is not
supported but can be emulated by interpreting pointer or buffer elements as
structs once dereferenced.
Elements are get/set using keyed access of the form C<[Ptr; Idx]>, which will
interpret the C<Ptr> PMC and lookup the C<Idx>'th element.
=head2 Vtables and Methods
=over 4
=cut
*/
#include "pmc/pmc_ptrobj.h"
BEGIN_PMC_HEADER_PREAMBLE
typedef enum {
int_access = 1,
unaligned_access,
num_access,
str_access,
pmc_access
} elt_access_t;
typedef struct elt_desc_t {
elt_access_t access;
PARROT_DATA_TYPE type;
size_t byte_offset;
unsigned char bit_offset;
size_t size;
} elt_desc_t;
END_PMC_HEADER_PREAMBLE
/* HEADERIZER HFILE: none */
/* HEADERIZER BEGIN: static */
/* Don't modify between HEADERIZER BEGIN / HEADERIZER END. Your changes will be lost. */
PARROT_DOES_NOT_RETURN
static void buffer_too_small(PARROT_INTERP,
size_t self_size,
size_t buf_size)
__attribute__nonnull__(1);
static void deallocate_ptrobj(PARROT_INTERP, PMC *obj, ARGFREE(void *ptr));
PARROT_DOES_NOT_RETURN
static void dereference_null(PARROT_INTERP)
__attribute__nonnull__(1);
PARROT_DOES_NOT_RETURN
static void dereference_unaligned(PARROT_INTERP,
ARGIN(const void *base_ptr),
size_t align)
__attribute__nonnull__(1)
__attribute__nonnull__(2);
PARROT_DOES_NOT_RETURN
static void index_out_of_bounds(PARROT_INTERP, INTVAL i)
__attribute__nonnull__(1);
#define ASSERT_ARGS_buffer_too_small __attribute__unused__ int _ASSERT_ARGS_CHECK = (\
PARROT_ASSERT_ARG(interp))
#define ASSERT_ARGS_deallocate_ptrobj __attribute__unused__ int _ASSERT_ARGS_CHECK = (0)
#define ASSERT_ARGS_dereference_null __attribute__unused__ int _ASSERT_ARGS_CHECK = (\
PARROT_ASSERT_ARG(interp))
#define ASSERT_ARGS_dereference_unaligned __attribute__unused__ int _ASSERT_ARGS_CHECK = (\
PARROT_ASSERT_ARG(interp) \
, PARROT_ASSERT_ARG(base_ptr))
#define ASSERT_ARGS_index_out_of_bounds __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: static */
#define ALIGN_UP(addr, align) (((addr) + ((align) - 1)) & ~((align) - 1))
#define MAX(x, y) ((y) > (x) ? (y) : (x))
#define BEGIN_KEYED(interp, s, k) \
size_t n_elts; \
elt_desc_t *elts; \
PMC *ptr_pmc; \
void *ptr, *base_ptr; \
INTVAL i; \
PMC *orig_k = (k); \
GETATTR_StructView_n_elts((interp), (s), n_elts); \
GETATTR_StructView_elts((interp), (s), elts); \
ptr_pmc = Parrot_key_pmc((interp), (k)); \
(k) = Parrot_key_next((interp), (k)); \
i = Parrot_key_integer((interp), (k)); \
(k) = orig_k; \
if (i < 0 || n_elts <= (size_t)i) \
index_out_of_bounds((interp), i); \
base_ptr = VTABLE_get_pointer((interp), ptr_pmc); \
ptr = ((char *)base_ptr) + elts[i].byte_offset; \
/* guard against null pointer dereference */ \
if (!base_ptr) \
dereference_null((interp)); \
/* guard against out of bounds access */ \
{ \
size_t buf_size = VTABLE_get_integer((interp), ptr_pmc); \
size_t self_size; \
GETATTR_StructView_size((interp), (s), self_size); \
if (buf_size && buf_size < self_size) \
buffer_too_small((interp), self_size, buf_size); \
} \
/* guard against unaligned access */ \
{ \
size_t align; \
GETATTR_StructView_align((interp), (s), align); \
if ((size_t)base_ptr != ALIGN_UP((size_t)base_ptr, align)) \
dereference_unaligned((interp), base_ptr, align); \
}
pmclass StructView auto_attrs {
ATTR PARROT_DATA_TYPE pack_type;
ATTR size_t n_elts;
ATTR elt_desc_t *elts;
ATTR size_t align;
ATTR size_t size;
/*
=item C<void init()>
Creating an instance without an initializer is dissallowed and will throw an
exception.
=cut
*/
VTABLE void init() {
Parrot_ex_throw_from_c_args(INTERP, NULL, 0,
"Meaningless creation of %Ss without initializer",
SELF->vtable->whoami);
}
/*
=item C<void init_pmc(PMC *p)>
Create a new StructView for viewing buffers as described by the initializer.
An initializer is an array-aggregate of integers. For example,
C<FixedIntegerArray> will work for this purpose.
The first element of the initializer is interpreted as the type of the
C<StructView>. There are three supported types of view: struct, indicated with
the C<DATATYPE_STRUCT> flag; union, indicated with the C<DATATYPE_UNION> flag;
and custom, indicated with the C<DATATYPE_SIZED> flag.
The second element of the initializer is interpreted as the number of elements
contained within the view.
If using a custom view, the third and fourth elements are interpreted as the
size and alignment in bytes respectively.
The remainder of the initializer is interpreted as a description of the
elements of the view. For struct and union views, elements are described
by a single integer flag from C<datatypes.pasm>, with layout being determined
automatically identical to what your C compiler would have done. For custom
views, elements are represented by a 3-tuple of
C<{type, byte-offset, bit-offset}>, which can be used for arbitrary layouts.
Note, however, that unaligned access is only supported on unsigned integers,
and even then, it is inefficient. You have been warned.
Supported element types are include:
=over 4
=item Parrot Types
C<INTVAL>, C<FLOATVAL>, C<STRING>, and C<PMC>
=item C-Native Types
Integer: C<char>, C<uchar>, C<short>, C<ushort>, C<int>, C<uint>, C<long>,
C<ulong>, C<longlong> (*), and C<ulonglong> (*)
Float: C<float>, C<double>, C<longdouble>
PMC: data pointer (C<ptr>), function pointer (C<func_ptr>), buffer (C<sized>) (**)
(*) Only available if your C system sports a C<long long> type.
(**) Requires 2 additional following parameters - buffer size and alignment.
=item Explicitly Sized Types
C<uint1> (also known as C<bit>), C<uint4>, C<int8>, C<uint8>, C<int16>,
C<uint16>, C<int32>, C<uint32>, C<int64>(*), and C<uint64>(*)
(*) Only available if your C system sports a 64 bit integer type.
=back
=cut
*/
VTABLE void init_pmc(PMC *p) {
const INTVAL init_len = VTABLE_elements(INTERP, p);
const PARROT_DATA_TYPE pack_type = (PARROT_DATA_TYPE)
VTABLE_get_integer_keyed_int(INTERP, p, 0);
const INTVAL n_elts = VTABLE_get_integer_keyed_int(INTERP, p, 1);
elt_desc_t *elt_ary;
size_t bit_cursor = 0;
size_t byte_cursor = 0;
size_t size, align;
int incr, i, j;
switch (pack_type) {
case enum_type_struct:
case enum_type_union:
size = 0;
align = 1; /* sorry, no sub-byte alignment */
incr = 1;
i = 2;
break;
case enum_type_sized:
size = VTABLE_get_integer_keyed_int(INTERP, p, 2);
align = VTABLE_get_integer_keyed_int(INTERP, p, 3);
incr = 3;
i = 4;
break;
default:
Parrot_ex_throw_from_c_args(INTERP, NULL, 0,
"Unknown struct type `%Ss'",
Parrot_dt_get_datatype_name(INTERP, pack_type));
}
if (init_len < n_elts + i)
Parrot_ex_throw_from_c_args(INTERP, NULL, 0,
"Initializer too short (%d) for struct type `%Ss' with %d elements",
init_len,
Parrot_dt_get_datatype_name(INTERP, pack_type),
n_elts);
elt_ary = mem_gc_allocate_n_zeroed_typed(INTERP, n_elts, elt_desc_t);
PObj_custom_destroy_SET(SELF);
SET_ATTR_pack_type(INTERP, SELF, pack_type);
SET_ATTR_elts(INTERP, SELF, elt_ary);
SET_ATTR_n_elts(INTERP, SELF, n_elts);
for (/* i already initialized */ j = 0; i < init_len && j < n_elts; i += incr, j++) {
elt_desc_t * const elt = &elt_ary[j];
const PARROT_DATA_TYPE elt_type = (PARROT_DATA_TYPE)
VTABLE_get_integer_keyed_int(INTERP, p, i);
size_t elt_size, elt_align;
elt_access_t elt_access;
if ((elt_type & ~enum_type_ref_flag) < enum_first_type
|| (elt_type & ~enum_type_ref_flag) >= enum_last_type)
Parrot_ex_throw_from_c_args(INTERP, NULL, 0,
"Invalid type flag for struct element (%d)", elt_type);
elt->type = elt_type;
elt_size = data_types[elt_type - enum_first_type].size;
elt_align = data_types[elt_type - enum_first_type].align;
switch (elt_type) {
/* aligned integer types */
case enum_type_INTVAL:
case enum_type_char:
case enum_type_short:
case enum_type_int:
case enum_type_long:
#if PARROT_HAS_LONGLONG
case enum_type_longlong:
#endif
case enum_type_int8:
case enum_type_int16:
case enum_type_int32:
#if PARROT_HAS_INT64
case enum_type_int64:
#endif
case enum_type_uchar:
case enum_type_ushort:
case enum_type_uint:
case enum_type_ulong:
#if PARROT_HAS_LONGLONG
case enum_type_ulonglong:
#endif
case enum_type_uint8:
case enum_type_uint16:
case enum_type_uint32:
#if PARROT_HAS_INT64
case enum_type_uint64:
#endif
elt_access = int_access;
break;
/* unaligned integer types */
case enum_type_uint1:
case enum_type_uint4:
elt_access = unaligned_access;
break;
/* float types */
case enum_type_FLOATVAL:
case enum_type_float:
case enum_type_double:
case enum_type_longdouble:
elt_access = num_access;
break;
/* other types */
case enum_type_STRING:
elt_access = str_access;
break;
case enum_type_sized:
/* arbitrary buffers extended with size and align fields */
elt->size = elt_size = VTABLE_get_integer_keyed_int(INTERP, p, ++i);
elt_align = VTABLE_get_integer_keyed_int(INTERP, p, ++i);
/* fallthrough */
case enum_type_PMC:
case enum_type_ptr:
case enum_type_func_ptr:
elt_access = pmc_access;
break;
/* locally unsupported types */
#if !PARROT_HAS_LONGLONG
case enum_type_longlong:
case enum_type_ulonglong:
#endif
#if !PARROT_HAS_INT64
case enum_type_int64:
case enum_type_uint64:
#endif
Parrot_ex_throw_from_c_args(INTERP, NULL, 0,
"Unsupported struct element type `%Ss' (index %d)",
Parrot_dt_get_datatype_name(INTERP, elt_type),
j);
default:
Parrot_ex_throw_from_c_args(INTERP, NULL, 0,
"Unknown struct element type `%Ss' (index %i)",
Parrot_dt_get_datatype_name(INTERP, elt_type),
j);
}
switch (pack_type) {
case enum_type_struct:
elt->access = elt_access;
align = MAX(align, elt_align);
switch (elt_access) {
case int_access:
case num_access:
case pmc_access:
if (bit_cursor) {
byte_cursor += 1;
bit_cursor = 0;
}
elt->byte_offset = ALIGN_UP(byte_cursor, elt_align);
byte_cursor = elt->byte_offset + elt_size;
break;
case unaligned_access:
elt->byte_offset = byte_cursor;
elt->bit_offset = bit_cursor;
byte_cursor = (bit_cursor + 1) / 8;
bit_cursor = (bit_cursor + 1) % 8;
break;
default:
break;
}
break;
case enum_type_union:
elt->access = elt_access;
size = MAX(size, elt_size);
align = MAX(align, elt_align);
/* all union elements are at 0 offset */
break;
case enum_type_sized:
elt->byte_offset = VTABLE_get_integer_keyed_int(INTERP, p, i + 1);
elt->bit_offset = VTABLE_get_integer_keyed_int(INTERP, p, i + 2);
switch (elt_access) {
case num_access:
case str_access:
case pmc_access:
if (align < elt_align
|| elt->bit_offset
|| elt->byte_offset % elt_align)
Parrot_ex_throw_from_c_args(INTERP, NULL, 0,
"Unaligned access unsupported on type `%Ss' (index: %i)",
Parrot_dt_get_datatype_name(INTERP, elt_type),
j);
elt->access = elt_access;
break;
case int_access:
if (align < elt_align
|| elt->bit_offset
|| elt->byte_offset % elt_align) {
switch (elt_type) {
case enum_type_uchar:
case enum_type_ushort:
case enum_type_uint:
case enum_type_ulong:
#if PARROT_HAS_LONGLONG
case enum_type_ulonglong:
#endif
case enum_type_uint8:
case enum_type_uint16:
case enum_type_uint32:
#if PARROT_HAS_INT64
case enum_type_uint64:
#endif
elt->access = unaligned_access;
break;
default:
Parrot_ex_throw_from_c_args(INTERP, NULL, 0,
"Unaligned access unsupported on type `%Ss' (index: %i)",
Parrot_dt_get_datatype_name(INTERP, elt_type),
j);
}
}
else {
elt->access = int_access;
}
break;
case unaligned_access:
elt->access = unaligned_access;
break;
default:
break;
}
default:
break;
}
}
if (pack_type == enum_type_struct) {
size = byte_cursor + !!bit_cursor;
}
SET_ATTR_align(INTERP, SELF, align);
SET_ATTR_size(INTERP, SELF, size);
}
/*
=item C<void destroy()>
Free internal offsets array.
=cut
*/
VTABLE void destroy() {
elt_desc_t *elts;
GET_ATTR_elts(INTERP, SELF, elts);
mem_gc_free(INTERP, elts);
}
/*
=item C<INTVAL get_integer_keyed(PMC *k)>
=item C<void set_integer_keyed(PMC *k, INTVAL x)>
Get/Set an integer-type element from a struct-pointer PMC.
=cut
*/
VTABLE INTVAL get_integer_keyed(PMC *k) {
BEGIN_KEYED(INTERP, SELF, k)
switch (elts[i].access) {
case int_access:
switch (elts[i].type) {
#define CASE_RET2(type, name) \
case enum_type_ ## name: return *(type *)ptr;
#define CASE_RET1(type) \
CASE_RET2(type, type) \
CASE_RET2(unsigned type, u ## type)
CASE_RET2(INTVAL, INTVAL)
CASE_RET1(char);
CASE_RET1(short);
CASE_RET1(int);
CASE_RET1(long);
#if PARROT_HAS_LONGLONG
CASE_RET2(long long, longlong);
CASE_RET2(unsigned long long, ulonglong);
#endif
CASE_RET2(Parrot_Int1, int8);
CASE_RET2(Parrot_UInt1, uint8);
CASE_RET2(Parrot_Int2, int16);
CASE_RET2(Parrot_UInt2, uint16);
CASE_RET2(Parrot_Int4, int32);
CASE_RET2(Parrot_UInt4, uint32);
#if PARROT_HAS_INT64
CASE_RET2(Parrot_Int8, int64);
CASE_RET2(Parrot_UInt8, uint64);
#endif
#undef CASE_RET1
#undef CASE_RET2
default:
break;
}
/* should not get here - inserted to avoid compiler warnings */
return 0;
case unaligned_access:
{
INTVAL acc = 0;
size_t bits, n;
unsigned char *cptr = (unsigned char *)ptr;
switch (elts[i].type) {
case enum_type_uint1:
bits = 1;
break;
case enum_type_uint4:
bits = 4;
break;
default:
bits = 8 * data_types[elts[i].type - enum_first_type].size;
break;
}
/* fetch hi bits of first byte */
acc = *cptr++ >> elts[i].bit_offset;
n = 8 - elts[i].bit_offset;
/* read whole bytes until complete */
while (n < bits) {
acc |= ((UINTVAL)*cptr++) << n;
n += 8;
}
/* mask off hi bits of last byte */
acc &= (~(UINTVAL)0) >> (sizeof (UINTVAL) * 8 - bits);
return acc;
}
/* should not get here - inserted to avoid compiler warnings */
return 0;
default:
Parrot_ex_throw_from_c_args(INTERP, NULL, 0,
"Not a valid integer type (`%Ss')",
Parrot_dt_get_datatype_name(INTERP, elts[i].type));
}
}
VTABLE void set_integer_keyed(PMC *k, INTVAL x) {
BEGIN_KEYED(INTERP, SELF, k)
switch (elts[i].access) {
case int_access:
switch (elts[i].type) {
#define CASE_SET2(type, name) \
case enum_type_ ## name: *(type *)ptr = x; return;
#define CASE_SET1(type) \
CASE_SET2(type, type) \
CASE_SET2(unsigned type, u ## type)
CASE_SET2(INTVAL, INTVAL)
CASE_SET1(char);
CASE_SET1(short);
CASE_SET1(int);
CASE_SET1(long);
#if PARROT_HAS_LONGLONG
CASE_SET2(long long, longlong);
CASE_SET2(unsigned long long, ulonglong);
#endif
CASE_SET2(Parrot_Int1, int8);
CASE_SET2(Parrot_UInt1, uint8);
CASE_SET2(Parrot_Int2, int16);
CASE_SET2(Parrot_UInt2, uint16);
CASE_SET2(Parrot_Int4, int32);
CASE_SET2(Parrot_UInt4, uint32);
#if PARROT_HAS_INT64
CASE_SET2(Parrot_Int8, int64);
CASE_SET2(Parrot_UInt8, uint64);
#endif
#undef CASE_SET1
#undef CASE_SET2
default:
break;
}
break;
case unaligned_access:
{
UINTVAL ux = x;
size_t bits, n;
unsigned char tempc = 0;
unsigned char *cptr = (unsigned char *)ptr;
switch (elts[i].type) {
case enum_type_uint1:
bits = 1;
break;
case enum_type_uint4:
bits = 4;
break;
default:
bits = 8 * data_types[elts[i].type - enum_first_type].size;
break;
}
/* cache last byte (for restoring hi bits) */
if (bits > 1) {
tempc = cptr[(bits + elts[i].bit_offset - 1)/8];
}
/* write hi bits of first byte */
n = 8 - elts[i].bit_offset;
*cptr &= (1 << elts[i].bit_offset) - 1;
*cptr++ |= (ux & ((1 << n) - 1)) << elts[i].bit_offset;
/* write whole bytes until complete */
while (n < bits) {
*cptr++ = ux >> n;
n += 8;
}
/* restore hi bits of last byte */
cptr--;
n = 8 - (n - bits); /* how many bits of last byte we should have written */
*cptr &= (1 << n) - 1;
*cptr |= tempc & ~((1 << n) - 1);
}
break;
default:
Parrot_ex_throw_from_c_args(INTERP, NULL, 0,
"Not a valid integer type (`%Ss')",
Parrot_dt_get_datatype_name(INTERP, elts[i].type));
}
}
/*
=item C<FLOATVAL get_number_keyed(PMC *k)>
=item C<void set_number_keyed(PMC *k, FLOATVAL n)>
Get/Set a float-like element from a struct-pointer PMC.
=cut
*/
VTABLE FLOATVAL get_number_keyed(PMC *k) {
BEGIN_KEYED(INTERP, SELF, k)
switch (elts[i].access) {
case num_access:
switch (elts[i].type) {
case enum_type_FLOATVAL:
return *(FLOATVAL *)ptr;
case enum_type_float:
return *(float *)ptr;
case enum_type_double:
return *(double *)ptr;
case enum_type_longdouble:
return *(long double *)ptr;
default:
break;
}
default:
Parrot_ex_throw_from_c_args(INTERP, NULL, 0,
"Not a valid number type (`%Ss')",
Parrot_dt_get_datatype_name(INTERP, elts[i].type));
}
}
VTABLE void set_number_keyed(PMC *k, FLOATVAL n) {
BEGIN_KEYED(INTERP, SELF, k)
switch (elts[i].access) {
case num_access:
switch (elts[i].type) {
case enum_type_FLOATVAL:
*(FLOATVAL *)ptr = n;
return;
case enum_type_float:
*(float *)ptr = n;
return;
case enum_type_double:
*(double *)ptr = n;
return;
case enum_type_longdouble:
*(long double *)ptr = n;
return;
default:
break;
}
default:
Parrot_ex_throw_from_c_args(INTERP, NULL, 0,
"Not a valid number type (`%Ss')",
Parrot_dt_get_datatype_name(INTERP, elts[i].type));
}
}
/*
=item C<STRING *get_string keyed(PMC *k)>
=item C<void set_string_keyed(PMC *k, STRING *)>
Get/Set a string element from a struct-pointer PMC.
=cut
*/
VTABLE STRING *get_string_keyed(PMC *k) {
BEGIN_KEYED(INTERP, SELF, k)
switch (elts[i].access) {
case str_access:
switch (elts[i].type) {
case enum_type_STRING:
return *(STRING **)ptr;
default:
break;
}
default:
Parrot_ex_throw_from_c_args(INTERP, NULL, 0,
"Not a valid string type (`%Ss')",
Parrot_dt_get_datatype_name(INTERP, elts[i].type));
}
}
VTABLE void set_string_keyed(PMC *k, STRING *s) {
BEGIN_KEYED(INTERP, SELF, k)
switch (elts[i].access) {
case str_access:
switch (elts[i].type) {
case enum_type_STRING:
*(STRING **)ptr = s;
return;
default:
break;
}
default:
Parrot_ex_throw_from_c_args(INTERP, NULL, 0,
"Not a valid string type (`%Ss')",
Parrot_dt_get_datatype_name(INTERP, elts[i].type));
}
}
/*
=item C<PMC *get_pmc_keyed(PMC *k)>
=item C<void set_pmc_keyed(PMC *k, PMC *p)>
Get/Set a PMC-like element from a struct-pointer PMC or box/unbox values from
any other type of element.
=cut
*/
VTABLE PMC *get_pmc_keyed(PMC *k) {
BEGIN_KEYED(INTERP, SELF, k)
switch (elts[i].access) {
case int_access:
case unaligned_access:
return Parrot_pmc_box_integer(INTERP, SELF.get_integer_keyed(k));
case num_access:
return Parrot_pmc_box_number(INTERP, SELF.get_number_keyed(k));
case str_access:
return Parrot_pmc_box_string(INTERP, SELF.get_string_keyed(k));
case pmc_access:
{
PMC *ret;
switch (elts[i].type) {
case enum_type_PMC:
return *(PMC **)ptr;
case enum_type_func_ptr:
case enum_type_ptr:
return Parrot_pmc_new_init_int(INTERP, enum_class_Ptr,
(INTVAL)*(void **)ptr);
case enum_type_sized:
ret = Parrot_pmc_new_init_int(INTERP, enum_class_PtrBuf,
(INTVAL)*(void **)ptr);
VTABLE_set_integer_native(INTERP, ret, elts[i].size);
return ret;
default:
/* should never get here - put in to quiet compiler warnings */
return NULL;
}
}
default:
/* should never get here - put in to quiet compiler warnings */
return NULL;
}
}
VTABLE void set_pmc_keyed(PMC *k, PMC *p) {
BEGIN_KEYED(INTERP, SELF, k)
switch (elts[i].access) {
case int_access:
case unaligned_access:
SELF.set_integer_keyed(k, VTABLE_get_integer(INTERP, p));
break;
case num_access:
SELF.set_number_keyed(k, VTABLE_get_number(INTERP, p));
break;
case str_access:
SELF.set_string_keyed(k, VTABLE_get_string(INTERP, p));
break;
case pmc_access:
{
switch (elts[i].type) {
case enum_type_PMC:
*(PMC **)ptr = p;
break;
case enum_type_func_ptr:
case enum_type_ptr:
*(void **)ptr = VTABLE_get_pointer(INTERP, p);
break;
case enum_type_sized:
if (VTABLE_does(INTERP, p, CONST_STRING(INTERP, "buffer"))) {
void * const q = VTABLE_get_pointer(INTERP, p);
size_t len = VTABLE_get_integer(INTERP, p);
if (len == 0 || len > elts[i].size)
len = elts[i].size;
memcpy(ptr, q, len);
break;
}
else {
Parrot_ex_throw_from_c_args(INTERP, NULL, 0,
"Type `%Ss' unsuitable for buffer assignment",
p->vtable->whoami);
}
default:
break;
}
}
default:
break;
}
}
/*
=item C<INTVAL get_integer()>
=item C<METHOD size()>
Get the size (in bytes) required for one instance.
=cut
*/
VTABLE INTVAL get_integer() {
size_t size;
GET_ATTR_size(INTERP, SELF, size);
return size;
}
METHOD size() {
size_t size;
GET_ATTR_size(INTERP, SELF, size);
RETURN(INTVAL size);
}
/*
=item C<METHOD align()>
Get the alignment (in bytes) required for an instance.
=cut
*/
METHOD align() {
size_t align;
GET_ATTR_align(INTERP, SELF, align);
RETURN(INTVAL align);
}
/*
=item C<METHOD aligned_size()>
Get the size of one instance plus the pad bytes to align a subsequent
instance.
=cut
*/
METHOD aligned_size() {
size_t size, align;
INTVAL ret;
GET_ATTR_size(INTERP, SELF, size);
GET_ATTR_align(INTERP, SELF, align);
ret = ALIGN_UP(size, align);
RETURN(INTVAL ret);
}
/*
=item C<METHOD alloc(INTVAL n :optional)>
Allocate an instance, or an array of instances when C<n> has been provided.
=cut
*/
METHOD alloc(INTVAL n :optional, int has_n :opt_flag) {
size_t size, align;
PMC *ret;
void *buf;
GET_ATTR_size(INTERP, SELF, size);
if (has_n) {
GET_ATTR_align(INTERP, SELF, align);
size = ALIGN_UP(size, align) * n;
}
buf = mem_sys_allocate_zeroed(size);
ret = Parrot_pmc_new_init_int(INTERP, enum_class_PtrObj, (INTVAL)buf);
SETATTR_PtrObj_destroy(INTERP, ret, deallocate_ptrobj);
RETURN(PMC ret);
}
/*
=item C<METHOD array_offs(PMC *array, INTVAL n)>
Return a C<Ptr> to the C<n>th element of an array of structs.
=cut
*/
METHOD array_offs(PMC *array, INTVAL n) {
void * const p = VTABLE_get_pointer(INTERP, array);
const INTVAL array_size = VTABLE_get_integer(INTERP, array);
PMC *ret;
size_t size, align;
GET_ATTR_size(INTERP, SELF, size);
GET_ATTR_align(INTERP, SELF, align);
/* sanity checks */
if (!p)
dereference_null(INTERP);
if (array_size && array_size < (int)size * n)
Parrot_ex_throw_from_c_args(INTERP, NULL, 0,
"Buffer length too small for struct array "
"(at least %d required, got %d)",
size * n, array_size);
if ((size_t)p != ALIGN_UP((size_t)p, align))
dereference_unaligned(INTERP, p, align);
size = ALIGN_UP(size, align);
ret = Parrot_pmc_new_init_int(INTERP, enum_class_Ptr, (INTVAL)((char *)p + size * n));
RETURN(PMC ret);
}
/*
=item C<METHOD elt_offs(PMC *array, INTVAL n)>
Return a C<Ptr> to the C<n>th element of a struct.
=cut
*/
METHOD elt_offs(PMC *array, INTVAL n) {
void *p = VTABLE_get_pointer(INTERP, array);
PMC *ret;
size_t n_elts;
elt_desc_t *elts;
GET_ATTR_n_elts(INTERP, SELF, n_elts);
GET_ATTR_elts(INTERP, SELF, elts);
/* sanity checks */
if (n < 0 || n_elts <= (size_t)n)
index_out_of_bounds(INTERP, n);
if (!p)
dereference_null(INTERP);
{
const size_t buf_size = VTABLE_get_integer(INTERP, array);
size_t self_size;
GET_ATTR_size(INTERP, SELF, self_size);
if (buf_size && buf_size < self_size)
Parrot_ex_throw_from_c_args(INTERP, NULL, 0,
"Buffer length too small for struct "
"(at least %d required, got %d)",