-
Notifications
You must be signed in to change notification settings - Fork 574
/
Copy pathcop.h
1462 lines (1216 loc) · 57.2 KB
/
cop.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
/* cop.h
*
* Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000,
* 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009 by Larry Wall and others
*
* You may distribute under the terms of either the GNU General Public
* License or the Artistic License, as specified in the README file.
*
* Control ops (cops) are one of the two ops OP_NEXTSTATE and OP_DBSTATE,
* that (loosely speaking) are statement separators.
* They hold information important for lexical state and error reporting.
* At run time, PL_curcop is set to point to the most recently executed cop,
* and thus can be used to determine our current state.
*/
/* A jmpenv packages the state required to perform a proper non-local jump.
* Note that there is a PL_start_env initialized when perl starts, and
* PL_top_env points to this initially, so PL_top_env should always be
* non-null.
*
* Existence of a non-null PL_top_env->je_prev implies it is valid to call
* longjmp() at that runlevel (we make sure PL_start_env.je_prev is always
* null to ensure this).
*
* je_mustcatch, when set at any runlevel to TRUE, means eval ops must
* establish a local jmpenv to handle exception traps. Care must be taken
* to restore the previous value of je_mustcatch before exiting the
* stack frame iff JMPENV_PUSH was not called in that stack frame.
* GSAR 97-03-27
*/
MSVC_DIAG_IGNORE(4324)
struct jmpenv {
struct jmpenv * je_prev;
Sigjmp_buf je_buf; /* uninit if je_prev is NULL */
int je_ret; /* last exception thrown */
bool je_mustcatch; /* longjmp()s must be caught locally */
U16 je_old_delaymagic; /* saved PL_delaymagic */
SSize_t je_old_stack_hwm;
};
MSVC_DIAG_RESTORE
typedef struct jmpenv JMPENV;
#if defined PERL_USE_HWM
# define JE_OLD_STACK_HWM_zero PL_start_env.je_old_stack_hwm = 0
# define JE_OLD_STACK_HWM_save(je) \
(je).je_old_stack_hwm = PL_curstackinfo->si_stack_hwm
# define JE_OLD_STACK_HWM_restore(je) \
if (PL_curstackinfo->si_stack_hwm < (je).je_old_stack_hwm) \
PL_curstackinfo->si_stack_hwm = (je).je_old_stack_hwm
#else
# define JE_OLD_STACK_HWM_zero NOOP
# define JE_OLD_STACK_HWM_save(je) NOOP
# define JE_OLD_STACK_HWM_restore(je) NOOP
#endif
/*
* How to build the first jmpenv.
*
* top_env needs to be non-zero. It points to an area
* in which longjmp() stuff is stored, as C callstack
* info there at least is thread specific this has to
* be per-thread. Otherwise a 'die' in a thread gives
* that thread the C stack of last thread to do an eval {}!
*/
#define JMPENV_BOOTSTRAP \
STMT_START { \
PERL_POISON_EXPR(PoisonNew(&PL_start_env, 1, JMPENV));\
PL_top_env = &PL_start_env; \
PL_start_env.je_prev = NULL; \
PL_start_env.je_ret = -1; \
PL_start_env.je_mustcatch = TRUE; \
PL_start_env.je_old_delaymagic = 0; \
JE_OLD_STACK_HWM_zero; \
} STMT_END
/*
* PERL_FLEXIBLE_EXCEPTIONS
*
* All the flexible exceptions code has been removed.
* See the following threads for details:
*
* Message-Id: [email protected]
* https://www.nntp.perl.org/group/perl.perl5.porters/2004/07/msg93041.html
*
* Joshua's original patches (which weren't applied) and discussion:
*
* http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/1998-02/msg01396.html
* http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/1998-02/msg01489.html
* http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/1998-02/msg01491.html
* http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/1998-02/msg01608.html
* http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/1998-02/msg02144.html
* http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/1998-02/msg02998.html
*
* Chip's reworked patch and discussion:
*
* http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/1999-03/msg00520.html
*
* The flaw in these patches (which went unnoticed at the time) was
* that they moved some code that could potentially die() out of the
* region protected by the setjmp()s. This caused exceptions within
* END blocks and such to not be handled by the correct setjmp().
*
* The original patches that introduces flexible exceptions were:
*
* https://github.com/Perl/perl5/commit/312caa8e97f1c7ee342a9895c2f0e749625b4929
* https://github.com/Perl/perl5/commit/14dd3ad8c9bf82cf09798a22cc89a9862dfd6d1a
*
*/
#define dJMPENV JMPENV cur_env
#define JMPENV_PUSH(v) \
STMT_START { \
DEBUG_l({ \
int i = 0; \
JMPENV *p = PL_top_env; \
while (p) { i++; p = p->je_prev; } \
Perl_deb(aTHX_ "JMPENV_PUSH pre level=%d in %s at %s:%d\n", \
i, SAFE_FUNCTION__, __FILE__, __LINE__); \
}); \
cur_env.je_prev = PL_top_env; \
JE_OLD_STACK_HWM_save(cur_env); \
/* setjmp() is callable in limited contexts which does not */ \
/* include assignment, so switch() instead */ \
switch (PerlProc_setjmp(cur_env.je_buf, SCOPE_SAVES_SIGNAL_MASK)) { \
case 0: cur_env.je_ret = 0; break; \
case 1: cur_env.je_ret = 1; break; \
case 2: cur_env.je_ret = 2; break; \
case 3: cur_env.je_ret = 3; break; \
default: Perl_croak(aTHX_ "panic: unexpected setjmp() result\n"); \
} \
JE_OLD_STACK_HWM_restore(cur_env); \
PL_top_env = &cur_env; \
cur_env.je_mustcatch = FALSE; \
cur_env.je_old_delaymagic = PL_delaymagic; \
DEBUG_l({ \
int i = 0; \
JMPENV *p = PL_top_env; \
while (p) { i++; p = p->je_prev; } \
Perl_deb(aTHX_ "JMPENV_PUSH level=%d ret=%d in %s at %s:%d\n", \
i, cur_env.je_ret, SAFE_FUNCTION__, __FILE__, __LINE__); \
}); \
(v) = cur_env.je_ret; \
} STMT_END
#define JMPENV_POP \
STMT_START { \
DEBUG_l({ \
int i = -1; JMPENV *p = PL_top_env; \
while (p) { i++; p = p->je_prev; } \
Perl_deb(aTHX_ "JMPENV_POP level=%d in %s at %s:%d\n", \
i, SAFE_FUNCTION__, __FILE__, __LINE__);}) \
assert(PL_top_env == &cur_env); \
PL_delaymagic = cur_env.je_old_delaymagic; \
PL_top_env = cur_env.je_prev; \
} STMT_END
#define JMPENV_JUMP(v) \
STMT_START { \
DEBUG_l({ \
int i = -1; JMPENV *p = PL_top_env; \
while (p) { i++; p = p->je_prev; } \
Perl_deb(aTHX_ "JMPENV_JUMP(%d) level=%d in %s at %s:%d\n", \
(int)(v), i, SAFE_FUNCTION__, __FILE__, __LINE__);}) \
if (PL_top_env->je_prev) { \
assert((v) >= 0 && (v) <= 3); \
PerlProc_longjmp(PL_top_env->je_buf, (v)); \
} \
if ((v) == 2) \
PerlProc_exit(STATUS_EXIT); \
PerlIO_printf(PerlIO_stderr(), "panic: top_env, v=%d\n", (int)(v)); \
PerlProc_exit(1); \
} STMT_END
#define CATCH_GET (PL_top_env->je_mustcatch)
#define CATCH_SET(v) \
STMT_START { \
DEBUG_l( \
Perl_deb(aTHX_ \
"JUMPLEVEL set catch %d => %d (for %p) in %s at %s:%d\n", \
PL_top_env->je_mustcatch, (v), (void*)PL_top_env, \
SAFE_FUNCTION__, __FILE__, __LINE__);) \
PL_top_env->je_mustcatch = (v); \
} STMT_END
/*
=for apidoc_section $COP
*/
typedef struct refcounted_he COPHH;
#define COPHH_KEY_UTF8 REFCOUNTED_HE_KEY_UTF8
#define COPHH_EXISTS REFCOUNTED_HE_EXISTS
/*
=for apidoc Amx|SV *|cophh_fetch_pv |const COPHH *cophh|const char *key |U32 hash|U32 flags
=for apidoc_item|SV *|cophh_fetch_pvn|const COPHH *cophh|const char *key|STRLEN keylen|U32 hash|U32 flags
=for apidoc_item|SV *|cophh_fetch_pvs|const COPHH *cophh| "key" |U32 flags
=for apidoc_item|SV *|cophh_fetch_sv |const COPHH *cophh| SV *key |U32 hash|U32 flags
These look up the entry in the cop hints hash C<cophh> with the key specified by
C<key> (and C<keylen> in the C<pvn> form), returning that value as a mortal
scalar copy, or C<&PL_sv_placeholder> if there is no value associated with the
key.
The forms differ in how the key is specified.
In the plain C<pv> form, the key is a C language NUL-terminated string.
In the C<pvs> form, the key is a C language string literal.
In the C<pvn> form, an additional parameter, C<keylen>, specifies the length of
the string, which hence, may contain embedded-NUL characters.
In the C<sv> form, C<*key> is an SV, and the key is the PV extracted from that.
using C<L</SvPV_const>>.
C<hash> is a precomputed hash of the key string, or zero if it has not been
precomputed. This parameter is omitted from the C<pvs> form, as it is computed
automatically at compile time.
The only flag currently used from the C<flags> parameter is C<COPHH_KEY_UTF8>.
It is illegal to set this in the C<sv> form. In the C<pv*> forms, it specifies
whether the key octets are interpreted as UTF-8 (if set) or as Latin-1 (if
cleared). The C<sv> form uses the underlying SV to determine the UTF-8ness of
the octets.
=for apidoc Amnh||COPHH_KEY_UTF8
=cut
*/
#define cophh_fetch_pvn(cophh, key, keylen, hash, flags) \
Perl_refcounted_he_fetch_pvn(aTHX_ cophh, key, keylen, hash, \
(flags & COPHH_KEY_UTF8))
#define cophh_fetch_pvs(cophh, key, flags) \
Perl_refcounted_he_fetch_pvn(aTHX_ cophh, STR_WITH_LEN(key), 0, \
(flags & COPHH_KEY_UTF8))
#define cophh_fetch_pv(cophh, key, hash, flags) \
Perl_refcounted_he_fetch_pv(aTHX_ cophh, key, hash, \
(flags & COPHH_KEY_UTF8))
#define cophh_fetch_sv(cophh, key, hash, flags) \
Perl_refcounted_he_fetch_sv(aTHX_ cophh, key, hash, \
(flags & COPHH_KEY_UTF8))
/*
=for apidoc Amx|bool|cophh_exists_pvn|const COPHH *cophh|const char *key|STRLEN keylen|U32 hash|U32 flags
These look up the hint entry in the cop C<cop> with the key specified by
C<key> (and C<keylen> in the C<pvn> form), returning true if a value exists,
and false otherwise.
The forms differ in how the key is specified.
In the plain C<pv> form, the key is a C language NUL-terminated string.
In the C<pvs> form, the key is a C language string literal.
In the C<pvn> form, an additional parameter, C<keylen>, specifies the length of
the string, which hence, may contain embedded-NUL characters.
In the C<sv> form, C<*key> is an SV, and the key is the PV extracted from that.
using C<L</SvPV_const>>.
C<hash> is a precomputed hash of the key string, or zero if it has not been
precomputed. This parameter is omitted from the C<pvs> form, as it is computed
automatically at compile time.
The only flag currently used from the C<flags> parameter is C<COPHH_KEY_UTF8>.
It is illegal to set this in the C<sv> form. In the C<pv*> forms, it specifies
whether the key octets are interpreted as UTF-8 (if set) or as Latin-1 (if
cleared). The C<sv> form uses the underlying SV to determine the UTF-8ness of
the octets.
=cut
*/
#define cophh_exists_pvn(cophh, key, keylen, hash, flags) \
cBOOL(Perl_refcounted_he_fetch_pvn(aTHX_ cophh, key, keylen, hash, flags | COPHH_EXISTS))
#define cophh_exists_pvs(cophh, key, flags) \
cBOOL(Perl_refcounted_he_fetch_pvn(aTHX_ cophh, STR_WITH_LEN(key), 0, flags | COPHH_EXISTS))
#define cophh_exists_pv(cophh, key, hash, flags) \
cBOOL(Perl_refcounted_he_fetch_pv(aTHX_ cophh, key, hash, flags | COPHH_EXISTS))
#define cophh_exists_sv(cophh, key, hash, flags) \
cBOOL(Perl_refcounted_he_fetch_sv(aTHX_ cophh, key, hash, flags | COPHH_EXISTS))
/*
=for apidoc Amx|HV *|cophh_2hv|const COPHH *cophh|U32 flags
Generates and returns a standard Perl hash representing the full set of
key/value pairs in the cop hints hash C<cophh>. C<flags> is currently
unused and must be zero.
=cut
*/
#define cophh_2hv(cophh, flags) \
Perl_refcounted_he_chain_2hv(aTHX_ cophh, flags)
/*
=for apidoc Amx|COPHH *|cophh_copy|COPHH *cophh
Make and return a complete copy of the cop hints hash C<cophh>.
=cut
*/
#define cophh_copy(cophh) Perl_refcounted_he_inc(aTHX_ cophh)
/*
=for apidoc Amx|void|cophh_free|COPHH *cophh
Discard the cop hints hash C<cophh>, freeing all resources associated
with it.
=cut
*/
#define cophh_free(cophh) Perl_refcounted_he_free(aTHX_ cophh)
/*
=for apidoc Amx|COPHH *|cophh_new_empty
Generate and return a fresh cop hints hash containing no entries.
=cut
*/
#define cophh_new_empty() ((COPHH *)NULL)
/*
=for apidoc Amx|COPHH *|cophh_store_pv |COPHH *cophh|const char *key |U32 hash|SV *value|U32 flags
=for apidoc_item|COPHH *|cophh_store_pvn|COPHH *cophh|const char *key|STRLEN keylen|U32 hash|SV *value|U32 flags
=for apidoc_item|COPHH *|cophh_store_pvs|COPHH *cophh| "key" |SV *value|U32 flags
=for apidoc_item|COPHH *|cophh_store_sv |COPHH *cophh| SV *key |U32 hash|SV *value|U32 flags
These store a value, associated with a key, in the cop hints hash C<cophh>,
and return the modified hash. The returned hash pointer is in general
not the same as the hash pointer that was passed in. The input hash is
consumed by the function, and the pointer to it must not be subsequently
used. Use L</cophh_copy> if you need both hashes.
C<value> is the scalar value to store for this key. C<value> is copied
by these functions, which thus do not take ownership of any reference
to it, and hence later changes to the scalar will not be reflected in the value
visible in the cop hints hash. Complex types of scalar will not be stored with
referential integrity, but will be coerced to strings.
The forms differ in how the key is specified. In all forms, the key is pointed
to by C<key>.
In the plain C<pv> form, the key is a C language NUL-terminated string.
In the C<pvs> form, the key is a C language string literal.
In the C<pvn> form, an additional parameter, C<keylen>, specifies the length of
the string, which hence, may contain embedded-NUL characters.
In the C<sv> form, C<*key> is an SV, and the key is the PV extracted from that.
using C<L</SvPV_const>>.
C<hash> is a precomputed hash of the key string, or zero if it has not been
precomputed. This parameter is omitted from the C<pvs> form, as it is computed
automatically at compile time.
The only flag currently used from the C<flags> parameter is C<COPHH_KEY_UTF8>.
It is illegal to set this in the C<sv> form. In the C<pv*> forms, it specifies
whether the key octets are interpreted as UTF-8 (if set) or as Latin-1 (if
cleared). The C<sv> form uses the underlying SV to determine the UTF-8ness of
the octets.
=cut
*/
#define cophh_store_pvn(cophh, key, keylen, hash, value, flags) \
Perl_refcounted_he_new_pvn(aTHX_ cophh, key, keylen, hash, value, flags)
#define cophh_store_pvs(cophh, key, value, flags) \
Perl_refcounted_he_new_pvn(aTHX_ cophh, STR_WITH_LEN(key), 0, value, flags)
#define cophh_store_pv(cophh, key, hash, value, flags) \
Perl_refcounted_he_new_pv(aTHX_ cophh, key, hash, value, flags)
#define cophh_store_sv(cophh, key, hash, value, flags) \
Perl_refcounted_he_new_sv(aTHX_ cophh, key, hash, value, flags)
/*
=for apidoc Amx|COPHH *|cophh_delete_pv |COPHH *cophh|const char *key |U32 hash|U32 flags
=for apidoc_item|COPHH *|cophh_delete_pvn|COPHH *cophh|const char *key|STRLEN keylen|U32 hash|U32 flags
=for apidoc_item|COPHH *|cophh_delete_pvs|COPHH *cophh| "key" |U32 flags
=for apidoc_item|COPHH *|cophh_delete_sv |COPHH *cophh| SV *key |U32 hash|U32 flags
These delete a key and its associated value from the cop hints hash C<cophh>,
and return the modified hash. The returned hash pointer is in general
not the same as the hash pointer that was passed in. The input hash is
consumed by the function, and the pointer to it must not be subsequently
used. Use L</cophh_copy> if you need both hashes.
The forms differ in how the key is specified. In all forms, the key is pointed
to by C<key>.
In the plain C<pv> form, the key is a C language NUL-terminated string.
In the C<pvs> form, the key is a C language string literal.
In the C<pvn> form, an additional parameter, C<keylen>, specifies the length of
the string, which hence, may contain embedded-NUL characters.
In the C<sv> form, C<*key> is an SV, and the key is the PV extracted from that.
using C<L</SvPV_const>>.
C<hash> is a precomputed hash of the key string, or zero if it has not been
precomputed. This parameter is omitted from the C<pvs> form, as it is computed
automatically at compile time.
The only flag currently used from the C<flags> parameter is C<COPHH_KEY_UTF8>.
It is illegal to set this in the C<sv> form. In the C<pv*> forms, it specifies
whether the key octets are interpreted as UTF-8 (if set) or as Latin-1 (if
cleared). The C<sv> form uses the underlying SV to determine the UTF-8ness of
the octets.
=cut
*/
#define cophh_delete_pvn(cophh, key, keylen, hash, flags) \
Perl_refcounted_he_new_pvn(aTHX_ cophh, key, keylen, hash, \
(SV *)NULL, flags)
#define cophh_delete_pvs(cophh, key, flags) \
Perl_refcounted_he_new_pvn(aTHX_ cophh, STR_WITH_LEN(key), 0, \
(SV *)NULL, flags)
#define cophh_delete_pv(cophh, key, hash, flags) \
Perl_refcounted_he_new_pv(aTHX_ cophh, key, hash, (SV *)NULL, flags)
#define cophh_delete_sv(cophh, key, hash, flags) \
Perl_refcounted_he_new_sv(aTHX_ cophh, key, hash, (SV *)NULL, flags)
#include "mydtrace.h"
/* keep in sync with feature.h (which will complain if this is out of sync)
*/
#define COP_FEATURE_SIZE 1
/* make this a struct so we can copy the feature bits with assignment */
struct cop_feature_t {
U32 bits[COP_FEATURE_SIZE];
};
struct cop {
BASEOP
/* On LP64 putting this here takes advantage of the fact that BASEOP isn't
an exact multiple of 8 bytes to save structure padding. */
line_t cop_line; /* line # of this command */
/* label for this construct is now stored in cop_hints_hash */
#ifdef USE_ITHREADS
PADOFFSET cop_stashoff; /* offset into PL_stashpad, for the
package the line was compiled in */
char * cop_file; /* rcpv containing name of file this command is from */
#else
HV * cop_stash; /* package line was compiled in */
GV * cop_filegv; /* name of GV file this command is from */
#endif
U32 cop_hints; /* hints bits from pragmata */
U32 cop_seq; /* parse sequence number */
char * cop_warnings; /* Lexical warnings bitmask vector.
Refcounted shared copy of ${^WARNING_BITS}.
This pointer either points at one of the
magic values for warnings, or it points
at a buffer constructed with rcpv_new().
Use the RCPV_LEN() macro to get its length.
*/
/* compile time state of %^H. See the comment in op.c for how this is
used to recreate a hash to return from caller. */
COPHH * cop_hints_hash;
/*
How these flags are stored is subject to change without
notice. Use the macros to test for features.
*/
struct cop_feature_t cop_features;
};
/*
=for apidoc Am|const char *|CopFILE|const COP * c
Returns the name of the file associated with the C<COP> C<c>
=for apidoc Am|const char *|CopFILE_LEN|const COP * c
Returns the length of the file associated with the C<COP> C<c>
=for apidoc Am|line_t|CopLINE|const COP * c
Returns the line number in the source code associated with the C<COP> C<c>
=for apidoc Am|AV *|CopFILEAV|const COP * c
Returns the AV associated with the C<COP> C<c>, creating it if necessary.
=for apidoc Am|AV *|CopFILEAVn|const COP * c
Returns the AV associated with the C<COP> C<c>, returning NULL if it
doesn't already exist.
=for apidoc Am|SV *|CopFILESV|const COP * c
Returns the SV associated with the C<COP> C<c>
=for apidoc Am|void|CopFILE_set|COP * c|const char * pv
=for apidoc_item|void|CopFILE_setn|COP * c|const char * pv|STRLEN len
These each make C<pv> the name of the file associated with the C<COP> C<c>.
In the plain C<CopFILE_set> form, C<pv> is a C language NUL-terminated string.
In C<CopFILE_setn>, C<len> is the length of C<pv>, which hence may contain
embedded NUL characters.
=for apidoc Am|void|CopFILE_copy|COP * dst|COP * src
Efficiently copies the cop file name from one COP to another. Wraps
the required logic to do a refcounted copy under threads or not.
=for apidoc Am|void|CopFILE_free|COP * c
Frees the file data in a cop. Under the hood this is a refcounting
operation.
=for apidoc Am|GV *|CopFILEGV|const COP * c
Returns the GV associated with the C<COP> C<c>
=for apidoc CopFILEGV_set
Available only on unthreaded perls. Makes C<pv> the name of the file
associated with the C<COP> C<c>
=for apidoc Am|HV *|CopSTASH|const COP * c
Returns the stash associated with C<c>.
=for apidoc Am|bool|CopSTASH_eq|const COP * c|const HV * hv
Returns a boolean as to whether or not C<hv> is the stash associated with C<c>.
=for apidoc Am|bool|CopSTASH_set|COP * c|HV * hv
Set the stash associated with C<c> to C<hv>.
=for apidoc Am|char *|CopSTASHPV|const COP * c
Returns the package name of the stash associated with C<c>, or C<NULL> if no
associated stash
=for apidoc Am|void|CopSTASHPV_set|COP * c|const char * pv
Set the package name of the stash associated with C<c>, to the NUL-terminated C
string C<p>, creating the package if necessary.
=cut
*/
/*
=for apidoc Am|RCPV *|RCPVx|char *pv
Returns the RCPV structure (struct rcpv) for a refcounted
string pv created with C<rcpv_new()>.
No checks are performed to ensure that C<pv> was actually allocated
with C<rcpv_new()>, it is the callers responsibility to ensure that
this is the case.
=for apidoc Am|RCPV *|RCPV_REFCOUNT|char *pv
Returns the refcount for a pv created with C<rcpv_new()>.
No checks are performed to ensure that C<pv> was actually allocated
with C<rcpv_new()>, it is the callers responsibility to ensure that
this is the case.
=for apidoc Am|RCPV *|RCPV_REFCNT_inc|char *pv
Increments the refcount for a C<char *> pointer which was created
with a call to C<rcpv_new()>. Same as calling rcpv_copy().
No checks are performed to ensure that C<pv> was actually allocated
with C<rcpv_new()>, it is the callers responsibility to ensure that
this is the case.
=for apidoc Am|RCPV *|RCPV_REFCNT_dec|char *pv
Decrements the refcount for a C<char *> pointer which was created
with a call to C<rcpv_new()>. Same as calling rcpv_free().
No checks are performed to ensure that C<pv> was actually allocated
with C<rcpv_new()>, it is the callers responsibility to ensure that
this is the case.
=for apidoc Am|RCPV *|RCPV_LEN|char *pv
Returns the length of a pv created with C<rcpv_new()>.
Note that this reflects the length of the string from the callers
point of view, it does not include the mandatory null which is
always injected at the end of the string by rcpv_new().
No checks are performed to ensure that C<pv> was actually allocated
with C<rcpv_new()>, it is the callers responsibility to ensure that
this is the case.
=cut
*/
struct rcpv {
STRLEN refcount; /* UV would mean a 64 refcnt on
32 bit builds with -Duse64bitint */
STRLEN len; /* length of string including mandatory
null byte at end */
char pv[1];
};
typedef struct rcpv RCPV;
#define RCPVf_USE_STRLEN (1 << 0)
#define RCPVf_NO_COPY (1 << 1)
#define RCPVf_ALLOW_EMPTY (1 << 2)
#define RCPVx(pv_arg) ((RCPV *)((pv_arg) - STRUCT_OFFSET(struct rcpv, pv)))
#define RCPV_REFCOUNT(pv) (RCPVx(pv)->refcount)
#define RCPV_LEN(pv) (RCPVx(pv)->len-1) /* len always includes space for a null */
#define RCPV_REFCNT_inc(pv) rcpv_copy(pv)
#define RCPV_REFCNT_dec(pv) rcpv_free(pv)
#ifdef USE_ITHREADS
# define CopFILE(c) ((c)->cop_file)
# define CopFILE_LEN(c) (CopFILE(c) ? RCPV_LEN(CopFILE(c)) : 0)
# define CopFILEGV(c) (CopFILE(c) \
? gv_fetchfile(CopFILE(c)) : NULL)
# define CopFILE_set_x(c,pv) ((c)->cop_file = rcpv_new((pv),0,RCPVf_USE_STRLEN))
# define CopFILE_setn_x(c,pv,l) ((c)->cop_file = rcpv_new((pv),(l),0))
# define CopFILE_free_x(c) ((c)->cop_file = rcpv_free((c)->cop_file))
# define CopFILE_copy_x(dst,src) ((dst)->cop_file = rcpv_copy((src)->cop_file))
/* change condition to 1 && to enable this debugging */
# define CopFILE_debug(c,t,rk) \
if (0 && (c)->cop_file) \
PerlIO_printf(Perl_debug_log, \
"%-14s THX:%p OP:%p PV:%p rc: " \
"%6zu fn: '%.*s' at %s line %d\n", \
(t), aTHX, (c), (c)->cop_file, \
RCPV_REFCOUNT((c)->cop_file)-rk, \
(int)RCPV_LEN((c)->cop_file), \
(c)->cop_file,__FILE__,__LINE__) \
# define CopFILE_set(c,pv) \
STMT_START { \
CopFILE_set_x(c,pv); \
CopFILE_debug(c,"CopFILE_set", 0); \
} STMT_END
# define CopFILE_setn(c,pv,l) \
STMT_START { \
CopFILE_setn_x(c,pv,l); \
CopFILE_debug(c,"CopFILE_setn", 0); \
} STMT_END
# define CopFILE_copy(dst,src) \
STMT_START { \
CopFILE_copy_x((dst),(src)); \
CopFILE_debug((dst),"CopFILE_copy", 0); \
} STMT_END
# define CopFILE_free(c) \
STMT_START { \
CopFILE_debug((c),"CopFILE_free", 1); \
CopFILE_free_x(c); \
} STMT_END
# define CopFILESV(c) (CopFILE(c) \
? GvSV(gv_fetchfile(CopFILE(c))) : NULL)
# define CopFILEAV(c) (CopFILE(c) \
? GvAV(gv_fetchfile(CopFILE(c))) : NULL)
# define CopFILEAVx(c) (assert_(CopFILE(c)) \
GvAV(gv_fetchfile(CopFILE(c))))
# define CopFILEAVn(c) (cop_file_avn(c))
# define CopSTASH(c) PL_stashpad[(c)->cop_stashoff]
# define CopSTASH_set(c,hv) ((c)->cop_stashoff = (hv) \
? alloccopstash(hv) \
: 0)
#else /* Above: yes threads; Below no threads */
# define CopFILEGV(c) ((c)->cop_filegv)
# define CopFILEGV_set(c,gv) ((c)->cop_filegv = (GV*)SvREFCNT_inc(gv))
# define CopFILE_set(c,pv) CopFILEGV_set((c), gv_fetchfile(pv))
# define CopFILE_copy(dst,src) CopFILEGV_set((dst),CopFILEGV(src))
# define CopFILE_setn(c,pv,l) CopFILEGV_set((c), gv_fetchfile_flags((pv),(l),0))
# define CopFILESV(c) (CopFILEGV(c) ? GvSV(CopFILEGV(c)) : NULL)
# define CopFILEAV(c) (CopFILEGV(c) ? GvAV(CopFILEGV(c)) : NULL)
# ifdef DEBUGGING
# define CopFILEAVx(c) (assert(CopFILEGV(c)), GvAV(CopFILEGV(c)))
# else
# define CopFILEAVx(c) (GvAV(CopFILEGV(c)))
# endif
# define CopFILEAVn(c) (CopFILEGV(c) ? GvAVn(CopFILEGV(c)) : NULL)
# define CopFILE(c) (CopFILEGV(c) /* +2 for '_<' */ \
? GvNAME(CopFILEGV(c))+2 : NULL)
# define CopFILE_LEN(c) (CopFILEGV(c) /* -2 for '_<' */ \
? GvNAMELEN(CopFILEGV(c))-2 : 0)
# define CopSTASH(c) ((c)->cop_stash)
# define CopSTASH_set(c,hv) ((c)->cop_stash = (hv))
# define CopFILE_free(c) (SvREFCNT_dec(CopFILEGV(c)),(CopFILEGV(c) = NULL))
#endif /* USE_ITHREADS */
#define CopSTASHPV(c) (CopSTASH(c) ? HvNAME_get(CopSTASH(c)) : NULL)
/* cop_stash is not refcounted */
#define CopSTASHPV_set(c,pv) CopSTASH_set((c), gv_stashpv(pv,GV_ADD))
#define CopSTASH_eq(c,hv) (CopSTASH(c) == (hv))
#define CopHINTHASH_get(c) ((COPHH*)((c)->cop_hints_hash))
#define CopHINTHASH_set(c,h) ((c)->cop_hints_hash = (h))
#define CopFEATURES_setfrom(dst, src) ((dst)->cop_features = (src)->cop_features)
/*
=for apidoc Am|SV *|cop_hints_fetch_pv |const COP *cop|const char *key |U32 hash|U32 flags
=for apidoc_item|SV *|cop_hints_fetch_pvn|const COP *cop|const char *key|STRLEN keylen|U32 hash|U32 flags
=for apidoc_item|SV *|cop_hints_fetch_pvs|const COP *cop| "key" |U32 flags
=for apidoc_item|SV *|cop_hints_fetch_sv |const COP *cop| SV *key |U32 hash|U32 flags
These look up the hint entry in the cop C<cop> with the key specified by
C<key> (and C<keylen> in the C<pvn> form), returning that value as a mortal
scalar copy, or C<&PL_sv_placeholder> if there is no value associated with the
key.
The forms differ in how the key is specified.
In the plain C<pv> form, the key is a C language NUL-terminated string.
In the C<pvs> form, the key is a C language string literal.
In the C<pvn> form, an additional parameter, C<keylen>, specifies the length of
the string, which hence, may contain embedded-NUL characters.
In the C<sv> form, C<*key> is an SV, and the key is the PV extracted from that.
using C<L</SvPV_const>>.
C<hash> is a precomputed hash of the key string, or zero if it has not been
precomputed. This parameter is omitted from the C<pvs> form, as it is computed
automatically at compile time.
The only flag currently used from the C<flags> parameter is C<COPHH_KEY_UTF8>.
It is illegal to set this in the C<sv> form. In the C<pv*> forms, it specifies
whether the key octets are interpreted as UTF-8 (if set) or as Latin-1 (if
cleared). The C<sv> form uses the underlying SV to determine the UTF-8ness of
the octets.
=cut
*/
#define cop_hints_fetch_pvn(cop, key, keylen, hash, flags) \
cophh_fetch_pvn(CopHINTHASH_get(cop), key, keylen, hash, flags)
#define cop_hints_fetch_pvs(cop, key, flags) \
cophh_fetch_pvs(CopHINTHASH_get(cop), key, flags)
#define cop_hints_fetch_pv(cop, key, hash, flags) \
cophh_fetch_pv(CopHINTHASH_get(cop), key, hash, flags)
#define cop_hints_fetch_sv(cop, key, hash, flags) \
cophh_fetch_sv(CopHINTHASH_get(cop), key, hash, flags)
/*
=for apidoc Am|bool|cop_hints_exists_pv |const COP *cop|const char *key|U32 hash |U32 flags
=for apidoc_item|bool|cop_hints_exists_pvn|const COP *cop|const char *key|STRLEN keylen|U32 hash|U32 flags
=for apidoc_item|bool|cop_hints_exists_pvs|const COP *cop| "key" |U32 flags
=for apidoc_item|bool|cop_hints_exists_sv |const COP *cop| SV *key |U32 hash|U32 flags
These look up the hint entry in the cop C<cop> with the key specified by
C<key> (and C<keylen> in the C<pvn> form), returning true if a value exists,
and false otherwise.
The forms differ in how the key is specified. In all forms, the key is pointed
to by C<key>.
In the plain C<pv> form, the key is a C language NUL-terminated string.
In the C<pvs> form, the key is a C language string literal.
In the C<pvn> form, an additional parameter, C<keylen>, specifies the length of
the string, which hence, may contain embedded-NUL characters.
In the C<sv> form, C<*key> is an SV, and the key is the PV extracted from that.
using C<L</SvPV_const>>.
C<hash> is a precomputed hash of the key string, or zero if it has not been
precomputed. This parameter is omitted from the C<pvs> form, as it is computed
automatically at compile time.
The only flag currently used from the C<flags> parameter is C<COPHH_KEY_UTF8>.
It is illegal to set this in the C<sv> form. In the C<pv*> forms, it specifies
whether the key octets are interpreted as UTF-8 (if set) or as Latin-1 (if
cleared). The C<sv> form uses the underlying SV to determine the UTF-8ness of
the octets.
=cut
*/
#define cop_hints_exists_pvn(cop, key, keylen, hash, flags) \
cophh_exists_pvn(CopHINTHASH_get(cop), key, keylen, hash, flags)
#define cop_hints_exists_pvs(cop, key, flags) \
cophh_exists_pvs(CopHINTHASH_get(cop), key, flags)
#define cop_hints_exists_pv(cop, key, hash, flags) \
cophh_exists_pv(CopHINTHASH_get(cop), key, hash, flags)
#define cop_hints_exists_sv(cop, key, hash, flags) \
cophh_exists_sv(CopHINTHASH_get(cop), key, hash, flags)
/*
=for apidoc Am|HV *|cop_hints_2hv|const COP *cop|U32 flags
Generates and returns a standard Perl hash representing the full set of
hint entries in the cop C<cop>. C<flags> is currently unused and must
be zero.
=cut
*/
#define cop_hints_2hv(cop, flags) \
cophh_2hv(CopHINTHASH_get(cop), flags)
/*
=for apidoc Am|const char *|CopLABEL |COP *const cop
=for apidoc_item|const char *|CopLABEL_len |COP *const cop|STRLEN *len
=for apidoc_item|const char *|CopLABEL_len_flags|COP *const cop|STRLEN *len|U32 *flags
These return the label attached to a cop.
C<CopLABEL_len> and C<CopLABEL_len_flags> additionally store the number of
bytes comprising the returned label into C<*len>.
C<CopLABEL_len_flags> additionally returns the UTF-8ness of the returned label,
by setting C<*flags> to 0 or C<SVf_UTF8>.
=cut
*/
#define CopLABEL(c) Perl_cop_fetch_label(aTHX_ (c), NULL, NULL)
#define CopLABEL_len(c,len) Perl_cop_fetch_label(aTHX_ (c), len, NULL)
#define CopLABEL_len_flags(c,len,flags) Perl_cop_fetch_label(aTHX_ (c), len, flags)
#define CopLABEL_alloc(pv) ((pv)?savepv(pv):NULL)
#define CopSTASH_ne(c,hv) (!CopSTASH_eq(c,hv))
#define CopLINE(c) ((c)->cop_line)
#define CopLINE_inc(c) (++CopLINE(c))
#define CopLINE_dec(c) (--CopLINE(c))
#define CopLINE_set(c,l) (CopLINE(c) = (l))
/* OutCopFILE() is CopFILE for output (caller, die, warn, etc.) */
#define OutCopFILE(c) CopFILE(c)
#define CopHINTS_get(c) ((c)->cop_hints + 0)
#define CopHINTS_set(c, h) STMT_START { \
(c)->cop_hints = (h); \
} STMT_END
/*
* Here we have some enormously heavy (or at least ponderous) wizardry.
*/
/* subroutine context */
struct block_sub {
OP * retop; /* op to execute on exit from sub */
I32 old_cxsubix; /* previous value of si_cxsubix */
/* Above here is the same for sub, format and eval. */
PAD *prevcomppad; /* the caller's PL_comppad */
CV * cv;
/* Above here is the same for sub and format. */
I32 olddepth;
AV *savearray;
};
/* format context */
struct block_format {
OP * retop; /* op to execute on exit from sub */
I32 old_cxsubix; /* previous value of si_cxsubix */
/* Above here is the same for sub, format and eval. */
PAD *prevcomppad; /* the caller's PL_comppad */
CV * cv;
/* Above here is the same for sub and format. */
GV * gv;
GV * dfoutgv;
};
/* return a pointer to the current context */
#define CX_CUR() (&cxstack[cxstack_ix])
/* free all savestack items back to the watermark of the specified context */
#define CX_LEAVE_SCOPE(cx) LEAVE_SCOPE(cx->blk_oldsaveix)
#ifdef DEBUGGING
/* on debugging builds, poison cx afterwards so we know no code
* uses it - because after doing cxstack_ix--, any ties, exceptions etc
* may overwrite the current stack frame */
# define CX_POP(cx) \
assert(CX_CUR() == cx); \
cxstack_ix--; \
cx = NULL;
#else
# define CX_POP(cx) cxstack_ix--;
#endif
#define CX_PUSHSUB_GET_LVALUE_MASK(func) \
/* If the context is indeterminate, then only the lvalue */ \
/* flags that the caller also has are applicable. */ \
( \
(PL_op->op_flags & OPf_WANT) \
? OPpENTERSUB_LVAL_MASK \
: !(PL_op->op_private & OPpENTERSUB_LVAL_MASK) \
? 0 : (U8)func(aTHX) \
)
/* Restore old @_ */
#define CX_POP_SAVEARRAY(cx) \
STMT_START { \
AV *cx_pop_savearray_av = GvAV(PL_defgv); \
GvAV(PL_defgv) = cx->blk_sub.savearray; \
cx->blk_sub.savearray = NULL; \
SvREFCNT_dec(cx_pop_savearray_av); \
} STMT_END
/* junk in @_ spells trouble when cloning CVs and in pp_caller(), so don't
* leave any (a fast av_clear(ary), basically).
* New code should probably be using Perl_clear_defarray_simple()
* and/or Perl_clear_defarray()
*/
#define CLEAR_ARGARRAY(ary) \
STMT_START { \
AvFILLp(ary) = -1; \
av_remove_offset(ary); \
} STMT_END
/* eval context */
struct block_eval {
OP * retop; /* op to execute on exit from eval */
I32 old_cxsubix; /* previous value of si_cxsubix */
/* Above here is the same for sub, format and eval. */
SV * old_namesv;
OP * old_eval_root;
SV * cur_text;
CV * cv;
JMPENV * cur_top_env; /* value of PL_top_env when eval CX created */
};
/* If we ever need more than 512 op types, change the shift from 7.
blku_gimme is actually also only 2 bits, so could be merged with something.
*/
/* blk_u16 bit usage for eval contexts: */
#define CxOLD_IN_EVAL(cx) (((cx)->blk_u16) & 0x3F) /* saved PL_in_eval */
#define CxEVAL_TXT_REFCNTED(cx) (((cx)->blk_u16) & 0x40) /* cur_text rc++ */
#define CxOLD_OP_TYPE(cx) (((cx)->blk_u16) >> 7) /* type of eval op */
/* loop context */
struct block_loop {
LOOP * my_op; /* My op, that contains redo, next and last ops. */
union { /* different ways of locating the iteration variable */
SV **svp; /* for lexicals: address of pad slot */
GV *gv; /* for package vars */
} itervar_u;
SV *itersave; /* the original iteration var */
union {
struct { /* CXt_LOOP_ARY, C<for (@ary)> */
AV *ary; /* array being iterated over */
IV ix; /* index relative to base of array */
} ary;
struct { /* CXt_LOOP_LIST, C<for (list)> */
SSize_t basesp; /* first element of list on stack */
IV ix; /* index relative to basesp */
} stack;
struct { /* CXt_LOOP_LAZYIV, C<for (1..9)> */
IV cur;
IV end;
} lazyiv;
struct { /* CXt_LOOP_LAZYSV C<for ('a'..'z')> */
SV * cur;
SV * end; /* maximum value (or minimum in reverse) */
} lazysv;
} state_u;
#ifdef USE_ITHREADS
PAD *oldcomppad; /* needed to map itervar_u.svp during thread clone */
#endif
};
#define CxITERVAR(c) \
(CxPADLOOP(c) \
? (c)->blk_loop.itervar_u.svp \
: ((c)->cx_type & CXp_FOR_GV) \
? &GvSV((c)->blk_loop.itervar_u.gv) \
: (SV **)&(c)->blk_loop.itervar_u.gv)
#define CxLABEL(c) (CopLABEL((c)->blk_oldcop))
#define CxLABEL_len(c,len) (CopLABEL_len((c)->blk_oldcop, len))
#define CxLABEL_len_flags(c,len,flags) ((const char *)CopLABEL_len_flags((c)->blk_oldcop, len, flags))
#define CxHASARGS(c) (((c)->cx_type & CXp_HASARGS) == CXp_HASARGS)
/* CxLVAL(): the lval flags of the call site: the relevant flag bits from
* the op_private field of the calling pp_entersub (or its caller's caller
* if the caller's lvalue context isn't known):
* OPpLVAL_INTRO: sub used in lvalue context, e.g. f() = 1;
* OPpENTERSUB_INARGS (in conjunction with OPpLVAL_INTRO): the
* function is being used as a sub arg or as a referent, e.g.
* g(...,f(),...) or $r = \f()
* OPpDEREF: 2-bit mask indicating e.g. f()->[0].
* Note the contrast with CvLVALUE(), which is a property of the sub
* rather than the call site.
*/
#define CxLVAL(c) (0 + ((U8)((c)->blk_u16)))
/* given/when context */
struct block_givwhen {
OP *leave_op;
SV *defsv_save; /* the original $_ */
};
/* context common to subroutines, evals and loops */