3 * Copyright (C) 2012 by Larry Wall and others
5 * You may distribute under the terms of either the GNU General Public
6 * License or the Artistic License, as specified in the README file.
8 * This file is a home for static inline functions that cannot go in other
9 * headers files, because they depend on proto.h (included after most other
10 * headers) or struct definitions.
12 * Each section names the header file that the functions "belong" to.
15 /* ------------------------------- av.h ------------------------------- */
17 PERL_STATIC_INLINE SSize_t
18 S_av_top_index(pTHX_ AV *av)
20 PERL_ARGS_ASSERT_AV_TOP_INDEX;
21 assert(SvTYPE(av) == SVt_PVAV);
26 /* ------------------------------- cv.h ------------------------------- */
28 PERL_STATIC_INLINE GV *
32 ? Perl_cvgv_from_hek(aTHX_ sv)
33 : ((XPVCV*)MUTABLE_PTR(SvANY(sv)))->xcv_gv_u.xcv_gv;
36 PERL_STATIC_INLINE I32 *
37 S_CvDEPTHp(const CV * const sv)
39 assert(SvTYPE(sv) == SVt_PVCV || SvTYPE(sv) == SVt_PVFM);
40 return &((XPVCV*)SvANY(sv))->xcv_depth;
44 CvPROTO returns the prototype as stored, which is not necessarily what
45 the interpreter should be using. Specifically, the interpreter assumes
46 that spaces have been stripped, which has been the case if the prototype
47 was added by toke.c, but is generally not the case if it was added elsewhere.
48 Since we can't enforce the spacelessness at assignment time, this routine
49 provides a temporary copy at parse time with spaces removed.
50 I<orig> is the start of the original buffer, I<len> is the length of the
51 prototype and will be updated when this returns.
55 PERL_STATIC_INLINE char *
56 S_strip_spaces(pTHX_ const char * orig, STRLEN * const len)
60 tmpsv = newSVpvn_flags(orig, *len, SVs_TEMP);
68 *len = tmps - SvPVX(tmpsv);
73 /* ------------------------------- mg.h ------------------------------- */
75 #if defined(PERL_CORE) || defined(PERL_EXT)
76 /* assumes get-magic and stringification have already occurred */
77 PERL_STATIC_INLINE STRLEN
78 S_MgBYTEPOS(pTHX_ MAGIC *mg, SV *sv, const char *s, STRLEN len)
80 assert(mg->mg_type == PERL_MAGIC_regex_global);
81 assert(mg->mg_len != -1);
82 if (mg->mg_flags & MGf_BYTES || !DO_UTF8(sv))
83 return (STRLEN)mg->mg_len;
85 const STRLEN pos = (STRLEN)mg->mg_len;
86 /* Without this check, we may read past the end of the buffer: */
87 if (pos > sv_or_pv_len_utf8(sv, s, len)) return len+1;
88 return sv_or_pv_pos_u2b(sv, s, pos, NULL);
93 /* ------------------------------- pad.h ------------------------------ */
95 #if defined(PERL_IN_PAD_C) || defined(PERL_IN_OP_C)
96 PERL_STATIC_INLINE bool
97 PadnameIN_SCOPE(const PADNAME * const pn, const U32 seq)
99 /* is seq within the range _LOW to _HIGH ?
100 * This is complicated by the fact that PL_cop_seqmax
101 * may have wrapped around at some point */
102 if (COP_SEQ_RANGE_LOW(pn) == PERL_PADSEQ_INTRO)
103 return FALSE; /* not yet introduced */
105 if (COP_SEQ_RANGE_HIGH(pn) == PERL_PADSEQ_INTRO) {
106 /* in compiling scope */
108 (seq > COP_SEQ_RANGE_LOW(pn))
109 ? (seq - COP_SEQ_RANGE_LOW(pn) < (U32_MAX >> 1))
110 : (COP_SEQ_RANGE_LOW(pn) - seq > (U32_MAX >> 1))
115 (COP_SEQ_RANGE_LOW(pn) > COP_SEQ_RANGE_HIGH(pn))
117 ( seq > COP_SEQ_RANGE_LOW(pn)
118 || seq <= COP_SEQ_RANGE_HIGH(pn))
120 : ( seq > COP_SEQ_RANGE_LOW(pn)
121 && seq <= COP_SEQ_RANGE_HIGH(pn))
128 /* ----------------------------- regexp.h ----------------------------- */
130 PERL_STATIC_INLINE struct regexp *
131 S_ReANY(const REGEXP * const re)
133 assert(isREGEXP(re));
134 return re->sv_u.svu_rx;
137 /* ------------------------------- sv.h ------------------------------- */
139 PERL_STATIC_INLINE SV *
140 S_SvREFCNT_inc(SV *sv)
142 if (LIKELY(sv != NULL))
146 PERL_STATIC_INLINE SV *
147 S_SvREFCNT_inc_NN(SV *sv)
152 PERL_STATIC_INLINE void
153 S_SvREFCNT_inc_void(SV *sv)
155 if (LIKELY(sv != NULL))
158 PERL_STATIC_INLINE void
159 S_SvREFCNT_dec(pTHX_ SV *sv)
161 if (LIKELY(sv != NULL)) {
162 U32 rc = SvREFCNT(sv);
164 SvREFCNT(sv) = rc - 1;
166 Perl_sv_free2(aTHX_ sv, rc);
170 PERL_STATIC_INLINE void
171 S_SvREFCNT_dec_NN(pTHX_ SV *sv)
173 U32 rc = SvREFCNT(sv);
175 SvREFCNT(sv) = rc - 1;
177 Perl_sv_free2(aTHX_ sv, rc);
180 PERL_STATIC_INLINE void
184 if (SvOBJECT(SvRV(sv))) HvAMAGIC_on(SvSTASH(SvRV(sv)));
186 PERL_STATIC_INLINE void
189 if (SvROK(sv) && SvOBJECT(SvRV(sv)))
190 HvAMAGIC_off(SvSTASH(SvRV(sv)));
193 PERL_STATIC_INLINE U32
194 S_SvPADSTALE_on(SV *sv)
196 assert(!(SvFLAGS(sv) & SVs_PADTMP));
197 return SvFLAGS(sv) |= SVs_PADSTALE;
199 PERL_STATIC_INLINE U32
200 S_SvPADSTALE_off(SV *sv)
202 assert(!(SvFLAGS(sv) & SVs_PADTMP));
203 return SvFLAGS(sv) &= ~SVs_PADSTALE;
205 #if defined(PERL_CORE) || defined (PERL_EXT)
206 PERL_STATIC_INLINE STRLEN
207 S_sv_or_pv_pos_u2b(pTHX_ SV *sv, const char *pv, STRLEN pos, STRLEN *lenp)
209 PERL_ARGS_ASSERT_SV_OR_PV_POS_U2B;
211 U8 *hopped = utf8_hop((U8 *)pv, pos);
212 if (lenp) *lenp = (STRLEN)(utf8_hop(hopped, *lenp) - hopped);
213 return (STRLEN)(hopped - (U8 *)pv);
215 return sv_pos_u2b_flags(sv,pos,lenp,SV_CONST_RETURN);
219 /* ------------------------------- handy.h ------------------------------- */
221 /* saves machine code for a common noreturn idiom typically used in Newx*() */
222 #ifdef GCC_DIAG_PRAGMA
223 GCC_DIAG_IGNORE(-Wunused-function) /* Intentionally left semicolonless. */
226 S_croak_memory_wrap(void)
228 Perl_croak_nocontext("%s",PL_memory_wrap);
230 #ifdef GCC_DIAG_PRAGMA
231 GCC_DIAG_RESTORE /* Intentionally left semicolonless. */
234 /* ------------------------------- utf8.h ------------------------------- */
236 PERL_STATIC_INLINE void
237 S_append_utf8_from_native_byte(const U8 byte, U8** dest)
239 /* Takes an input 'byte' (Latin1 or EBCDIC) and appends it to the UTF-8
240 * encoded string at '*dest', updating '*dest' to include it */
242 PERL_ARGS_ASSERT_APPEND_UTF8_FROM_NATIVE_BYTE;
244 if (NATIVE_BYTE_IS_INVARIANT(byte))
247 *(*dest)++ = UTF8_EIGHT_BIT_HI(byte);
248 *(*dest)++ = UTF8_EIGHT_BIT_LO(byte);
254 A helper function for the macro isUTF8_CHAR(), which should be used instead of
255 this function. The macro will handle smaller code points directly saving time,
256 using this function as a fall-back for higher code points.
258 Tests if the first bytes of string C<s> form a valid UTF-8 character. 0 is
259 returned if the bytes starting at C<s> up to but not including C<e> do not form a
260 complete well-formed UTF-8 character; otherwise the number of bytes in the
261 character is returned.
263 Note that an INVARIANT (i.e. ASCII on non-EBCDIC) character is a valid UTF-8
267 PERL_STATIC_INLINE STRLEN
268 S__is_utf8_char_slow(const U8 *s, const U8 *e)
270 dTHX; /* The function called below requires thread context */
274 PERL_ARGS_ASSERT__IS_UTF8_CHAR_SLOW;
277 utf8n_to_uvchr(s, e - s, &actual_len, UTF8_CHECK_ONLY);
279 return (actual_len == (STRLEN) -1) ? 0 : actual_len;
282 /* ------------------------------- perl.h ----------------------------- */
285 =head1 Miscellaneous Functions
287 =for apidoc AiR|bool|is_safe_syscall|const char *pv|STRLEN len|const char *what|const char *op_name
289 Test that the given C<pv> doesn't contain any internal C<NUL> characters.
290 If it does, set C<errno> to C<ENOENT>, optionally warn, and return FALSE.
292 Return TRUE if the name is safe.
294 Used by the C<IS_SAFE_SYSCALL()> macro.
299 PERL_STATIC_INLINE bool
300 S_is_safe_syscall(pTHX_ const char *pv, STRLEN len, const char *what, const char *op_name) {
301 /* While the Windows CE API provides only UCS-16 (or UTF-16) APIs
302 * perl itself uses xce*() functions which accept 8-bit strings.
305 PERL_ARGS_ASSERT_IS_SAFE_SYSCALL;
309 if (UNLIKELY((null_at = (char *)memchr(pv, 0, len-1)) != NULL)) {
310 SETERRNO(ENOENT, LIB_INVARG);
311 Perl_ck_warner(aTHX_ packWARN(WARN_SYSCALLS),
312 "Invalid \\0 character in %s for %s: %s\\0%s",
313 what, op_name, pv, null_at+1);
323 Return true if the supplied filename has a newline character
324 immediately before the first (hopefully only) NUL.
326 My original look at this incorrectly used the len from SvPV(), but
327 that's incorrect, since we allow for a NUL in pv[len-1].
329 So instead, strlen() and work from there.
331 This allow for the user reading a filename, forgetting to chomp it,
334 open my $foo, "$file\0";
340 PERL_STATIC_INLINE bool
341 S_should_warn_nl(const char *pv) {
344 PERL_ARGS_ASSERT_SHOULD_WARN_NL;
348 return len > 0 && pv[len-1] == '\n';
353 /* ------------------ pp.c, regcomp.c, toke.c, universal.c ------------ */
355 #define MAX_CHARSET_NAME_LENGTH 2
357 PERL_STATIC_INLINE const char *
358 get_regex_charset_name(const U32 flags, STRLEN* const lenp)
360 /* Returns a string that corresponds to the name of the regex character set
361 * given by 'flags', and *lenp is set the length of that string, which
362 * cannot exceed MAX_CHARSET_NAME_LENGTH characters */
365 switch (get_regex_charset(flags)) {
366 case REGEX_DEPENDS_CHARSET: return DEPENDS_PAT_MODS;
367 case REGEX_LOCALE_CHARSET: return LOCALE_PAT_MODS;
368 case REGEX_UNICODE_CHARSET: return UNICODE_PAT_MODS;
369 case REGEX_ASCII_RESTRICTED_CHARSET: return ASCII_RESTRICT_PAT_MODS;
370 case REGEX_ASCII_MORE_RESTRICTED_CHARSET:
372 return ASCII_MORE_RESTRICT_PAT_MODS;
374 /* The NOT_REACHED; hides an assert() which has a rather complex
375 * definition in perl.h. */
376 NOT_REACHED; /* NOTREACHED */
377 return "?"; /* Unknown */
382 Return false if any get magic is on the SV other than taint magic.
386 PERL_STATIC_INLINE bool
387 S_sv_only_taint_gmagic(SV *sv) {
388 MAGIC *mg = SvMAGIC(sv);
390 PERL_ARGS_ASSERT_SV_ONLY_TAINT_GMAGIC;
393 if (mg->mg_type != PERL_MAGIC_taint
394 && !(mg->mg_flags & MGf_GSKIP)
395 && mg->mg_virtual->svt_get) {
398 mg = mg->mg_moremagic;
404 /* ------------------ cop.h ------------------------------------------- */
407 /* Enter a block. Push a new base context and return its address. */
409 PERL_STATIC_INLINE PERL_CONTEXT *
410 S_cx_pushblock(pTHX_ U8 type, U8 gimme, SV** sp, I32 saveix)
414 PERL_ARGS_ASSERT_CX_PUSHBLOCK;
419 cx->blk_gimme = gimme;
420 cx->blk_oldsaveix = saveix;
421 cx->blk_oldsp = (I32)(sp - PL_stack_base);
422 cx->blk_oldcop = PL_curcop;
423 cx->blk_oldmarksp = (I32)(PL_markstack_ptr - PL_markstack);
424 cx->blk_oldscopesp = PL_scopestack_ix;
425 cx->blk_oldpm = PL_curpm;
426 cx->blk_old_tmpsfloor = PL_tmps_floor;
428 PL_tmps_floor = PL_tmps_ix;
429 CX_DEBUG(cx, "PUSH");
434 /* Exit a block (RETURN and LAST). */
436 PERL_STATIC_INLINE void
437 S_cx_popblock(pTHX_ PERL_CONTEXT *cx)
439 PERL_ARGS_ASSERT_CX_POPBLOCK;
442 /* these 3 are common to cx_popblock and cx_topblock */
443 PL_markstack_ptr = PL_markstack + cx->blk_oldmarksp;
444 PL_scopestack_ix = cx->blk_oldscopesp;
445 PL_curpm = cx->blk_oldpm;
447 /* LEAVE_SCOPE() should have made this true. /(?{})/ cheats
448 * and leaves a CX entry lying around for repeated use, so
449 * skip for multicall */ \
450 assert( (CxTYPE(cx) == CXt_SUB && CxMULTICALL(cx))
451 || PL_savestack_ix == cx->blk_oldsaveix);
452 PL_curcop = cx->blk_oldcop;
453 PL_tmps_floor = cx->blk_old_tmpsfloor;
456 /* Continue a block elsewhere (e.g. NEXT, REDO, GOTO).
457 * Whereas cx_popblock() restores the state to the point just before
458 * cx_pushblock() was called, cx_topblock() restores it to the point just
459 * *after* cx_pushblock() was called. */
461 PERL_STATIC_INLINE void
462 S_cx_topblock(pTHX_ PERL_CONTEXT *cx)
464 PERL_ARGS_ASSERT_CX_TOPBLOCK;
467 /* these 3 are common to cx_popblock and cx_topblock */
468 PL_markstack_ptr = PL_markstack + cx->blk_oldmarksp;
469 PL_scopestack_ix = cx->blk_oldscopesp;
470 PL_curpm = cx->blk_oldpm;
472 PL_stack_sp = PL_stack_base + cx->blk_oldsp;
476 PERL_STATIC_INLINE void
477 S_cx_pushsub(pTHX_ PERL_CONTEXT *cx, CV *cv, OP *retop, bool hasargs)
479 U8 phlags = CX_PUSHSUB_GET_LVALUE_MASK(Perl_was_lvalue_sub);
481 PERL_ARGS_ASSERT_CX_PUSHSUB;
483 PERL_DTRACE_PROBE_ENTRY(cv);
485 cx->blk_sub.olddepth = CvDEPTH(cv);
486 cx->blk_sub.prevcomppad = PL_comppad;
487 cx->cx_type |= (hasargs) ? CXp_HASARGS : 0;
488 cx->blk_sub.retop = retop;
489 SvREFCNT_inc_simple_void_NN(cv);
490 cx->blk_u16 = PL_op->op_private & (phlags|OPpDEREF);
494 /* subsets of cx_popsub() */
496 PERL_STATIC_INLINE void
497 S_cx_popsub_common(pTHX_ PERL_CONTEXT *cx)
501 PERL_ARGS_ASSERT_CX_POPSUB_COMMON;
502 assert(CxTYPE(cx) == CXt_SUB);
504 PL_comppad = cx->blk_sub.prevcomppad;
505 PL_curpad = LIKELY(PL_comppad) ? AvARRAY(PL_comppad) : NULL;
507 CvDEPTH(cv) = cx->blk_sub.olddepth;
508 cx->blk_sub.cv = NULL;
513 /* handle the @_ part of leaving a sub */
515 PERL_STATIC_INLINE void
516 S_cx_popsub_args(pTHX_ PERL_CONTEXT *cx)
520 PERL_ARGS_ASSERT_CX_POPSUB_ARGS;
521 assert(CxTYPE(cx) == CXt_SUB);
522 assert(AvARRAY(MUTABLE_AV(
523 PadlistARRAY(CvPADLIST(cx->blk_sub.cv))[
524 CvDEPTH(cx->blk_sub.cv)])) == PL_curpad);
526 CX_POP_SAVEARRAY(cx);
527 av = MUTABLE_AV(PAD_SVl(0));
528 if (UNLIKELY(AvREAL(av)))
529 /* abandon @_ if it got reified */
530 clear_defarray(av, 0);
537 PERL_STATIC_INLINE void
538 S_cx_popsub(pTHX_ PERL_CONTEXT *cx)
540 PERL_ARGS_ASSERT_CX_POPSUB;
541 assert(CxTYPE(cx) == CXt_SUB);
543 PERL_DTRACE_PROBE_RETURN(cx->blk_sub.cv);
547 cx_popsub_common(cx);
551 PERL_STATIC_INLINE void
552 S_cx_pushformat(pTHX_ PERL_CONTEXT *cx, CV *cv, OP *retop, GV *gv)
554 PERL_ARGS_ASSERT_CX_PUSHFORMAT;
556 cx->blk_format.cv = cv;
557 cx->blk_format.retop = retop;
558 cx->blk_format.gv = gv;
559 cx->blk_format.dfoutgv = PL_defoutgv;
560 cx->blk_format.prevcomppad = PL_comppad;
563 SvREFCNT_inc_simple_void_NN(cv);
565 SvREFCNT_inc_void(cx->blk_format.dfoutgv);
569 PERL_STATIC_INLINE void
570 S_cx_popformat(pTHX_ PERL_CONTEXT *cx)
575 PERL_ARGS_ASSERT_CX_POPFORMAT;
576 assert(CxTYPE(cx) == CXt_FORMAT);
578 dfout = cx->blk_format.dfoutgv;
580 cx->blk_format.dfoutgv = NULL;
581 SvREFCNT_dec_NN(dfout);
583 PL_comppad = cx->blk_format.prevcomppad;
584 PL_curpad = LIKELY(PL_comppad) ? AvARRAY(PL_comppad) : NULL;
585 cv = cx->blk_format.cv;
586 cx->blk_format.cv = NULL;
592 PERL_STATIC_INLINE void
593 S_cx_pusheval(pTHX_ PERL_CONTEXT *cx, OP *retop, SV *namesv)
595 PERL_ARGS_ASSERT_CX_PUSHEVAL;
597 cx->blk_eval.retop = retop;
598 cx->blk_eval.old_namesv = namesv;
599 cx->blk_eval.old_eval_root = PL_eval_root;
600 cx->blk_eval.cur_text = PL_parser ? PL_parser->linestr : NULL;
601 cx->blk_eval.cv = NULL; /* later set by doeval_compile() */
602 cx->blk_eval.cur_top_env = PL_top_env;
604 assert(!(PL_in_eval & ~ 0x7F));
605 assert(!(PL_op->op_type & ~0x1FF));
606 cx->blk_u16 = (PL_in_eval & 0x7F) | ((U16)PL_op->op_type << 7);
610 PERL_STATIC_INLINE void
611 S_cx_popeval(pTHX_ PERL_CONTEXT *cx)
615 PERL_ARGS_ASSERT_CX_POPEVAL;
616 assert(CxTYPE(cx) == CXt_EVAL);
618 PL_in_eval = CxOLD_IN_EVAL(cx);
619 PL_eval_root = cx->blk_eval.old_eval_root;
620 sv = cx->blk_eval.cur_text;
621 if (sv && SvSCREAM(sv)) {
622 cx->blk_eval.cur_text = NULL;
626 sv = cx->blk_eval.old_namesv;
627 if (sv && !SvTEMP(sv))/* TEMP implies cx_popeval() re-entrantly called */
632 /* push a plain loop, i.e.
634 * while (cond) { block }
635 * for (init;cond;continue) { block }
636 * This loop can be last/redo'ed etc.
639 PERL_STATIC_INLINE void
640 S_cx_pushloop_plain(pTHX_ PERL_CONTEXT *cx)
642 PERL_ARGS_ASSERT_CX_PUSHLOOP_PLAIN;
643 cx->blk_loop.my_op = cLOOP;
647 /* push a true for loop, i.e.
648 * for var (list) { block }
651 PERL_STATIC_INLINE void
652 S_cx_pushloop_for(pTHX_ PERL_CONTEXT *cx, void *itervarp, SV* itersave)
654 PERL_ARGS_ASSERT_CX_PUSHLOOP_FOR;
656 /* this one line is common with cx_pushloop_plain */
657 cx->blk_loop.my_op = cLOOP;
659 cx->blk_loop.itervar_u.svp = (SV**)itervarp;
660 cx->blk_loop.itersave = itersave;
662 cx->blk_loop.oldcomppad = PL_comppad;
667 /* pop all loop types, including plain */
669 PERL_STATIC_INLINE void
670 S_cx_poploop(pTHX_ PERL_CONTEXT *cx)
672 PERL_ARGS_ASSERT_CX_POPLOOP;
674 assert(CxTYPE_is_LOOP(cx));
675 if ( CxTYPE(cx) == CXt_LOOP_ARY
676 || CxTYPE(cx) == CXt_LOOP_LAZYSV)
678 /* Free ary or cur. This assumes that state_u.ary.ary
679 * aligns with state_u.lazysv.cur. See cx_dup() */
680 SV *sv = cx->blk_loop.state_u.lazysv.cur;
681 cx->blk_loop.state_u.lazysv.cur = NULL;
683 if (CxTYPE(cx) == CXt_LOOP_LAZYSV) {
684 sv = cx->blk_loop.state_u.lazysv.end;
685 cx->blk_loop.state_u.lazysv.end = NULL;
689 if (cx->cx_type & (CXp_FOR_PAD|CXp_FOR_GV)) {
691 SV **svp = (cx)->blk_loop.itervar_u.svp;
692 if ((cx->cx_type & CXp_FOR_GV))
693 svp = &GvSV((GV*)svp);
695 *svp = cx->blk_loop.itersave;
696 cx->blk_loop.itersave = NULL;
702 PERL_STATIC_INLINE void
703 S_cx_pushwhen(pTHX_ PERL_CONTEXT *cx)
705 PERL_ARGS_ASSERT_CX_PUSHWHEN;
707 cx->blk_givwhen.leave_op = cLOGOP->op_other;
711 PERL_STATIC_INLINE void
712 S_cx_popwhen(pTHX_ PERL_CONTEXT *cx)
714 PERL_ARGS_ASSERT_CX_POPWHEN;
715 assert(CxTYPE(cx) == CXt_WHEN);
722 PERL_STATIC_INLINE void
723 S_cx_pushgiven(pTHX_ PERL_CONTEXT *cx, SV *orig_defsv)
725 PERL_ARGS_ASSERT_CX_PUSHGIVEN;
727 cx->blk_givwhen.leave_op = cLOGOP->op_other;
728 cx->blk_givwhen.defsv_save = orig_defsv;
732 PERL_STATIC_INLINE void
733 S_cx_popgiven(pTHX_ PERL_CONTEXT *cx)
737 PERL_ARGS_ASSERT_CX_POPGIVEN;
738 assert(CxTYPE(cx) == CXt_GIVEN);
741 GvSV(PL_defgv) = cx->blk_givwhen.defsv_save;
742 cx->blk_givwhen.defsv_save = NULL;
750 * ex: set ts=8 sts=4 sw=4 et: