This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
https://perl5.git.perl.org / perl5.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
Update of Module::CoreList
[perl5.git] / embed.fnc
diff --git a/embed.fnc b/embed.fnc
index 0b85259..ca15006 100644 (file)
--- a/embed.fnc
+++ b/embed.fnc
@@ -128,8 +128,20 @@
 :
 :   P  Pure function:
 :
-:      A pure function has no effects except the return value, and the return
-:      value depends only on params and/or globals.  Also implies "R":
+:      A pure function has no effects except the return value, and the return
+:       value depends only on params and/or globals.  This is a hint to the
+:      compiler that it can optimize calls to this function out of common
+:      subexpressions.  Consequently if this flag is wrongly specified, it can
+:      lead to subtle bugs that vary by platform, compiler, compiler version,
+:      and optimization level.  Also, a future commit could easily change a
+:      currently-pure function without even noticing this flag.  So it should
+:      be used sparingly, only for functions that are unlikely to ever become
+:      not pure by future commits.  It should not be used for static
+:      functions, as the compiler already has the information needed to make
+:      the 'pure' determination and doesn't need any hint; so it doesn't add
+:      value in those cases, and could be dangerous if it causes the compiler
+:      to skip doing its own checks.  It should not be used on functions that
+:      touch SVs, as those can trigger unexpected magic.  Also implies "R":
 :
 :         proto.h: add __attribute__pure__
 :
@@ -665,9 +677,9 @@ ApbmM       |SV**   |hv_store_flags |NULLOK HV *hv|NULLOK const char *key \
                                |I32 klen|NULLOK SV *val|U32 hash|int flags
 Amd    |void   |hv_undef       |NULLOK HV *hv
 poX    |void   |hv_undef_flags |NULLOK HV *hv|U32 flags
-Am     |I32    |ibcmp          |NN const char* a|NN const char* b|I32 len
+AmP    |I32    |ibcmp          |NN const char* a|NN const char* b|I32 len
 AnpP   |I32    |foldEQ         |NN const char* a|NN const char* b|I32 len
-Am     |I32    |ibcmp_locale   |NN const char* a|NN const char* b|I32 len
+AmP    |I32    |ibcmp_locale   |NN const char* a|NN const char* b|I32 len
 AnpP   |I32    |foldEQ_locale  |NN const char* a|NN const char* b|I32 len
 Am     |I32    |ibcmp_utf8     |NN const char *s1|NULLOK char **pe1|UV l1 \
                                |bool u1|NN const char *s2|NULLOK char **pe2 \
@@ -727,7 +739,7 @@ ADMpR       |bool   |isIDFIRST_lazy |NN const char* p
 ADMpR  |bool   |isALNUM_lazy   |NN const char* p
 #ifdef PERL_IN_UTF8_C
 snR    |U8     |to_lower_latin1|const U8 c|NULLOK U8 *p|NULLOK STRLEN *lenp
-inPR   |bool   |is_utf8_cp_above_31_bits|NN const U8 * const s|NN const U8 * const e
+inR    |bool   |is_utf8_cp_above_31_bits|NN const U8 * const s|NN const U8 * const e
 #endif
 #if defined(PERL_IN_UTF8_C) || defined(PERL_IN_REGCOMP_C) || defined(PERL_IN_REGEXEC_C)
 EXp    |UV        |_to_fold_latin1|const U8 c|NN U8 *p|NN STRLEN *lenp|const unsigned int flags
@@ -755,16 +767,16 @@ ADMpR     |bool   |is_uni_lower_lc|UV c
 ADMpR  |bool   |is_uni_print_lc|UV c
 ADMpR  |bool   |is_uni_punct_lc|UV c
 ADMpPR |bool   |is_uni_xdigit_lc|UV c
-AnidRP |bool   |is_utf8_invariant_string|NN const U8* const s|STRLEN const len
+AnidR  |bool   |is_utf8_invariant_string|NN const U8* const s|STRLEN const len
 AmnpdRP        |bool   |is_ascii_string|NN const U8* const s|const STRLEN len
 AmnpdRP        |bool   |is_invariant_string|NN const U8* const s|const STRLEN len
 AnpdD  |STRLEN |is_utf8_char   |NN const U8 *s
 Abmnpd |STRLEN |is_utf8_char_buf|NN const U8 *buf|NN const U8 *buf_end
-AnipdP |bool   |is_utf8_string |NN const U8 *s|const STRLEN len
-AnidP  |bool   |is_utf8_string_flags                                       \
+AnipdR |bool   |is_utf8_string |NN const U8 *s|const STRLEN len
+AnidR  |bool   |is_utf8_string_flags                                       \
                |NN const U8 *s|const STRLEN len|const U32 flags
