-
Notifications
You must be signed in to change notification settings - Fork 2.9k
/
erl_term.h
1530 lines (1305 loc) · 56.6 KB
/
erl_term.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
/*
* %CopyrightBegin%
*
* Copyright Ericsson AB 2000-2023. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
* %CopyrightEnd%
*/
#ifndef __ERL_TERM_H
#define __ERL_TERM_H
#include "erl_mmap.h"
void erts_term_init(void);
struct erl_node_; /* Declared in erl_node_tables.h */
/*
* Defining ET_DEBUG to 1 causes all type-specific data access
* macros to perform runtime type checking. This is very useful
* during development but reduces performance, so ET_DEBUG should
* be disabled during benchmarking or release.
*/
/* #define ET_DEBUG 1 */
#ifndef ET_DEBUG
# ifdef DEBUG
# define ET_DEBUG 1
# else
# define ET_DEBUG 0
# endif
#endif
#if ET_DEBUG
#define _ET_DECLARE_CHECKED(TF,F,TX) extern TF checked_##F(TX,const char*,unsigned);
#define _ET_APPLY(F,X) checked_##F(X,__FILE__,__LINE__)
#else
#define _ET_DECLARE_CHECKED(TF,F,TX)
#define _ET_APPLY(F,X) _unchecked_##F(X)
#endif
#if defined(ARCH_64)
# define TAG_PTR_MASK__ 0x7
# if !defined(ERTS_HAVE_OS_PHYSICAL_MEMORY_RESERVATION) || defined(DEBUG)
# define TAG_LITERAL_PTR 0x4
# else
# undef TAG_LITERAL_PTR
# endif
#elif defined(ARCH_32)
# define TAG_PTR_MASK__ 0x3
# undef TAG_LITERAL_PTR
#else
# error Not supported arch
#endif
#define _TAG_PRIMARY_SIZE 2
#define _TAG_PRIMARY_MASK 0x3
#define TAG_PRIMARY_HEADER 0x0
#define TAG_PRIMARY_LIST 0x1
#define TAG_PRIMARY_BOXED 0x2
#define TAG_PRIMARY_IMMED1 0x3
#define primary_tag(x) ((x) & _TAG_PRIMARY_MASK)
#define _TAG_IMMED1_SIZE 4
#define _TAG_IMMED1_MASK 0xF
#define _TAG_IMMED1_PID ((0x0 << _TAG_PRIMARY_SIZE) | TAG_PRIMARY_IMMED1)
#define _TAG_IMMED1_PORT ((0x1 << _TAG_PRIMARY_SIZE) | TAG_PRIMARY_IMMED1)
#define _TAG_IMMED1_IMMED2 ((0x2 << _TAG_PRIMARY_SIZE) | TAG_PRIMARY_IMMED1)
#define _TAG_IMMED1_SMALL ((0x3 << _TAG_PRIMARY_SIZE) | TAG_PRIMARY_IMMED1)
#define _TAG_IMMED2_SIZE 6
#define _TAG_IMMED2_MASK 0x3F
#define _TAG_IMMED2_ATOM ((0x0 << _TAG_IMMED1_SIZE) | _TAG_IMMED1_IMMED2)
#define _TAG_IMMED2_CATCH ((0x1 << _TAG_IMMED1_SIZE) | _TAG_IMMED1_IMMED2)
#define _TAG_IMMED2_NIL ((0x3 << _TAG_IMMED1_SIZE) | _TAG_IMMED1_IMMED2)
/*
* HEADER representation:
*
* aaaaaaaaaaaaaaaaaaaaaaaaaattttpp arity:26, tag:4, ptag:2
*
* Where ptag is always TAG_PRIMARY_HEADER.
*
* HEADER tags:
*
* 0000 ARITYVAL
* 0001 FUN_REF |
* 001x BIGNUM with sign bit |
* 0100 REF |
* 0101 FUN | THINGS
* 0110 FLONUM |
* 0111 -- FREE -- |
* 1000 HEAP_BITS | BITSTRINGS |
* 1001 SUB_BITS | |
* 1010 BIN_REF |
* 1011 MAP |
* 1100 EXTERNAL_PID | EXTERNAL THINGS |
* 1101 EXTERNAL_PORT | |
* 1110 EXTERNAL_REF | |
* 1111 -- FREE -- | Reserved external |
*
* COMMENTS:
*
* - The tag is zero for arityval and non-zero for thing headers.
* - A single bit differentiates between positive and negative bignums.
* - If more tags are needed, the REF and EXTERNAL_REF tags could probably
* be combined to one tag.
*
* XXX: globally replace XXX_SUBTAG with TAG_HEADER_XXX
*/
#define ARITYVAL_SUBTAG (0x0 << _TAG_PRIMARY_SIZE) /* TUPLE */
#define FUN_REF_SUBTAG (0x1 << _TAG_PRIMARY_SIZE) /* FUN_REF */
#define _BIG_TAG_MASK (~(0x1 << _TAG_PRIMARY_SIZE) & _TAG_HEADER_MASK)
#define _BIG_SIGN_BIT (0x1 << _TAG_PRIMARY_SIZE)
#define POS_BIG_SUBTAG (0x2 << _TAG_PRIMARY_SIZE) /* BIGNUM */
#define NEG_BIG_SUBTAG (0x3 << _TAG_PRIMARY_SIZE) /* BIGNUM */
#define REF_SUBTAG (0x4 << _TAG_PRIMARY_SIZE) /* REF */
#define FUN_SUBTAG (0x5 << _TAG_PRIMARY_SIZE) /* FUN */
#define FLOAT_SUBTAG (0x6 << _TAG_PRIMARY_SIZE) /* FLOAT */
#define _BITSTRING_TAG_MASK (~(0x1 << _TAG_PRIMARY_SIZE) & _TAG_HEADER_MASK)
#define HEAP_BITS_SUBTAG (0x8 << _TAG_PRIMARY_SIZE) /* BITSTRING */
#define SUB_BITS_SUBTAG (0x9 << _TAG_PRIMARY_SIZE) /* BITSTRING */
#define BIN_REF_SUBTAG (0xA << _TAG_PRIMARY_SIZE)
#define MAP_SUBTAG (0xB << _TAG_PRIMARY_SIZE) /* MAP */
#define _EXTERNAL_TAG_MASK (~(0x3 << _TAG_PRIMARY_SIZE) & _TAG_HEADER_MASK)
#define EXTERNAL_PID_SUBTAG (0xC << _TAG_PRIMARY_SIZE) /* EXTERNAL_PID */
#define EXTERNAL_PORT_SUBTAG (0xD << _TAG_PRIMARY_SIZE) /* EXTERNAL_PORT */
#define EXTERNAL_REF_SUBTAG (0xE << _TAG_PRIMARY_SIZE) /* EXTERNAL_REF */
/* _EXTERNAL_TAG_MASK requires that 0xF is reserved for external terms. */
#define _TAG_HEADER_ARITYVAL (TAG_PRIMARY_HEADER|ARITYVAL_SUBTAG)
#define _TAG_HEADER_FUN_REF (TAG_PRIMARY_HEADER|FUN_REF_SUBTAG)
#define _TAG_HEADER_FUN (TAG_PRIMARY_HEADER|FUN_SUBTAG)
#define _TAG_HEADER_POS_BIG (TAG_PRIMARY_HEADER|POS_BIG_SUBTAG)
#define _TAG_HEADER_NEG_BIG (TAG_PRIMARY_HEADER|NEG_BIG_SUBTAG)
#define _TAG_HEADER_FLOAT (TAG_PRIMARY_HEADER|FLOAT_SUBTAG)
#define _TAG_HEADER_REF (TAG_PRIMARY_HEADER|REF_SUBTAG)
#define _TAG_HEADER_BIN_REF (TAG_PRIMARY_HEADER|BIN_REF_SUBTAG)
#define _TAG_HEADER_HEAP_BITS (TAG_PRIMARY_HEADER|HEAP_BITS_SUBTAG)
#define _TAG_HEADER_SUB_BITS (TAG_PRIMARY_HEADER|SUB_BITS_SUBTAG)
#define _TAG_HEADER_EXTERNAL_PID (TAG_PRIMARY_HEADER|EXTERNAL_PID_SUBTAG)
#define _TAG_HEADER_EXTERNAL_PORT (TAG_PRIMARY_HEADER|EXTERNAL_PORT_SUBTAG)
#define _TAG_HEADER_EXTERNAL_REF (TAG_PRIMARY_HEADER|EXTERNAL_REF_SUBTAG)
#define _TAG_HEADER_MAP (TAG_PRIMARY_HEADER|MAP_SUBTAG)
#define _TAG_HEADER_MASK 0x3F
#define _HEADER_SUBTAG_MASK 0x3C /* 4 bits for subtag */
#define _HEADER_ARITY_OFFS 6
#define header_is_transparent(x) \
(((x) & (_HEADER_SUBTAG_MASK)) == ARITYVAL_SUBTAG)
#define header_is_arityval(x) (((x) & _HEADER_SUBTAG_MASK) == ARITYVAL_SUBTAG)
#define header_is_thing(x) (!header_is_transparent((x)))
#define _CPMASK 0x3
/* immediate object access methods */
#define is_immed(x) (((x) & _TAG_PRIMARY_MASK) == TAG_PRIMARY_IMMED1)
#define is_not_immed(x) (!is_immed((x)))
#define IS_CONST(x) is_immed((x))
#if TAG_PRIMARY_IMMED1 == _TAG_PRIMARY_MASK
#define is_both_immed(x,y) is_immed(((x)&(y)))
#else
#define is_both_immed(x,y) (is_immed((x)) && is_immed((y)))
#endif
#define is_not_both_immed(x,y) (!is_both_immed((x),(y)))
#define is_zero_sized(x) (is_immed(x) || (x) == ERTS_GLOBAL_LIT_EMPTY_TUPLE)
/* boxed object access methods */
#define _is_taggable_pointer(x) (((Uint)(x) & TAG_PTR_MASK__) == 0)
#define _boxed_precond(x) (is_boxed(x))
#define _is_aligned(x) (((Uint)(x) & TAG_PTR_MASK__) == 0)
#define _unchecked_make_boxed(x) ((Uint)(x) + TAG_PRIMARY_BOXED)
_ET_DECLARE_CHECKED(Eterm,make_boxed,const Eterm*)
#define make_boxed(x) _ET_APPLY(make_boxed,(x))
#if 1
#define _is_not_boxed(x) ((x) & (_TAG_PRIMARY_MASK-TAG_PRIMARY_BOXED))
#define _unchecked_is_boxed(x) (!_is_not_boxed((x)))
_ET_DECLARE_CHECKED(int,is_boxed,Eterm)
#define is_boxed(x) _ET_APPLY(is_boxed,(x))
#else
#define is_boxed(x) (((x) & _TAG_PRIMARY_MASK) == TAG_PRIMARY_BOXED)
#endif
#ifdef TAG_LITERAL_PTR
#define _unchecked_boxed_val(x) _unchecked_ptr_val(x)
#else
#define _unchecked_boxed_val(x) ((Eterm*) ((x) - TAG_PRIMARY_BOXED))
#endif
_ET_DECLARE_CHECKED(Eterm*,boxed_val,Eterm)
#define boxed_val(x) _ET_APPLY(boxed_val,(x))
/* cons cell ("list") access methods */
#define _unchecked_make_list(x) ((Uint)(x) + TAG_PRIMARY_LIST)
_ET_DECLARE_CHECKED(Eterm,make_list,const Eterm*)
#define make_list(x) _ET_APPLY(make_list,(x))
#if 1
#define _unchecked_is_not_list(x) ((x) & (_TAG_PRIMARY_MASK-TAG_PRIMARY_LIST))
_ET_DECLARE_CHECKED(int,is_not_list,Eterm)
#define is_not_list(x) _ET_APPLY(is_not_list,(x))
#define is_list(x) (!is_not_list((x)))
#else
#define is_list(x) (((x) & _TAG_PRIMARY_MASK) == TAG_PRIMARY_LIST)
#define is_not_list(x) (!is_list((x)))
#endif
#define _list_precond(x) (is_list(x))
#ifdef TAG_LITERAL_PTR
#define _unchecked_list_val(x) _unchecked_ptr_val(x)
#else
#define _unchecked_list_val(x) ((Eterm*) ((x) - TAG_PRIMARY_LIST))
#endif
_ET_DECLARE_CHECKED(Eterm*,list_val,Eterm)
#define list_val(x) _ET_APPLY(list_val,(x))
#define CONS(hp, car, cdr) \
(CAR(hp)=(car), CDR(hp)=(cdr), make_list(hp))
#define CAR(x) ((x)[0])
#define CDR(x) ((x)[1])
/* generic tagged pointer (boxed or list) access methods */
#define _unchecked_ptr_val(x) ((Eterm*) ((x) & ~((Uint) TAG_PTR_MASK__)))
#define ptr_val(x) _unchecked_ptr_val((x)) /*XXX*/
#define _unchecked_offset_ptr(x,offs) ((x)+((offs)*sizeof(Eterm)))
#define offset_ptr(x,offs) _unchecked_offset_ptr(x,offs) /*XXX*/
#define _unchecked_byte_offset_ptr(x,byte_offs) ((x)+(offs))
#define byte_offset_ptr(x,offs) _unchecked_byte_offset_ptr(x,offs) /*XXX*/
#ifdef TAG_LITERAL_PTR
#define _unchecked_is_not_literal_ptr(x) (!((x) & TAG_LITERAL_PTR))
#define is_not_literal_ptr(x) _unchecked_is_not_literal_ptr((x)) /*XXX*/
#define is_literal_ptr(x) (!is_not_literal_ptr((x))) /*XXX*/
#endif
/* fixnum ("small") access methods */
#if defined(ARCH_64)
#define SMALL_BITS (64-4)
#define SMALL_DIGITS (17)
#else
#define SMALL_BITS (28)
#define SMALL_DIGITS (8)
#endif
#define MAX_SMALL ((SWORD_CONSTANT(1) << (SMALL_BITS-1))-1)
#define MIN_SMALL (-(SWORD_CONSTANT(1) << (SMALL_BITS-1)))
#define make_small(x) (((Uint)(x) << _TAG_IMMED1_SIZE) + _TAG_IMMED1_SMALL)
#define is_small(x) (((x) & _TAG_IMMED1_MASK) == _TAG_IMMED1_SMALL)
#define is_not_small(x) (!is_small((x)))
#define is_byte(x) (((x) & ((~(Uint)0 << (_TAG_IMMED1_SIZE+8)) + _TAG_IMMED1_MASK)) == _TAG_IMMED1_SMALL)
#define is_valid_bit_size(x) (((Sint)(x)) >= 0 && ((x) & 0x7F) == _TAG_IMMED1_SMALL)
#define is_not_valid_bit_size(x) (!is_valid_bit_size((x)))
#define _unchecked_unsigned_val(x) ((x) >> _TAG_IMMED1_SIZE)
_ET_DECLARE_CHECKED(Uint,unsigned_val,Eterm)
#define unsigned_val(x) _ET_APPLY(unsigned_val,(x))
#define _unchecked_signed_val(x) ((Sint)(x) >> _TAG_IMMED1_SIZE)
_ET_DECLARE_CHECKED(Sint,signed_val,Eterm)
#define signed_val(x) _ET_APPLY(signed_val,(x))
#if _TAG_IMMED1_SMALL == 0x0F
#define is_both_small(x,y) (((x) & (y) & _TAG_IMMED1_MASK) == _TAG_IMMED1_SMALL)
#elif _TAG_IMMED1_SMALL == 0x00
#define is_both_small(x,y) ((((x)|(y)) & _TAG_IMMED1_MASK) == _TAG_IMMED1_SMALL)
#else
#define is_both_small(x,y) (is_small(x) && is_small(y))
#endif
/* NIL access methods */
#define NIL ((Eterm)(_TAG_IMMED2_NIL))
#define is_nil(x) ((x) == NIL)
#define is_not_nil(x) ((x) != NIL)
#define MAX_ATOM_INDEX (~(~((Uint) 0) << (sizeof(Uint)*8 - _TAG_IMMED2_SIZE)))
/* atom access methods */
#define make_atom(x) ((Eterm)(((x) << _TAG_IMMED2_SIZE) + _TAG_IMMED2_ATOM))
#define is_atom(x) (((x) & _TAG_IMMED2_MASK) == _TAG_IMMED2_ATOM)
#define is_not_atom(x) (!is_atom(x))
#define _unchecked_atom_val(x) ((x) >> _TAG_IMMED2_SIZE)
_ET_DECLARE_CHECKED(Uint,atom_val,Eterm)
#define atom_val(x) _ET_APPLY(atom_val,(x))
/* header (arityval or thing) access methods */
#define _make_header(sz,tag) ((Uint)(((Uint)(sz) << _HEADER_ARITY_OFFS) + (tag)))
#define is_header(x) (((x) & _TAG_PRIMARY_MASK) == TAG_PRIMARY_HEADER)
#define _unchecked_header_arity(x) \
(is_map_header(x) ? MAP_HEADER_ARITY(x) : \
(is_fun_header(x) ? (ERL_FUN_SIZE - 1) : \
((x) >> _HEADER_ARITY_OFFS)))
_ET_DECLARE_CHECKED(Uint,header_arity,Eterm)
#define header_arity(x) _ET_APPLY(header_arity,(x))
/* arityval access methods */
/* Erlang Spec. 4.7.3 defines max arity to 65535
* we will however enforce max arity of 16777215 (24 bits)
* (checked in bifs and asserted in debug)
*/
#define MAX_ARITYVAL ((((Uint)1) << 24) - 1)
#define ERTS_MAX_TUPLE_SIZE MAX_ARITYVAL
/*
Due to an optimization that assumes that the word after the arity
word is allocated, one should generally not create tuples of arity
zero. One should instead use the literal that can be obtained by
calling erts_get_global_literal(ERTS_LIT_EMPTY_TUPLE).
If one really wants to create a zero arityval one should use
make_arityval_zero() or make_arityval_unchecked(sz)
*/
#define make_arityval_zero() (_make_header(0,_TAG_HEADER_ARITYVAL))
#define make_arityval(sz) (ASSERT((sz) <= MAX_ARITYVAL), \
ASSERT((sz) > 0), \
_make_header((sz),_TAG_HEADER_ARITYVAL))
#define make_arityval_unchecked(sz) (ASSERT((sz) <= MAX_ARITYVAL), \
_make_header((sz),_TAG_HEADER_ARITYVAL))
#define is_arity_value(x) (((x) & _TAG_HEADER_MASK) == _TAG_HEADER_ARITYVAL)
#define is_sane_arity_value(x) ((((x) & _TAG_HEADER_MASK) == _TAG_HEADER_ARITYVAL) && \
(((x) >> _HEADER_ARITY_OFFS) <= MAX_ARITYVAL))
#define is_not_arity_value(x) (!is_arity_value((x)))
#define _unchecked_arityval(x) ((x) >> _HEADER_ARITY_OFFS)
_ET_DECLARE_CHECKED(Uint,arityval,Eterm)
#define arityval(x) _ET_APPLY(arityval,(x))
/* thing access methods */
#define is_thing(x) (is_header((x)) && header_is_thing((x)))
#define is_thing_ptr(t) (is_thing((t)->header))
#define _unchecked_thing_arityval(x) _unchecked_header_arity((x))
_ET_DECLARE_CHECKED(Uint,thing_arityval,Eterm)
#define thing_arityval(x) _ET_APPLY(thing_arityval,(x))
#define _unchecked_thing_subtag(x) ((x) & _HEADER_SUBTAG_MASK)
_ET_DECLARE_CHECKED(Uint,thing_subtag,Eterm)
#define thing_subtag(x) _ET_APPLY(thing_subtag,(x))
/*
* Magic non-value object.
* Used as function return error and "absent value" indicator
* in the original runtime system. The new runtime system also
* uses it as forwarding marker for CONS cells.
*
* This value is 0 in the original runtime system, which unfortunately
* promotes sloppy programming practices. It also prevents some useful
* tag assignment schemes, e.g. using a 2-bit tag 00 for FIXNUM.
*
* To help find code which makes unwarranted assumptions about zero,
* we now use a non-zero bit-pattern in debug mode.
*
* In order to be able to differentiata against values, the non-value
* needs to be tagged as a header of some sort.
*/
#if ET_DEBUG
#define THE_NON_VALUE _make_header(0,_TAG_HEADER_FLOAT)
#else
#define THE_NON_VALUE (TAG_PRIMARY_HEADER)
#endif
#define is_non_value(x) ((x) == THE_NON_VALUE)
#define is_value(x) ((x) != THE_NON_VALUE)
/* binary object access methods */
#define is_bitstring_header(x) \
(((x) & (_BITSTRING_TAG_MASK)) == _TAG_HEADER_HEAP_BITS)
#define is_bin_ref(x) \
(is_boxed((x)) && *boxed_val(x) == HEADER_BIN_REF)
#define make_bitstring(x) make_boxed((Eterm*)(x))
#define is_bitstring(x) (is_boxed((x)) && is_bitstring_header(*boxed_val((x))))
#define is_not_bitstring(x) (!is_bitstring((x)))
#define _unchecked_bitstring_val(x) _unchecked_boxed_val((x))
_ET_DECLARE_CHECKED(Eterm*,bitstring_val,Eterm)
#define bitstring_val(x) _ET_APPLY(bitstring_val,(x))
/* Fun objects.
*
* These have a special tag scheme to make the representation as compact as
* possible. For normal headers, we have:
*
* aaaaaaaaaaaaaaaa aaaaaaaaaatttt00 arity:26, tag:4
*
* Since the arity and number of free variables are both limited to 255, we can
* fit them both into the header word.
*
* 0000000eeeeeeeee aaaaaaaa00010100 environment_size:9, arity:8
*
* Note that the lowest byte contains only the function subtag, and the next
* byte after that contains only the arity. This lets us combine the type
* and/or arity check into a single comparison without masking, by using 8- or
* 16-bit operations on the header word.
*
* Furthermore, as local funs always have at least one environment variable as
* the `FunRef` is treated as part of the environment, we can distinguish
* them by checking whether the environment size is zero. */
#define FUN_HEADER_ARITY_OFFS (_HEADER_ARITY_OFFS + 2)
#define FUN_HEADER_ENV_SIZE_OFFS (FUN_HEADER_ARITY_OFFS + 8)
#define MAKE_FUN_HEADER(Arity, NumFree, External) \
(ASSERT((!(External)) || ((NumFree) == 0)), \
(_TAG_HEADER_FUN | \
(((Arity)) << FUN_HEADER_ARITY_OFFS) | \
(((NumFree + !External)) << FUN_HEADER_ENV_SIZE_OFFS)))
#define is_fun_ref(x) \
(is_boxed((x)) && *boxed_val(x) == HEADER_FUN_REF)
#define is_fun_header(x) (((x) & _HEADER_SUBTAG_MASK) == FUN_SUBTAG)
#define make_fun(x) make_boxed((Eterm*)(x))
#define is_any_fun(x) (is_boxed((x)) && is_fun_header(*boxed_val((x))))
#define is_not_any_fun(x) (!is_any_fun((x)))
#define _unchecked_fun_val(x) _unchecked_boxed_val((x))
_ET_DECLARE_CHECKED(Eterm*,fun_val,Eterm)
#define fun_val(x) _ET_APPLY(fun_val,(x))
/* bignum access methods */
#define make_pos_bignum_header(sz) _make_header((sz),_TAG_HEADER_POS_BIG)
#define make_neg_bignum_header(sz) _make_header((sz),_TAG_HEADER_NEG_BIG)
#define _is_bignum_header(x) (((x) & _BIG_TAG_MASK) == _TAG_HEADER_POS_BIG)
#define _unchecked_bignum_header_is_neg(x) ((x) & _BIG_SIGN_BIT)
_ET_DECLARE_CHECKED(int,bignum_header_is_neg,Eterm)
#define bignum_header_is_neg(x) _ET_APPLY(bignum_header_is_neg,(x))
#define _unchecked_bignum_header_neg(x) ((x) | _BIG_SIGN_BIT)
_ET_DECLARE_CHECKED(Eterm,bignum_header_neg,Eterm)
#define bignum_header_neg(x) _ET_APPLY(bignum_header_neg,(x))
#define _unchecked_bignum_header_arity(x) _unchecked_header_arity((x))
_ET_DECLARE_CHECKED(Uint,bignum_header_arity,Eterm)
#define bignum_header_arity(x) _ET_APPLY(bignum_header_arity,(x))
#if defined(ARCH_64)
# define BIG_ARITY_MAX ((1 << 16)-1)
#else
# define BIG_ARITY_MAX ((1 << 17)-1)
#endif
#define make_big(x) make_boxed((x))
#define is_big(x) (is_boxed((x)) && _is_bignum_header(*boxed_val((x))))
#define is_not_big(x) (!is_big((x)))
#define _unchecked_big_val(x) _unchecked_boxed_val((x))
_ET_DECLARE_CHECKED(Eterm*,big_val,Eterm)
#define big_val(x) _ET_APPLY(big_val,(x))
/* flonum ("float") access methods */
#if defined(ARCH_64)
#define HEADER_FLONUM _make_header(1,_TAG_HEADER_FLOAT)
#else
#define HEADER_FLONUM _make_header(2,_TAG_HEADER_FLOAT)
#endif
#define make_float(x) make_boxed((x))
#define is_float(x) (is_boxed((x)) && *boxed_val((x)) == HEADER_FLONUM)
#define is_not_float(x) (!is_float(x))
#define _unchecked_float_val(x) _unchecked_boxed_val((x))
_ET_DECLARE_CHECKED(Eterm*,float_val,Eterm)
#define float_val(x) _ET_APPLY(float_val,(x))
/* Float definition for byte and word access */
typedef double ieee754_8;
typedef union float_def
{
ieee754_8 fd;
byte fb[sizeof(ieee754_8)];
Uint16 fs[sizeof(ieee754_8) / sizeof(Uint16)];
Uint32 fw[sizeof(ieee754_8) / sizeof(Uint32)];
Uint64 fdw;
} FloatDef;
#if defined(ARCH_64)
#define FLOAT_VAL_GET_DOUBLE(fval, f) (f).fdw = *((fval)+1)
#define PUT_DOUBLE(f, x) *(x) = HEADER_FLONUM, \
*((x)+1) = (f).fdw
#define GET_DOUBLE_DATA(p, f) (f).fdw = *((Uint *) (p))
#define PUT_DOUBLE_DATA(f,p) *((Uint *) (p)) = (f).fdw
#else
#define FLOAT_VAL_GET_DOUBLE(fval, f) (f).fw[0] = *((fval)+1), \
(f).fw[1] = *((fval)+2)
#define PUT_DOUBLE(f, x) *(x) = HEADER_FLONUM, \
*((x)+1) = (f).fw[0], \
*((x)+2) = (f).fw[1]
#define GET_DOUBLE_DATA(p, f) (f).fw[0] = *((Uint *) (p)),\
(f).fw[1] = *(((Uint *) (p))+1)
#define PUT_DOUBLE_DATA(f,p) *((Uint *) (p)) = (f).fw[0],\
*(((Uint *) (p))+1) = (f).fw[1]
#endif
#define GET_DOUBLE(x, f) FLOAT_VAL_GET_DOUBLE(float_val(x), f)
#define DOUBLE_DATA_WORDS (sizeof(ieee754_8)/sizeof(Eterm))
#define FLOAT_SIZE_OBJECT (DOUBLE_DATA_WORDS+1)
/* tuple access methods */
#define make_tuple(x) make_boxed((x))
#define is_tuple(x) (is_boxed((x)) && is_arity_value(*boxed_val((x))))
#define is_not_tuple(x) (!is_tuple((x)))
#define is_tuple_arity(x, a) \
(is_boxed((x)) && *boxed_val((x)) == make_arityval_unchecked((a)))
#define is_not_tuple_arity(x, a) (!is_tuple_arity((x),(a)))
#define _unchecked_tuple_val(x) _unchecked_boxed_val(x)
_ET_DECLARE_CHECKED(Eterm*,tuple_val,Eterm)
#define tuple_val(x) _ET_APPLY(tuple_val,(x))
/*
Due to an optimization that assumes that the word after the arity
word is allocated, one should generally not create tuples of arity
zero on heaps. One should instead use the literal that can be
obtained by calling erts_get_global_literal(ERTS_LIT_EMPTY_TUPLE).
*/
#define TUPLE1(t,e1) \
((t)[0] = make_arityval(1), \
(t)[1] = (e1), \
make_tuple(t))
#define TUPLE2(t,e1,e2) \
((t)[0] = make_arityval(2), \
(t)[1] = (e1), \
(t)[2] = (e2), \
make_tuple(t))
#define TUPLE3(t,e1,e2,e3) \
((t)[0] = make_arityval(3), \
(t)[1] = (e1), \
(t)[2] = (e2), \
(t)[3] = (e3), \
make_tuple(t))
#define TUPLE4(t,e1,e2,e3,e4) \
((t)[0] = make_arityval(4), \
(t)[1] = (e1), \
(t)[2] = (e2), \
(t)[3] = (e3), \
(t)[4] = (e4), \
make_tuple(t))
#define TUPLE5(t,e1,e2,e3,e4,e5) \
((t)[0] = make_arityval(5), \
(t)[1] = (e1), \
(t)[2] = (e2), \
(t)[3] = (e3), \
(t)[4] = (e4), \
(t)[5] = (e5), \
make_tuple(t))
#define TUPLE6(t,e1,e2,e3,e4,e5,e6) \
((t)[0] = make_arityval(6), \
(t)[1] = (e1), \
(t)[2] = (e2), \
(t)[3] = (e3), \
(t)[4] = (e4), \
(t)[5] = (e5), \
(t)[6] = (e6), \
make_tuple(t))
#define TUPLE7(t,e1,e2,e3,e4,e5,e6,e7) \
((t)[0] = make_arityval(7), \
(t)[1] = (e1), \
(t)[2] = (e2), \
(t)[3] = (e3), \
(t)[4] = (e4), \
(t)[5] = (e5), \
(t)[6] = (e6), \
(t)[7] = (e7), \
make_tuple(t))
#define TUPLE8(t,e1,e2,e3,e4,e5,e6,e7,e8) \
((t)[0] = make_arityval(8), \
(t)[1] = (e1), \
(t)[2] = (e2), \
(t)[3] = (e3), \
(t)[4] = (e4), \
(t)[5] = (e5), \
(t)[6] = (e6), \
(t)[7] = (e7), \
(t)[8] = (e8), \
make_tuple(t))
/* This macro get Size bits starting at low order position Pos
and adjusts the bits to the right
bits are numbered from 0 - (sizeof(Uint)*8-1) */
#define _GETBITS(X,Pos,Size) (((X) >> (Pos)) & ~(~((Uint) 0) << (Size)))
/*
* PID layout (internal pids):
*
* |3 3 2 2 2 2 2 2|2 2 2 2 1 1 1 1|1 1 1 1 1 1 | |
* |1 0 9 8 7 6 5 4|3 2 1 0 9 8 7 6|5 4 3 2 1 0 9 8|7 6 5 4 3 2 1 0|
* | | | | |
* +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
* |n n n n n n n n n n n n n n n n n n n n n n n n n n n n|0 0|1 1|
* +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
*
* n : number
*
* Very old pid layout:
*
* |3 3 2 2 2 2 2 2|2 2 2 2 1 1 1 1|1 1 1 1 1 1 | |
* |1 0 9 8 7 6 5 4|3 2 1 0 9 8 7 6|5 4 3 2 1 0 9 8|7 6 5 4 3 2 1 0|
* | | | | |
* +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
* |s s s|n n n n n n n n n n n n n n n|N N N N N N N N|c c|0 0|1 1|
* +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
*
* s : serial
* n : number
* c : creation
* N : node number
*
*/
#define _PID_SER_SIZE (_PID_DATA_SIZE - _PID_NUM_SIZE)
#define _PID_NUM_SIZE 28
#define _PID_DATA_SIZE (ERTS_SIZEOF_TERM*8 - _TAG_IMMED1_SIZE)
#define _PID_DATA_SHIFT (_TAG_IMMED1_SIZE)
#define _GET_PID_DATA(X) _GETBITS((X),_PID_DATA_SHIFT,_PID_DATA_SIZE)
#define _GET_PID_NUM(X) _GETBITS((X),0,_PID_NUM_SIZE)
#define _GET_PID_SER(X) _GETBITS((X),_PID_NUM_SIZE,_PID_SER_SIZE)
#define make_pid_data(Ser, Num) \
((Uint) ((Ser) << _PID_NUM_SIZE | (Num)))
#define is_internal_pid(x) (((x) & _TAG_IMMED1_MASK) == _TAG_IMMED1_PID)
#define is_not_internal_pid(x) (!is_internal_pid((x)))
#define _unchecked_internal_pid_node(x) erts_this_node
_ET_DECLARE_CHECKED(struct erl_node_*,internal_pid_node,Eterm)
#define internal_pid_node(x) _ET_APPLY(internal_pid_node,(x))
#define internal_pid_data_words(x) (1)
/*
* PORT layout (internal ports):
*
* |3 3 2 2 2 2 2 2|2 2 2 2 1 1 1 1|1 1 1 1 1 1 | |
* |1 0 9 8 7 6 5 4|3 2 1 0 9 8 7 6|5 4 3 2 1 0 9 8|7 6 5 4 3 2 1 0|
* | | | | |
* +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
* |n n n n n n n n n n n n n n n n n n n n n n n n n n n n|0 1|1 1|
* +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
*
* n : number
*
* Old port layout:
*
* |3 3 2 2 2 2 2 2|2 2 2 2 1 1 1 1|1 1 1 1 1 1 | |
* |1 0 9 8 7 6 5 4|3 2 1 0 9 8 7 6|5 4 3 2 1 0 9 8|7 6 5 4 3 2 1 0|
* | | | | |
* +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
* |N N N N N N N N|n n n n n n n n n n n n n n n n n n|c c|0 1|1 1|
* +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
*
* s : serial
* n : number
* c : creation
* N : node number
*
*/
#define _PORT_NUM_SIZE _PORT_DATA_SIZE
#define _PORT_DATA_SIZE (ERTS_SIZEOF_TERM*8 - _TAG_IMMED1_SIZE)
#define _PORT_DATA_SHIFT (_TAG_IMMED1_SIZE)
#define _GET_PORT_DATA(X) _GETBITS((X),_PORT_DATA_SHIFT,_PORT_DATA_SIZE)
#define _GET_PORT_NUM(X) _GETBITS((X), 0, _PORT_NUM_SIZE)
#define is_internal_port(x) (((x) & _TAG_IMMED1_MASK) == _TAG_IMMED1_PORT)
#define is_not_internal_port(x) (!is_internal_port(x))
#define _unchecked_internal_port_node(x) erts_this_node
_ET_DECLARE_CHECKED(struct erl_node_*,internal_port_node,Eterm)
#define internal_port_node(x) _ET_APPLY(internal_port_node,(x))
#define internal_port_data_words(x) (1)
/*
* Ref layout (internal references):
*
* |3 3 2 2 2 2 2 2|2 2 2 2 1 1 1 1|1 1 1 1 1 1 | |
* |1 0 9 8 7 6 5 4|3 2 1 0 9 8 7 6|5 4 3 2 1 0 9 8|7 6 5 4 3 2 1 0|
* | | | | |
* +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
* |0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 1 1|0 1 0 0|0 0| Thing
* +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
* |0 0 0 0 0 0 0 0 0 0 0 0 0 0|r r r r r r r r r r r r r r r r r r| Data 0
* +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
* |r r r r r r r r r r r r r r r r r r r r r r r r r r r r r r r r| Data 1
* +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
* |r r r r r r r r r r r r r r r r r r r r r r r r r r r r r r r r| Data 2
* +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
*
*
* r : reference number
* c : creation
*
*
* Old "heap ref" layout:
*
*
* |3 3 2 2 2 2 2 2|2 2 2 2 1 1 1 1|1 1 1 1 1 1 | |
* |1 0 9 8 7 6 5 4|3 2 1 0 9 8 7 6|5 4 3 2 1 0 9 8|7 6 5 4 3 2 1 0|
* | | | | |
* +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
* |0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 1 1|0 1 0 0|0 0| Thing
* +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
* |N N N N N N N N|0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0|c c|0 1 1 1| Head
* +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
* |0 0 0 0 0 0 0 0 0 0 0 0 0 0|r r r r r r r r r r r r r r r r r r| Word 0
* +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
* |r r r r r r r r r r r r r r r r r r r r r r r r r r r r r r r r| Word 1
* +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
* |r r r r r r r r r r r r r r r r r r r r r r r r r r r r r r r r| Word 2
* +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
*
* r : reference number
* c : creation
* N : node index
*
* Old "one-word ref" layout:
*
* |3 3 2 2 2 2 2 2|2 2 2 2 1 1 1 1|1 1 1 1 1 1 | |
* |1 0 9 8 7 6 5 4|3 2 1 0 9 8 7 6|5 4 3 2 1 0 9 8|7 6 5 4 3 2 1 0|
* | | | | |
* +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
* |N N N N N N N N|r r r r r r r r r r r r r r r r r r|c c|T T T T|
* +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
*
* r : reference number
* c : creation
* N : node index
*
*/
#define _REF_NUM_SIZE 18
/* Old maximum number of references in the system */
#define MAX_REFERENCE (1 << _REF_NUM_SIZE)
#define REF_MASK (~(~((Uint)0) << _REF_NUM_SIZE))
#define ERTS_REF_NUMBERS 3
#if defined(ARCH_64)
#define ERTS_PID_REF_NUMBERS (ERTS_REF_NUMBERS + 2)
#else
#define ERTS_PID_REF_NUMBERS (ERTS_REF_NUMBERS + 1)
#endif
#define ERTS_MAX_INTERNAL_REF_NUMBERS ERTS_PID_REF_NUMBERS
#define ERTS_MAX_REF_NUMBERS 5
#ifndef ERTS_ENDIANNESS
# error ERTS_ENDIANNESS not defined...
#endif
#if ERTS_REF_NUMBERS != 3
# error "A new reference layout for 64-bit needs to be implemented..."
#endif
struct magic_binary;
#if defined(ARCH_64)
# define ERTS_ORDINARY_REF_MARKER (~((Uint32) 0))
typedef struct {
Eterm header;
#if ERTS_ENDIANNESS <= 0
Uint32 marker;
#endif
Uint32 num[ERTS_REF_NUMBERS];
#if ERTS_ENDIANNESS > 0
Uint32 marker;
#endif
} ErtsORefThing;
typedef struct {
Eterm header;
#if ERTS_ENDIANNESS <= 0
Uint32 marker;
#endif
Uint32 num[ERTS_PID_REF_NUMBERS];
#if ERTS_ENDIANNESS > 0
Uint32 marker;
#endif
} ErtsPRefThing;
typedef struct {
Eterm header;
struct magic_binary *mb;
struct erl_off_heap_header* next;
#if !ERTS_ENDIANNESS
Uint32 num[ERTS_REF_NUMBERS];
Uint32 marker;
#endif
} ErtsMRefThing;
/*
* Ordinary ref layout on a 64-bit little endian machine:
*
* 63 31 0
* +--------------+--------------+
* | Thing word |
* +--------------+--------------+
* | Data 0 | 0xffffffff |
* +--------------+--------------+
* | Data 2 | Data 1 |
* +--------------+--------------+
*
* Ordinary ref layout on a 64-bit big endian machine:
*
* 63 31 0
* +--------------+--------------+
* | Thing word |
* +--------------+--------------+
* | Data 0 | Data 1 |
* +--------------+--------------+
* | Data 2 | 0xffffffff |
* +--------------+--------------+
*
* Magic Ref layout on a 64-bit machine:
*
* 63 31 0
* +--------------+--------------+
* | Thing word |
* +--------------+--------------+
* | Magic Binary Pointer |
* +--------------+--------------+
* | Next Off Heap Pointer |
* +--------------+--------------+
*
* Both pointers in the magic ref are 64-bit aligned. That is,
* least significant bits are zero. The marker 32-bit word of
* an ordinary ref is placed over the least significant bits
* of one of the pointers. That is, we can distinguish between
* magic and ordinary ref by looking at the marker field.
* Pid refs are larger than ordinary and magic refs, so we
* can distinguish pid refs from the other by the header word.
*/
#define write_ref_thing(Hp, R0, R1, R2) \
do { \
((ErtsORefThing *) (Hp))->header = ERTS_REF_THING_HEADER; \
((ErtsORefThing *) (Hp))->marker = ERTS_ORDINARY_REF_MARKER; \
((ErtsORefThing *) (Hp))->num[0] = (R0); \
((ErtsORefThing *) (Hp))->num[1] = (R1); \
((ErtsORefThing *) (Hp))->num[2] = (R2); \
} while (0)
#if ERTS_ENDIANNESS
/* Known big or little endian */
#define write_magic_ref_thing(Hp, Ohp, Binp) \
do { \
((ErtsMRefThing *) (Hp))->header = ERTS_REF_THING_HEADER; \
((ErtsMRefThing *) (Hp))->mb = (Binp); \
((ErtsMRefThing *) (Hp))->next = (Ohp)->first; \
(Ohp)->first = (struct erl_off_heap_header*) (Hp); \
ASSERT(erts_is_ref_numbers_magic((Binp)->refn)); \
} while (0)
#else /* !ERTS_ENDIANNESS */
#define write_magic_ref_thing(Hp, Ohp, Binp) \
do { \
((ErtsMRefThing *) (Hp))->header = ERTS_MAGIC_REF_THING_HEADER; \
((ErtsMRefThing *) (Hp))->mb = (Binp); \
((ErtsMRefThing *) (Hp))->next = (Ohp)->first; \
(Ohp)->first = (struct erl_off_heap_header*) (Hp); \
((ErtsMRefThing *) (Hp))->marker = 0; \
((ErtsMRefThing *) (Hp))->num[0] = (Binp)->refn[0]; \
((ErtsMRefThing *) (Hp))->num[1] = (Binp)->refn[1]; \
((ErtsMRefThing *) (Hp))->num[2] = (Binp)->refn[2]; \
ASSERT(erts_is_ref_numbers_magic((Binp)->refn)); \
} while (0)
#endif /* !ERTS_ENDIANNESS */
#define write_pid_ref_thing(Hp, R0, R1, R2, PID) \
do { \
((ErtsPRefThing *) (Hp))->header = ERTS_PID_REF_THING_HEADER; \
((ErtsPRefThing *) (Hp))->marker = ERTS_ORDINARY_REF_MARKER; \
((ErtsPRefThing *) (Hp))->num[0] = (R0); \
((ErtsPRefThing *) (Hp))->num[1] = (R1); \
((ErtsPRefThing *) (Hp))->num[2] = (R2); \
((ErtsPRefThing *) (Hp))->num[3] = (Uint32) ((PID) & 0xffffffff); \
((ErtsPRefThing *) (Hp))->num[4] = (Uint32) (((PID) >> 32) \
& 0xffffffff); \
} while (0)
#define pid_ref_thing_get_pid(Hp) \
(ASSERT(is_pid_ref_thing((Hp))), \
(((Eterm) ((ErtsPRefThing *) (Hp))->num[3]) \
| ((((Eterm) ((ErtsPRefThing *) (Hp))->num[4]) << 32))))
#else /* ARCH_32 */
typedef struct {
Eterm header;
Uint32 num[ERTS_REF_NUMBERS];
} ErtsORefThing;
typedef struct {
Eterm header;
Uint32 num[ERTS_PID_REF_NUMBERS];
} ErtsPRefThing;
typedef struct {
Eterm header;
struct magic_binary *mb;
struct erl_off_heap_header* next;
} ErtsMRefThing;
#define write_ref_thing(Hp, R0, R1, R2) \
do { \
((ErtsORefThing *) (Hp))->header = ERTS_REF_THING_HEADER; \
((ErtsORefThing *) (Hp))->num[0] = (R0); \
((ErtsORefThing *) (Hp))->num[1] = (R1); \
((ErtsORefThing *) (Hp))->num[2] = (R2); \
} while (0)
#define write_magic_ref_thing(Hp, Ohp, Binp) \
do { \
((ErtsMRefThing *) (Hp))->header = ERTS_MAGIC_REF_THING_HEADER; \
((ErtsMRefThing *) (Hp))->mb = (Binp); \
((ErtsMRefThing *) (Hp))->next = (Ohp)->first; \
(Ohp)->first = (struct erl_off_heap_header*) (Hp); \
ASSERT(erts_is_ref_numbers_magic((Binp)->refn)); \
} while (0)
#define write_pid_ref_thing(Hp, R0, R1, R2, PID) \
do { \
((ErtsPRefThing *) (Hp))->header = ERTS_PID_REF_THING_HEADER; \
((ErtsPRefThing *) (Hp))->num[0] = (R0); \
((ErtsPRefThing *) (Hp))->num[1] = (R1); \
((ErtsPRefThing *) (Hp))->num[2] = (R2); \
((ErtsPRefThing *) (Hp))->num[3] = (Uint32) (PID); \
} while (0)
#define pid_ref_thing_get_pid(Hp) \
(ASSERT(is_pid_ref_thing((Hp))), \
((Eterm) ((ErtsPRefThing *) (Hp))->num[3]))
#endif /* ARCH_32 */
typedef union {
ErtsMRefThing m;
ErtsORefThing o;
ErtsPRefThing p;
} ErtsRefThing;
/* for copy sharing */
#define BOXED_VISITED_MASK ((Eterm) 3)
#define BOXED_VISITED ((Eterm) 1)
#define BOXED_SHARED_UNPROCESSED ((Eterm) 2)
#define BOXED_SHARED_PROCESSED ((Eterm) 3)
#define ERTS_REF_THING_SIZE (sizeof(ErtsORefThing)/sizeof(Uint))
#define ERTS_PID_REF_THING_SIZE (sizeof(ErtsPRefThing)/sizeof(Uint))
#define ERTS_MAGIC_REF_THING_SIZE (sizeof(ErtsMRefThing)/sizeof(Uint))
#define ERTS_MAX_INTERNAL_REF_SIZE (sizeof(ErtsRefThing)/sizeof(Uint))
#define make_ref_thing_header(Words) \
_make_header((Words)-1,_TAG_HEADER_REF)
#define ERTS_REF_THING_HEADER _make_header(ERTS_REF_THING_SIZE-1,_TAG_HEADER_REF)
#define ERTS_PID_REF_THING_HEADER _make_header(ERTS_PID_REF_THING_SIZE-1,_TAG_HEADER_REF)
# define is_ref_thing_header(x) \
(((x) & _TAG_HEADER_MASK) == _TAG_HEADER_REF)
#if defined(ARCH_64) && ERTS_ENDIANNESS
/* Ordinary and magic refs of same size, but pid ref larger */
# undef ERTS_MAGIC_REF_THING_HEADER
#define is_pid_ref_thing(x) \
(*((Eterm *)(x)) == ERTS_PID_REF_THING_HEADER)
#define is_ordinary_ref_thing(x) \
((*((Eterm *)(x)) == ERTS_REF_THING_HEADER) \
&& (((ErtsRefThing *) (x))->o.marker == ERTS_ORDINARY_REF_MARKER))
/* the _with_hdr variant usable when header word may be broken (copy_shared) */
#define is_magic_ref_thing_with_hdr(PTR,HDR) \
(((HDR) == ERTS_REF_THING_HEADER) \
&& (((ErtsRefThing *) (PTR))->o.marker != ERTS_ORDINARY_REF_MARKER))
#else /* Ordinary and magic references of different sizes... */
# define ERTS_MAGIC_REF_THING_HEADER \
_make_header(ERTS_MAGIC_REF_THING_SIZE-1,_TAG_HEADER_REF)