/
pmc.c
1146 lines (822 loc) · 27.9 KB
/
pmc.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.
=head1 NAME
src/pmc.c
=head1 DESCRIPTION
The base vtable calling functions
=head1 FUNCTIONS
=over 4
=cut
*/
#include "parrot/parrot.h"
#include "pmc.str"
#include "pmc/pmc_class.h"
#include "pmc/pmc_callcontext.h"
/* HEADERIZER HFILE: include/parrot/pmc.h */
/* HEADERIZER BEGIN: static */
/* Don't modify between HEADERIZER BEGIN / HEADERIZER END. Your changes will be lost. */
static void check_pmc_reuse_flags(PARROT_INTERP,
UINTVAL srcflags,
UINTVAL destflags)
__attribute__nonnull__(1);
PARROT_WARN_UNUSED_RESULT
PARROT_CANNOT_RETURN_NULL
static PMC * create_class_pmc(PARROT_INTERP, INTVAL type)
__attribute__nonnull__(1);
PARROT_WARN_UNUSED_RESULT
PARROT_CANNOT_RETURN_NULL
static PMC * get_new_pmc_header(PARROT_INTERP,
INTVAL base_type,
UINTVAL flags)
__attribute__nonnull__(1);
PARROT_CANNOT_RETURN_NULL
static PMC* Parrot_pmc_reuse_noinit(PARROT_INTERP,
ARGIN(PMC *pmc),
INTVAL new_type)
__attribute__nonnull__(1)
__attribute__nonnull__(2);
#define ASSERT_ARGS_check_pmc_reuse_flags __attribute__unused__ int _ASSERT_ARGS_CHECK = (\
PARROT_ASSERT_ARG(interp))
#define ASSERT_ARGS_create_class_pmc __attribute__unused__ int _ASSERT_ARGS_CHECK = (\
PARROT_ASSERT_ARG(interp))
#define ASSERT_ARGS_get_new_pmc_header __attribute__unused__ int _ASSERT_ARGS_CHECK = (\
PARROT_ASSERT_ARG(interp))
#define ASSERT_ARGS_Parrot_pmc_reuse_noinit __attribute__unused__ int _ASSERT_ARGS_CHECK = (\
PARROT_ASSERT_ARG(interp) \
, PARROT_ASSERT_ARG(pmc))
/* Don't modify between HEADERIZER BEGIN / HEADERIZER END. Your changes will be lost. */
/* HEADERIZER END: static */
PMC * PMCNULL;
/*
=item C<INTVAL Parrot_pmc_is_null(PARROT_INTERP, const PMC *pmc)>
Tests if the given pmc is null.
=cut
*/
PARROT_EXPORT
PARROT_PURE_FUNCTION
PARROT_WARN_UNUSED_RESULT
PARROT_HOT
INTVAL
Parrot_pmc_is_null(SHIM_INTERP, ARGIN_NULLOK(const PMC *pmc))
{
ASSERT_ARGS(Parrot_pmc_is_null)
return (pmc == PMCNULL) || (pmc == NULL);
}
/*
=item C<void Parrot_pmc_destroy(PARROT_INTERP, PMC *pmc)>
Destroy a PMC. Call his destroy vtable function if needed, and deallocate
his attributes if they are automatically allocated.
For internal usage of the PMC handling functions and garbage collection
subsystem.
=cut
*/
PARROT_EXPORT
void
Parrot_pmc_destroy(PARROT_INTERP, ARGMOD(PMC *pmc))
{
ASSERT_ARGS(Parrot_pmc_destroy)
if (PObj_custom_destroy_TEST(pmc))
VTABLE_destroy(interp, pmc);
PObj_gc_CLEAR(pmc);
if (pmc->vtable->attr_size && PMC_data(pmc))
Parrot_gc_free_pmc_attributes(interp, pmc);
else
PMC_data(pmc) = NULL;
#ifndef NDEBUG
pmc->data = (DPOINTER *)0xdeadbeef;
#endif
}
/*
=item C<PMC * Parrot_pmc_new(PARROT_INTERP, INTVAL base_type)>
Creates a new PMC of type C<base_type> (which is an index into the list of PMC
types declared in C<vtables> in F<include/parrot/pmc.h>). Once the PMC has been
successfully created and its vtable pointer initialized, we call its C<init>
method to perform any other necessary initialization.
=cut
*/
PARROT_EXPORT
PARROT_CANNOT_RETURN_NULL
PARROT_WARN_UNUSED_RESULT
PMC *
Parrot_pmc_new(PARROT_INTERP, INTVAL base_type)
{
ASSERT_ARGS(Parrot_pmc_new)
PARROT_ASSERT(interp->n_vtable_max > base_type);
PARROT_ASSERT(interp->vtables[base_type]);
{
PMC *const classobj = interp->vtables[base_type]->pmc_class;
if (!PMC_IS_NULL(classobj) && PObj_is_class_TEST(classobj))
return VTABLE_instantiate(interp, classobj, PMCNULL);
else {
PMC * const pmc = get_new_pmc_header(interp, base_type, 0);
VTABLE_init(interp, pmc);
return pmc;
}
}
}
/*
=item C<PMC * Parrot_pmc_reuse(PARROT_INTERP, PMC *pmc, INTVAL new_type, UINTVAL
flags)>
Reuse an existing PMC, turning it into an empty PMC of the new type. Any
required internal structure will be put in place (such as the extension area)
and the PMC will be ready to go.
Cannot currently handle converting a non-Object PMC into an Object. Use
C<pmc_reuse_by_class> for that.
=cut
*/
PARROT_EXPORT
PARROT_CANNOT_RETURN_NULL
PARROT_IGNORABLE_RESULT
PMC *
Parrot_pmc_reuse(PARROT_INTERP, ARGIN(PMC *pmc), INTVAL new_type, SHIM(UINTVAL flags))
{
ASSERT_ARGS(Parrot_pmc_reuse)
pmc = Parrot_pmc_reuse_noinit(interp, pmc, new_type);
/* Call the base init for the redone pmc. Warning, this should not
be called on Object PMCs. */
VTABLE_init(interp, pmc);
return pmc;
}
/*
=item C<PMC * Parrot_pmc_reuse_init(PARROT_INTERP, PMC *pmc, INTVAL new_type,
PMC *init, UINTVAL flags)>
Reuse an existing PMC, turning it into an PMC of the new type. Any
required internal structure will be put in place (such as the extension area)
and the PMC will be inited.
Cannot currently handle converting a non-Object PMC into an Object. Use
C<pmc_reuse_by_class> for that.
=cut
*/
PARROT_EXPORT
PARROT_CANNOT_RETURN_NULL
PARROT_IGNORABLE_RESULT
PMC *
Parrot_pmc_reuse_init(PARROT_INTERP, ARGIN(PMC *pmc), INTVAL new_type, ARGIN(PMC *init),
SHIM(UINTVAL flags))
{
ASSERT_ARGS(Parrot_pmc_reuse_init)
pmc = Parrot_pmc_reuse_noinit(interp, pmc, new_type);
/* Call the base init for the redone pmc. Warning, this should not
be called on Object PMCs. */
VTABLE_init_pmc(interp, pmc, init);
return pmc;
}
/*
=item C<static PMC* Parrot_pmc_reuse_noinit(PARROT_INTERP, PMC *pmc, INTVAL
new_type)>
Prepare pmc for reuse. Do all scuffolding except initing.
=cut
*/
PARROT_CANNOT_RETURN_NULL
static PMC*
Parrot_pmc_reuse_noinit(PARROT_INTERP, ARGIN(PMC *pmc), INTVAL new_type)
{
ASSERT_ARGS(Parrot_pmc_reuse_noinit)
if (pmc->vtable->base_type != new_type) {
Parrot_UInt gc_flags = pmc->flags & PObj_GC_all_FLAGS;
VTABLE * const new_vtable = interp->vtables[new_type];
/* Singleton/const PMCs/types are not eligible */
check_pmc_reuse_flags(interp, pmc->vtable->flags, new_vtable->flags);
/* Free the old PMC resources. */
Parrot_pmc_destroy(interp, pmc);
/*
* We can reuse PMC from older generation. Preserve and soil it.
*
* FIXME It's abstraction leak. And it's really strange idea of reusing
* PMCs...
*/
PObj_flags_SETTO(pmc, PObj_is_PMC_FLAG | gc_flags);
PARROT_GC_WRITE_BARRIER(interp, pmc);
/* Set the right vtable */
pmc->vtable = new_vtable;
if (new_vtable->attr_size)
Parrot_gc_allocate_pmc_attributes(interp, pmc);
else
PMC_data(pmc) = NULL;
}
return pmc;
}
/*
=item C<PMC * Parrot_pmc_reuse_by_class(PARROT_INTERP, PMC *pmc, PMC *class_,
UINTVAL flags)>
Reuse an existing PMC. Convert it to the type specified by the given Class
PMC. At the moment, this means we can only use this function to reuse PMCs
into types with Classes (not built-in PMCs). Use C<pmc_reuse> if you need
to convert to a built-in PMC type.
=cut
*/
PARROT_EXPORT
PARROT_CANNOT_RETURN_NULL
PARROT_IGNORABLE_RESULT
PMC *
Parrot_pmc_reuse_by_class(PARROT_INTERP, ARGMOD(PMC *pmc), ARGIN(PMC *class_), UINTVAL flags)
{
ASSERT_ARGS(Parrot_pmc_reuse_by_class)
const INTVAL new_type = PARROT_CLASS(class_)->id;
if (pmc->vtable->base_type != new_type) {
VTABLE * const new_vtable = interp->vtables[new_type];
/* Singleton/const PMCs/types are not eligible */
check_pmc_reuse_flags(interp, pmc->vtable->flags, new_vtable->flags);
Parrot_pmc_destroy(interp, pmc);
PObj_flags_SETTO(pmc, PObj_is_PMC_FLAG | flags);
/* Set the right vtable */
pmc->vtable = new_vtable;
if (new_vtable->attr_size)
Parrot_gc_allocate_pmc_attributes(interp, pmc);
else
PMC_data(pmc) = NULL;
}
return pmc;
}
/*
=item C<static void check_pmc_reuse_flags(PARROT_INTERP, UINTVAL srcflags,
UINTVAL destflags)>
We're converting one PMC type to another, either in C<pmc_reuse> or
C<pmc_reuse_by_class>. Check to make sure that neither the existing PMC
or the intended target PMC type are singletons or constants. We throw an
exception if we are attempting an illegal operation.
=cut
*/
static void
check_pmc_reuse_flags(PARROT_INTERP, UINTVAL srcflags, UINTVAL destflags)
{
ASSERT_ARGS(check_pmc_reuse_flags)
if ((srcflags | destflags) & (VTABLE_PMC_IS_SINGLETON | VTABLE_IS_CONST_FLAG))
{
/* First, is the destination a singleton? No joy for us there */
if (destflags & VTABLE_PMC_IS_SINGLETON)
Parrot_ex_throw_from_c_args(interp, NULL,
EXCEPTION_ALLOCATION_ERROR,
"Parrot VM: Can't turn to a singleton type!\n");
/* Is the destination a constant? No joy for us there */
if (destflags & VTABLE_IS_CONST_FLAG)
Parrot_ex_throw_from_c_args(interp, NULL,
EXCEPTION_ALLOCATION_ERROR,
"Parrot VM: Can't turn to a constant type!\n");
/* Is the source a singleton? */
if (srcflags & VTABLE_PMC_IS_SINGLETON)
Parrot_ex_throw_from_c_args(interp, NULL,
EXCEPTION_ALLOCATION_ERROR,
"Parrot VM: Can't modify a singleton\n");
/* Is the source constant? */
if (srcflags & VTABLE_IS_CONST_FLAG)
Parrot_ex_throw_from_c_args(interp, NULL,
EXCEPTION_ALLOCATION_ERROR,
"Parrot VM: Can't modify a constant\n");
}
}
/*
=item C<static PMC * get_new_pmc_header(PARROT_INTERP, INTVAL base_type, UINTVAL
flags)>
Gets a new PMC header of the given integer type. Initialize the pmc if
necessary. In the case of singleton PMC types, get the existing singleton
instead of allocating a new one.
=cut
*/
PARROT_WARN_UNUSED_RESULT
PARROT_CANNOT_RETURN_NULL
static PMC *
get_new_pmc_header(PARROT_INTERP, INTVAL base_type, UINTVAL flags)
{
ASSERT_ARGS(get_new_pmc_header)
PMC *newpmc;
VTABLE *vtable = interp->vtables[base_type];
UINTVAL vtable_flags;
/* This is usually because you either didn't call init_world early enough,
* you added a new PMC class without adding Parrot_(classname)_class_init
* to init_world, or you forgot to run 'make realclean' after adding a new
* PMC class. */
if (!vtable)
PANIC(interp, "Null vtable used; did you add a new PMC?");
vtable_flags = vtable->flags;
/* we only have one global Env object, living in the interp */
if (vtable_flags & VTABLE_PMC_IS_SINGLETON) {
/*
* singletons (monadic objects) exist only once
* the interface * with the class is:
* - get_pointer: return NULL or a pointer to the single instance
* - set_pointer: set the only instance once
*
* - singletons are created in the constant pmc pool
*/
PMC *pmc = (PMC *)(vtable->get_pointer)(interp, NULL);
/* LOCK */
if (!pmc) {
pmc = Parrot_gc_new_pmc_header(interp, PObj_constant_FLAG);
PARROT_ASSERT(pmc);
pmc->vtable = vtable;
VTABLE_set_pointer(interp, pmc, pmc);
}
return pmc;
}
if (vtable_flags & VTABLE_IS_CONST_PMC_FLAG)
flags |= PObj_constant_FLAG;
else if (vtable_flags & VTABLE_IS_CONST_FLAG) {
/* put the normal vtable in, so that the pmc can be initialized first
* parrot or user code has to set the _ro property then,
* to morph the PMC to the const variant
* This assumes that a constant PMC enum is one bigger then
* the normal one.
*/
/*
* XXX not yet we can't assure that all contents in the
* const PMC is const too
* see e.g. t/pmc/sarray_13.pir
*/
--base_type;
vtable = interp->vtables[base_type];
}
if (vtable_flags & VTABLE_IS_SHARED_FLAG)
flags |= PObj_is_PMC_shared_FLAG;
newpmc = Parrot_gc_new_pmc_header(interp, flags);
newpmc->vtable = vtable;
if (vtable->attr_size)
Parrot_gc_allocate_pmc_attributes(interp, newpmc);
return newpmc;
}
/*
=item C<PMC * Parrot_pmc_new_noinit(PARROT_INTERP, INTVAL base_type)>
Creates a new PMC of type C<base_type> (which is an index into the list of PMC
types declared in C<vtables> in F<include/parrot/pmc.h>). Unlike C<Parrot_pmc_new()>,
C<Parrot_pmc_new_noinit()> does not call its C<init> method. This allows separate
allocation and initialization for continuations.
=cut
*/
PARROT_EXPORT
PARROT_CANNOT_RETURN_NULL
PMC *
Parrot_pmc_new_noinit(PARROT_INTERP, INTVAL base_type)
{
ASSERT_ARGS(Parrot_pmc_new_noinit)
PMC *const classobj = interp->vtables[base_type]->pmc_class;
if (!PMC_IS_NULL(classobj) && PObj_is_class_TEST(classobj))
return VTABLE_instantiate(interp, classobj, PMCNULL);
return get_new_pmc_header(interp, base_type, 0);
}
/*
=item C<PMC * Parrot_pmc_new_constant_noinit(PARROT_INTERP, INTVAL base_type)>
Creates a new constant PMC of type C<base_type>.
=cut
*/
PARROT_EXPORT
PARROT_CANNOT_RETURN_NULL
PARROT_WARN_UNUSED_RESULT
PMC *
Parrot_pmc_new_constant_noinit(PARROT_INTERP, INTVAL base_type)
{
ASSERT_ARGS(Parrot_pmc_new_constant_noinit)
return get_new_pmc_header(interp, base_type, PObj_constant_FLAG);
}
/*
=item C<PMC * Parrot_pmc_new_constant(PARROT_INTERP, INTVAL base_type)>
Creates a new constant PMC of type C<base_type>, then calls its C<init>.
=cut
*/
PARROT_EXPORT
PARROT_CANNOT_RETURN_NULL
PMC *
Parrot_pmc_new_constant(PARROT_INTERP, INTVAL base_type)
{
ASSERT_ARGS(Parrot_pmc_new_constant)
PMC * const pmc = get_new_pmc_header(interp, base_type, PObj_constant_FLAG);
VTABLE_init(interp, pmc);
return pmc;
}
/*
=item C<PMC * Parrot_pmc_new_init(PARROT_INTERP, INTVAL base_type, PMC *init)>
As C<Parrot_pmc_new()>, but passes C<init> to the PMC's C<init_pmc()> vtable entry.
=cut
*/
PARROT_EXPORT
PARROT_CANNOT_RETURN_NULL
PMC *
Parrot_pmc_new_init(PARROT_INTERP, INTVAL base_type, ARGOUT(PMC *init))
{
ASSERT_ARGS(Parrot_pmc_new_init)
PMC *const classobj = interp->vtables[base_type]->pmc_class;
if (!PMC_IS_NULL(classobj) && PObj_is_class_TEST(classobj))
return VTABLE_instantiate(interp, classobj, init);
else {
PMC * const pmc = get_new_pmc_header(interp, base_type, 0);
VTABLE_init_pmc(interp, pmc, init);
return pmc;
}
}
/*
=item C<PMC * Parrot_pmc_new_init_int(PARROT_INTERP, INTVAL base_type, INTVAL
init)>
As C<Parrot_pmc_new()>, but passes C<init> to the PMC's C<init_int()> vtable entry.
=cut
*/
PARROT_EXPORT
PARROT_CANNOT_RETURN_NULL
PMC *
Parrot_pmc_new_init_int(PARROT_INTERP, INTVAL base_type, INTVAL init)
{
ASSERT_ARGS(Parrot_pmc_new_init_int)
PMC *const classobj = interp->vtables[base_type]->pmc_class;
if (!PMC_IS_NULL(classobj) && PObj_is_class_TEST(classobj)) {
PMC * const obj = VTABLE_instantiate(interp, classobj, PMCNULL);
VTABLE_set_integer_native(interp, obj, init);
return obj;
}
else {
PMC * const pmc = get_new_pmc_header(interp, base_type, 0);
VTABLE_init_int(interp, pmc, init);
return pmc;
}
}
/*
=item C<PMC * Parrot_pmc_new_constant_init(PARROT_INTERP, INTVAL base_type, PMC
*init)>
As C<Parrot_pmc_new_constant>, but passes C<init> to the PMC's C<init_pmc> vtable
entry.
=cut
*/
PARROT_EXPORT
PARROT_CANNOT_RETURN_NULL
PMC *
Parrot_pmc_new_constant_init(PARROT_INTERP, INTVAL base_type, ARGIN_NULLOK(PMC *init))
{
ASSERT_ARGS(Parrot_pmc_new_constant_init)
PMC * const pmc = get_new_pmc_header(interp, base_type, PObj_constant_FLAG);
VTABLE_init_pmc(interp, pmc, init);
return pmc;
}
/*
=item C<PMC * Parrot_pmc_new_constant_init_int(PARROT_INTERP, INTVAL base_type,
INTVAL init)>
As C<Parrot_pmc_new_constant>, but passes C<init> to the PMC's C<init_int> vtable
entry.
=cut
*/
PARROT_EXPORT
PARROT_CANNOT_RETURN_NULL
PMC *
Parrot_pmc_new_constant_init_int(PARROT_INTERP, INTVAL base_type, INTVAL init)
{
ASSERT_ARGS(Parrot_pmc_new_constant_init_int)
PMC * const pmc = get_new_pmc_header(interp, base_type, PObj_constant_FLAG);
VTABLE_init_int(interp, pmc, init);
return pmc;
}
/*
=item C<PMC * Parrot_pmc_new_temporary(PARROT_INTERP, INTVAL base_type)>
Creates a new temporary PMC of type C<base_type>, then call C<init>. Cannot
be used to create PMC Objects which have been defined from PIR.
B<You> are responsible for freeing this PMC when it goes out of scope with
C<Parrot_pmc_free_temporary()>. B<Do not> store this PMC in any other PMCs, or
allow it to be stored. B<Do not> store any regular PMC in this PMC, or
allow the storage of any regular PMC in this PMC. Temporary PMCs do not
participate in garbage collection, and mixing them with PMCs that are
garbage-collected will cause bugs.
If you don't know what this means means, or you can't tell if either case
will happen as the result of any call you make on or with this PMC,
B<DO NOT> use this function, lest you cause weird crashes and memory errors.
Use C<Parrot_pmc_new()> instead.
(Why do these functions even exist? Used judiciously, they can reduce GC
pressure in hotspots tremendously. If you haven't audited the code carefully
-- including profiling and benchmarking -- then use C<Parrot_pmc_new()> instead, and
never B<ever> add C<PARROT_EXPORT> to either function.)
=cut
*/
PARROT_CANNOT_RETURN_NULL
PMC *
Parrot_pmc_new_temporary(PARROT_INTERP, INTVAL base_type)
{
ASSERT_ARGS(Parrot_pmc_new_temporary)
PMC * const pmc = get_new_pmc_header(interp, base_type, PObj_constant_FLAG);
VTABLE_init(interp, pmc);
return pmc;
}
/*
=item C<void Parrot_pmc_free_temporary(PARROT_INTERP, PMC *pmc)>
Frees a new temporary PMC created by C<temporary_Parrot_pmc_new()>. Do not call
this with any other type of PMC. Do not forget to call this (or you'll leak
PMCs). Read and I<understand> the warnings for C<temporary_Parrot_pmc_new()> before
you're tempted to use this.
=cut
*/
void
Parrot_pmc_free_temporary(PARROT_INTERP, ARGMOD(PMC *pmc))
{
ASSERT_ARGS(Parrot_pmc_free_temporary)
Parrot_gc_free_pmc_header(interp, pmc);
}
/*
=item C<INTVAL Parrot_pmc_get_new_vtable_index(PARROT_INTERP)>
Get a new unique identifier number and allocate a new vtable structure for a
new PMC type.
=cut
*/
INTVAL
Parrot_pmc_get_new_vtable_index(PARROT_INTERP)
{
ASSERT_ARGS(Parrot_pmc_get_new_vtable_index)
const INTVAL type_id = interp->n_vtable_max++;
/* Have we overflowed the table? */
if (type_id >= interp->n_vtable_alloced)
Parrot_vtbl_realloc_vtables(interp);
return type_id;
}
/*
=item C<INTVAL Parrot_pmc_register_new_type(PARROT_INTERP, STRING *name)>
Registers the name of a new PMC type with Parrot, returning the INTVAL
representing that type.
=cut
*/
PARROT_EXPORT
INTVAL
Parrot_pmc_register_new_type(PARROT_INTERP, ARGIN(STRING *name))
{
ASSERT_ARGS(Parrot_pmc_register_new_type)
/* If they're looking to register an existing class, return that
class' type number */
INTVAL type = Parrot_pmc_get_type_str(interp, name);
if (type > enum_type_undef)
return type;
if (type < enum_type_undef)
Parrot_ex_throw_from_c_args(interp, NULL, 1,
"undefined type already exists - can't register PMC");
type = Parrot_pmc_get_new_vtable_index(interp);
/* set entry in name->type hash */
VTABLE_set_integer_keyed_str(interp, interp->class_hash, name, type);
return type;
}
/*
=item C<INTVAL Parrot_pmc_get_type_str(PARROT_INTERP, STRING *name)>
Returns the PMC type for C<name>.
=cut
*/
PARROT_EXPORT
PARROT_WARN_UNUSED_RESULT
INTVAL
Parrot_pmc_get_type_str(PARROT_INTERP, ARGIN_NULLOK(STRING *name))
{
ASSERT_ARGS(Parrot_pmc_get_type_str)
if (STRING_IS_NULL(name))
return enum_type_undef;
else {
PMC * const classname_hash = interp->class_hash;
PMC * const item =
(PMC *)VTABLE_get_pointer_keyed_str(interp, classname_hash, name);
if (!PMC_IS_NULL(item)) {
/* nested namespace with same name */
if (PMC_IS_TYPE(item, NameSpace))
return enum_type_undef;
else
return VTABLE_get_integer(interp, item);
}
else
return Parrot_dt_get_datatype_enum(interp, name);
}
}
/*
=item C<PMC * Parrot_pmc_box_string(PARROT_INTERP, STRING *string)>
Boxes a STRING C<string> into a String PMC.
=cut
*/
PARROT_EXPORT
PARROT_HOT
PARROT_CANNOT_RETURN_NULL
PMC *
Parrot_pmc_box_string(PARROT_INTERP, ARGIN_NULLOK(STRING *string))
{
ASSERT_ARGS(Parrot_pmc_box_string)
PMC * ret = Parrot_pmc_new(interp,
Parrot_hll_get_ctx_HLL_type(interp, enum_class_String));
VTABLE_set_string_native(interp, ret, string);
return ret;
}
/*
=item C<PMC* Parrot_pmc_box_number(PARROT_INTERP, FLOATVAL value)>
Lookup the PMC type which is used for floating point numbers.
=cut
*/
PARROT_EXPORT
PARROT_HOT
PARROT_CANNOT_RETURN_NULL
PMC*
Parrot_pmc_box_number(PARROT_INTERP, FLOATVAL value)
{
ASSERT_ARGS(Parrot_pmc_box_number)
PMC * const ret = Parrot_pmc_new(interp,
Parrot_hll_get_ctx_HLL_type(interp, enum_class_Float));
VTABLE_set_number_native(interp, ret, value);
return ret;
}
/*
=item C<PMC* Parrot_pmc_box_integer(PARROT_INTERP, INTVAL value)>
Lookup the PMC type which is used for storing native integers.
=cut
*/
PARROT_EXPORT
PARROT_HOT
PARROT_CANNOT_RETURN_NULL
PMC*
Parrot_pmc_box_integer(PARROT_INTERP, INTVAL value)
{
ASSERT_ARGS(Parrot_pmc_box_integer)
PMC * const ret = Parrot_pmc_new(interp,
Parrot_hll_get_ctx_HLL_type(interp, enum_class_Integer));
VTABLE_set_integer_native(interp, ret, value);
return ret;
}
/*
=item C<PMC * Parrot_pmc_box_c_string_array(PARROT_INTERP, int count, const char
**s)>
Take a C string array and a count, and box it into a string array PMC
=cut
*/
PARROT_EXPORT
PARROT_CANNOT_RETURN_NULL
PMC *
Parrot_pmc_box_c_string_array(PARROT_INTERP, int count, ARGIN(const char **s))
{
ASSERT_ARGS(Parrot_pmc_box_c_string_array)
PMC * const s_pmc = Parrot_pmc_new(interp, enum_class_ResizableStringArray);
if (s != NULL && count > 0) {
Parrot_Int i = 0;
for (; i < count; ++i) {
/* Run through argv, adding everything to the array */
STRING * const item = Parrot_str_from_platform_cstring(interp, s[i]);
VTABLE_push_string(interp, s_pmc, item);
}
}
return s_pmc;
}
/*
=item C<INTVAL Parrot_pmc_get_type(PARROT_INTERP, PMC *name)>
Returns the PMC type for C<name>.
=cut
*/
PARROT_EXPORT
INTVAL
Parrot_pmc_get_type(PARROT_INTERP, ARGIN(PMC *name))
{
ASSERT_ARGS(Parrot_pmc_get_type)
PMC * const classname_hash = interp->class_hash;
PMC * const item = (PMC *)VTABLE_get_pointer_keyed(interp, classname_hash, name);
if (!PMC_IS_NULL(item))
return VTABLE_get_integer(interp, item);
return 0;
}
/*
=item C<static PMC * create_class_pmc(PARROT_INTERP, INTVAL type)>
Create a class object for this interpreter. Takes an interpreter name and type
as arguments. Returns a pointer to the class object.
=cut
*/
PARROT_WARN_UNUSED_RESULT
PARROT_CANNOT_RETURN_NULL
static PMC *
create_class_pmc(PARROT_INTERP, INTVAL type)
{
ASSERT_ARGS(create_class_pmc)
/*
* class interface - a PMC is its own class
* put an instance of this PMC into class
*
* create a constant PMC
*/
PMC * const _class = get_new_pmc_header(interp, type,
PObj_constant_FLAG);
/* If we are a second thread, we may get the same object as the
* original because we have a singleton. Just set the singleton to
* be our class object, but don't mess with its vtable. */
if ((interp->vtables[type]->flags & VTABLE_PMC_IS_SINGLETON)
&& (_class == _class->vtable->pmc_class))
interp->vtables[type]->pmc_class = _class;
else {
PObj_is_PMC_shared_CLEAR(_class);
interp->vtables[type]->pmc_class = _class;
}
return _class;
}
/*
=item C<void Parrot_pmc_create_mro(PARROT_INTERP, INTVAL type)>
Create the MRO (method resolution order) array for this type.
=cut
*/
PARROT_EXPORT
void
Parrot_pmc_create_mro(PARROT_INTERP, INTVAL type)
{
ASSERT_ARGS(Parrot_pmc_create_mro)
PMC *mro;
VTABLE *vtable = interp->vtables[type];
PMC * const mro_list = vtable->mro;
INTVAL i, count;
/* this should never be PMCNULL */
PARROT_ASSERT(!PMC_IS_NULL(mro_list));
/* multithreaded: has already mro */
if (mro_list->vtable->base_type != enum_class_ResizableStringArray)
return;
mro = Parrot_pmc_new(interp, enum_class_ResizablePMCArray);
vtable->mro = mro;
if (vtable->ro_variant_vtable)
vtable->ro_variant_vtable->mro = mro;
count = VTABLE_elements(interp, mro_list);
for (i = 0; i < count; ++i) {
STRING * const class_name = VTABLE_get_string_keyed_int(interp, mro_list, i);
const INTVAL parent_type = Parrot_pmc_get_type_str(interp, class_name);