-AnidP  |bool   |is_strict_utf8_string|NN const U8 *s|const STRLEN len
-AnidP  |bool   |is_c9strict_utf8_string|NN const U8 *s|const STRLEN len
+AnidR  |bool   |is_strict_utf8_string|NN const U8 *s|const STRLEN len
+AnidR  |bool   |is_c9strict_utf8_string|NN const U8 *s|const STRLEN len
 Anpdmb |bool   |is_utf8_string_loc                                         \
                |NN const U8 *s|const STRLEN len|NN const U8 **ep
 Andm   |bool   |is_utf8_string_loc_flags                                   \
@@ -796,7 +808,7 @@ Anid        |bool   |is_utf8_fixed_width_buf_loclen_flags                       \
                |NULLOK const U8 **ep|NULLOK STRLEN *el|const U32 flags
 AmndP  |bool   |is_utf8_valid_partial_char                                 \
                |NN const U8 * const s|NN const U8 * const e
-AnidP  |bool   |is_utf8_valid_partial_char_flags                           \
+AnidR  |bool   |is_utf8_valid_partial_char_flags                           \
                |NN const U8 * const s|NN const U8 * const e|const U32 flags
 AMpR   |bool   |_is_uni_FOO|const U8 classnum|const UV c
 AMpR   |bool   |_is_utf8_FOO|const U8 classnum|NN const U8 *p
@@ -898,7 +910,7 @@ EMpRX       |bool   |grok_bslash_o  |NN char** s|NN UV* uv           \
                                |const bool utf8
 EMiR   |char*|form_short_octal_warning|NN const char * const s  \
                                |const STRLEN len
-EiPRn  |I32    |regcurly       |NN const char *s
+EiRn   |I32    |regcurly       |NN const char *s
 #endif
 Apd    |UV     |grok_hex       |NN const char* start|NN STRLEN* len_p|NN I32* flags|NULLOK NV *result
 Apd    |int    |grok_infnan    |NN const char** sp|NN const char *send
@@ -1609,8 +1621,8 @@ Apd       |void   |sv_vsetpvfn    |NN SV *const sv|NN const char *const pat|const STRLEN pa
                                |NULLOK va_list *const args|NULLOK SV **const svargs \
                                |const I32 svmax|NULLOK bool *const maybe_tainted
 ApR    |NV     |str_to_version |NN SV *sv
-EpRM   |SV*    |swash_init     |NN const char* pkg|NN const char* name|NN SV* listsv|I32 minbits|I32 none
-EpM    |UV     |swash_fetch    |NN SV *swash|NN const U8 *ptr|bool do_utf8
+EXpRM  |SV*    |swash_init     |NN const char* pkg|NN const char* name|NN SV* listsv|I32 minbits|I32 none
+EXpM   |UV     |swash_fetch    |NN SV *swash|NN const U8 *ptr|bool do_utf8
 #ifdef PERL_IN_REGCOMP_C
 EiMR   |SV*    |add_cp_to_invlist      |NULLOK SV* invlist|const UV cp
 EiM    |void   |invlist_set_len|NN SV* const invlist|const UV len|const bool offset
@@ -1693,9 +1705,9 @@ ApdD      |UV     |to_utf8_case   |NN const U8 *p                                 \
                                |NN const char *normal|                         \
                                NULLOK const char *special
 #if defined(PERL_IN_UTF8_C)
-inRP   |bool   |does_utf8_overflow|NN const U8 * const s|NN const U8 * e
-inRP   |bool   |is_utf8_overlong_given_start_byte_ok|NN const U8 * const s|const STRLEN len
-inRP   |bool   |isFF_OVERLONG  |NN const U8 * const s|const STRLEN len
+inR    |bool   |does_utf8_overflow|NN const U8 * const s|NN const U8 * e
+inR    |bool   |is_utf8_overlong_given_start_byte_ok|NN const U8 * const s|const STRLEN len
+inR    |bool   |isFF_OVERLONG  |NN const U8 * const s|const STRLEN len
 sMR    |char * |unexpected_non_continuation_text                       \
                |NN const U8 * const s                                  \
                |STRLEN print_len                                       \
@@ -1744,11 +1756,11 @@ p       |void   |utilize        |int aver|I32 floor|NULLOK OP* version|NN OP* idop|NULLOK OP* a
 Ap     |U8*    |utf16_to_utf8  |NN U8* p|NN U8 *d|I32 bytelen|NN I32 *newlen
 Ap     |U8*    |utf16_to_utf8_reversed|NN U8* p|NN U8 *d|I32 bytelen|NN I32 *newlen
 AdpPR  |STRLEN |utf8_length    |NN const U8* s|NN const U8 *e
-AipdPR |IV     |utf8_distance  |NN const U8 *a|NN const U8 *b
-AipdPRn        |U8*    |utf8_hop       |NN const U8 *s|SSize_t off
-AipdPRn        |U8*    |utf8_hop_back|NN const U8 *s|SSize_t off|NN const U8 *start
-AipdPRn        |U8*    |utf8_hop_forward|NN const U8 *s|SSize_t off|NN const U8 *end
-AipdPRn        |U8*    |utf8_hop_safe  |NN const U8 *s|SSize_t off|NN const U8 *start|NN const U8 *end
+AipdR  |IV     |utf8_distance  |NN const U8 *a|NN const U8 *b
+AipdRn |U8*    |utf8_hop       |NN const U8 *s|SSize_t off
+AipdRn |U8*    |utf8_hop_back|NN const U8 *s|SSize_t off|NN const U8 *start
+AipdRn |U8*    |utf8_hop_forward|NN const U8 *s|SSize_t off|NN const U8 *end
+AipdRn |U8*    |utf8_hop_safe  |NN const U8 *s|SSize_t off|NN const U8 *start|NN const U8 *end
 ApMd   |U8*    |utf8_to_bytes  |NN U8 *s|NN STRLEN *len
 Apd    |int    |bytes_cmp_utf8 |NN const U8 *b|STRLEN blen|NN const U8 *u \
                                |STRLEN ulen
@@ -1927,7 +1939,7 @@ Apdmb     |void   |sv_force_normal|NN SV *sv
 Apd    |void   |sv_force_normal_flags|NN SV *const sv|const U32 flags
 pX     |SSize_t|tmps_grow_p    |SSize_t ix
 Apd    |SV*    |sv_rvweaken    |NN SV *const sv
-AnpPMd |SV*    |sv_get_backrefs|NN SV *const sv
+AnpMd  |SV*    |sv_get_backrefs|NN SV *const sv
 : This is indirectly referenced by globals.c. This is somewhat annoying.
 p      |int    |magic_killbackrefs|NN SV *sv|NN MAGIC *mg
 Ap     |OP*    |newANONATTRSUB |I32 floor|NULLOK OP *proto|NULLOK OP *attrs|NULLOK OP *block
@@ -1980,7 +1992,7 @@ Ap        |void   |sys_intern_dup |NN struct interp_intern* src|NN struct interp_intern*
 #  endif
 #endif
 
-AmopP  |const XOP *    |custom_op_xop  |NN const OP *o
+Amop   |const XOP *    |custom_op_xop  |NN const OP *o
 ApR    |const char *   |custom_op_name |NN const OP *o
 ApR    |const char *   |custom_op_desc |NN const OP *o
 pRX    |XOPRETANY      |custom_op_get_field    |NN const OP *o|const xop_flags_enum field
@@ -2275,7 +2287,7 @@ Ei        |regnode*|handle_named_backref|NN RExC_state_t *pRExC_state         \
                                |NN I32 *flagp                              \
                                |NN char * parse_start                      \
                                |char ch
-EsnP   |unsigned int|regex_set_precedence|const U8 my_operator
+EsnR   |unsigned int|regex_set_precedence|const U8 my_operator
 Es     |regnode*|handle_regex_sets|NN RExC_state_t *pRExC_state \
                                |NULLOK SV ** return_invlist            \
                                |NN I32 *flagp|U32 depth                \
@@ -2373,8 +2385,8 @@ Es        |I32    |make_trie      |NN RExC_state_t *pRExC_state \
                                |U32 word_count|U32 flags|U32 depth
 Es     |regnode *|construct_ahocorasick_from_trie|NN RExC_state_t *pRExC_state \
                                 |NN regnode *source|U32 depth
-EnPs   |const char *|cntrl_to_mnemonic|const U8 c
-EnPs   |int    |edit_distance  |NN const UV *src                   \
+EnsR   |const char *|cntrl_to_mnemonic|const U8 c
+EnsR   |int    |edit_distance  |NN const UV *src                   \
                                |NN const UV *tgt                   \
                                |const STRLEN x                     \
                                |const STRLEN y                     \
@@ -2922,8 +2934,8 @@ Apbm      |GV*    |gv_SVadd       |NULLOK GV *gv
 #if defined(PERL_IN_UTIL_C)
 s      |bool   |ckwarn_common  |U32 w
 #endif
-Apo    |bool   |ckwarn         |U32 w
-Apo    |bool   |ckwarn_d       |U32 w
+ApoP   |bool   |ckwarn         |U32 w
+ApoP   |bool   |ckwarn_d       |U32 w
 : FIXME - exported for ByteLoader - public or private?
 XEopMR |STRLEN *|new_warnings_bitfield|NULLOK STRLEN *buffer \
                                |NN const char *const bits|STRLEN size
@@ -2965,7 +2977,7 @@ Apnod     |Size_t |my_strlcat     |NULLOK char *dst|NULLOK const char *src|Size_t size
 Apnod  |Size_t |my_strlcpy     |NULLOK char *dst|NULLOK const char *src|Size_t size
 #endif
 
-Apdn   |bool   |isinfnan       |NV nv
+APpdn  |bool   |isinfnan       |NV nv
 p      |bool   |isinfnansv     |NN SV *sv
 
 #if !defined(HAS_SIGNBIT)
Unnamed repository; edit this file 'description' to name the repository.