better document macros taking literal strings

When giving a function-style prototype for a macro taking a literal string
parameter, put a string literal in place of a type for that parameter.
This goofy appearance makes it obvious that this isn't really a function,
and clues the reader in that the parameter can't actually be an arbitrary
expression of the right type.  Also change the nonsensical "NUL-terminated
literal string" to "literal string" to describe these parameters.
Fixes [perl #116286].

document IO::Select error detection

prevent invalid memory access in S_check_uni (RT #132433)

fix do dir returning no $!

do()ing a directory was returning false/empty string in $!, which isn't
an error, yet documentation says $! should have the error code in it.
Fix this by returning EISDIR for dirs, and EINVAL for block devices.
[perl #125774]

Remove "errno = 0" and comment added in b2da7ead68, since now there is no
scenario where errno is uninitialized, since the dir and block device
failure branches now set errno, where previously they didn't.

avoid reading errno twice in a row

Reading errno can involve calling a function and indirecting through
its result, so cache the value of errno where possible.  [perl #122096]

suppress clang warning in inode number handling

The gcc warning was already suppressed, but clang needs a different
formulation.

teach makedef.pl about PL_keyword_plugin_mutex

This fixes t/porting/globvar.t.

perldelta for reënabling of CV optimization

Revert "Temporarily revert CV-in-stash optimisation"

This reverts commit 6eed25e2537643b77650cb3e4514ec9dc2e97d74.

Revert "Simplify _MEM_WRAP_NEEDS_RUNTIME_CHECK()"

This reverts commit 004073bac990d90244eb463f435c52d4040b36df.

fix MEM_SIZE_MAX definition

perldelta entry for perlguts revision

better documentation of reference counts

Merge wrap_keyword_plugin() into blead

perldelta entry for wrap_keyword_plugin

test wrap_keyword_plugin (RT #132413)

add wrap_keyword_plugin function (RT #132413)

avoid runtime module loading in File::Spec

Incidentally remove the ->_cwd method from the subclassing interface of
File::Spec::Unix, in favour of direct calls to Cwd::getcwd().

return inode numbers as strings where necessary

We previously used a lossy conversion of inode numbers to floating point,
where they're too big to fit the IV/UV format.  That sucks; a rounded
inode number is nearly useless.  Instead, fall back to returning a
string of decimal digits.  That preserves the entire value, for code
that looks at it in the right way, and collapses to the former fallback
in other situations.

[MERGE] Remove unnecessary use of 'use vars'

Document the removal of use vars from sources

Replace multiple 'use vars' by 'our' in regen.

then run ./regen_perly.pl to update perly files

Replace multiple 'use vars' by 'our' in t

Replace multiple 'use vars' by 'our' in utils

Using vars pragma is discouraged and has been superseded by 'our' declarations
available in Perl v5.6.0 or later.

Replace multiple 'use vars' by 'our' in ext

Using vars pragma is discouraged and has been superseded by 'our' declarations
available in Perl v5.6.0 or later.

This commit is about replacing the usage of 'vars' pragma
by 'our' in 'ext' directory.

Replace multiple 'use vars' by 'our' in lib

Using vars pragma is discouraged and has been superseded by 'our' declarations
available in Perl v5.6.0 or later.

This commit is about replacing the usage of 'vars' pragma
by 'our' in 'lib' directory.

Replace multiple 'use vars' by 'our' in dist

Using vars pragma is discouraged and has been superseded
by 'our' declarations available in Perl v5.6.0 or later.

Additionally using 'vars' pragma increase the memory consumption of a
program by about 700 kB for no good reason.

This commit is about replacing the usage of 'vars' pragma
by 'our' in blead where it makes sense. ( leaving 'cpan' directory
outside of the scope )

-- using vars
perl -e 'use vars qw(@ISA $AUTOLOAD $VERSION); print qx{grep RSS /proc/$$/status} '
VmRSS:        2588 kB

-- using our instead
perl -e 'our (@ISA, $AUTOLOAD, $VERSION); print qx{grep RSS /proc/$$/status} '
VmRSS:        1864 kB

locale.c: Simplify code in Perl_langinfo()

Instead of a switch() statement we can use 'foo ? bar : baz;'

store AV iterator as mg_len in more cases

The iterator of an AV is an IV value attached to the AV via magic.
It may be stored in the space used by mg_len, or it may be stored in
separately allocated space referenced by mg_ptr.  The former is more
efficient, so should be preferred.  The original code for AV iterators
would use mg_len if IV was (the same size as) I32, because mg_len was of
type I32.  Since then mg_len has been increased to type SSize_t, but the
conditional about how AV iterators are stored wasn't updated to match.
As a result, on the now very common 64-bit builds we were missing out on
the opportunity to use the more efficient form of storage.  This commit
updates the condition about how AV iterators are stored, to take account
of the new type.

In principle AV iterators ought to be of type SSize_t, and thus *always*
storable as mg_len.  But Perl_av_iter_p() is in the public API with
its IV* return type, so there is a compatibility issue to address in
changing that.

Add support for --help and --version in perlbug

RT 130032: Thanks to Houston Perl Mongers for contributing to this work at
our monthly meeting!

NPD

PACKAGING: add patchlevel.h doc entry

.gitignore: git should also ignore *.bak files

Handle Linux containers' use of 0 for PPID with orphaned procs in t/op/getppid.t

Bug 130143: Travis-ci has moved to using docker for their testing environments.
However a Docker environment has multiple process trees so therefore orphaned
processes often get a Parent PID of 0 not 1. The previous unit test for this
considered 0 to be a failure. There is now special code to handle this exception
in the unit test for getppid.

Adjust travis.yaml configuration for blead merges.

- Unset PERL_BUILD_PACKAGING during builds
- Set JOBS to indicate how parallel we want builds to be (4)
- Assure tags are fetched to allow t/porting/cmp_version.t to build.

experimental::lexical_topic is no longer a warning category, it's a fatal compile-time error

Make VMS::Stdio declare PERL_EXT.

We haven't been able to compile this extension since f55ac4a45513
because strBEGINs is not in the API and until now it has not
depended on anything not in the API.  So declare the fact that
it's a core extension and can use core-only macros.

Update Unicode-Collate to CPAN version 1.21

  [DELTA]

1.21  Sat Nov  4 10:49:19 2017
    - mklocale: [rt.cpan.org #121664] . removed from @INC (take 2)
    - DUCET is updated (for Unicode 9.0.0) as Collate/allkeys.txt.
      * Please notice that allkeys.txt will be overwritten if you have had
        other allkeys.txt already.
    - The default UCA_Version is 34.
    - added tangut.t in t.
    - Locale/*.pl and CJK/Korean.pm are updated.

1.20  Fri Nov  3 11:50:21 2017
    - XS: [rt.cpan.org #121664] . removed from @INC
    - U::C::Locale newly supports locales: dsb, lkt.

parse yada-yada only as a statement

Commit f5727a1c71878a34f6255eb1a506c0b21af7d36f tried to make yada-yada
be parsed consistently as a term expression, but actually things are
more complicated than that.  The tokeniser didn't accept yada-yada in
the right contexts to make it usable as an expression, and changing
that would require decisions on resolving ambiguities between yada-yada
and flip-flop.  It's also documented as being a statement rather than
an expression, though with some incorrect information about ambiguities.

Overall it looks more like the intent was for yada-yada to be a statement.
This commit makes it grammatically treated as such, and also fixes up
the dubious parts of the documentation.  [perl #132150]

sv.c: Fix typo in comment

malloc.c: Fix typo in comment

lib/locale.t: Clarify test name

handy.h: Clarify comment

locale.c: strerror_l() not fool proof

Commit 7aaa36b196e5a478a3d1bd32506797db7cebf0b2 changed to use
strerror_l() if available on the platform.  But there is a potential bug
with this on threaded perls.  The code uses strerror_l() when it needs
the answer on a locale that isn't necessarily the current one.  But it
uses plain strerror() when the locale is known to be the current one.
Plain strerror() isn't necessarily thread-safe.  However, on systems
that have strerror_r(), reentr.h has caused our apparent call to plain
strerror() to instead call the thread-safe strerror_r() under the hood.
So there is no bug on unthreaded perls nor on ones that have
strerror_r().

This commit fixes the bug on threaded builds which have strerror_l() but
not strerror_r().  It does this by using strerror_l() for everything,
and constructing a locale object that is the current locale to use when
the locale doesn't need to be changed.  This is somewhat more work than
the alternative above does, so that one is used if available.

No changes are made to how it works on systems that don't have
strerror_l().

Some systems have deprecated strerror_r().  reentr.h does not use it on
such systems.  The reason for the deprecation, we would hope, may be
that the plain strerror() is implemented thread-safely.  We don't know
that, so we just assume that the plain version is thread-unsafe.

We do have tests that try to find races here, but they haven't shown
any.  It could be that systems that are advanced enough to have
strerror_l() also have strerror_r().

locale.c: Move a #define to earlier in the file

This is in prep for a future commit which needs it earlier

locale.c: Add #define's

The previous commit added arrays of locale categories.  This commit
creates compile-time mappings from the category number to the index it
has in the array.  It also changes to use the #define for the index of
LC_ALL in places it is expected to be defined.  This causes bugs in this
logic to be found at compile time on systems that don't have LC_ALL.

locale.c: Remove many #if conditionals

locale.c is full of compiler conditionals because platforms vary widely
(or have in the past) in what categories they use.  Prior to this
commit, there were many sections of code which had copies of the same
constructs which were #ifdef'd so they'd run only on the categories that
are to be used in this build.

This duplication creates the opportunity for changes to get applied to
only some of the places that they should, and also makes it hard to
read.

This commit adds two parallel arrays that can map a category to/from its
name, and are defined with each element conditionally compiled in based
on the needs of the build.  Doing the conditionals during array
construction means that most of the other conditionals can be replaced
by looping through the arrays.  Thus the duplicated code is eliminated,
as well as almost 200 lines in this file.

Most of these loops get executed only at process initialization, so the
slight performance hit is inconsequential.

Revert "perl.h: Use STMT_START { ... } STMT_END"

This reverts commit 11b2cef65dac01e8723c9a6f6e640665cb752a2c.

DECLARE_STORE_LC_NUMERIC_SET_TO_NEEDED seems to be unused, but the
previous commit made it a syntax error (unmatched '{').

It also doesn't make sense to wrap what is supposed to be a declaration
in a { } block.

Fix missing close brace before STMT_END

The macro isn't actually used anywhere (in core or on CPAN)

locale.c: Avoid potential read beyond buffer end

I noticed this flaw by code reading; I doubt that it's exploitable.
foldEQ assumes that both operands are at least as long as its length
parameter.  In this case, it's possible that the codeset returned by
nl_langinfo is shorter than 5, in which case, it would try to access the
extra characters in the heap.  Real codesets tend to be longer than
this, so an attacker would likely have to install a locale with a
made-up codeset whose name is shorter.

Even the C locale is longer: "ANSI_X3.4-1968"

locale.c: Clarify some debug statements

locale.c: Slight refactor

This makes savepv() part of the expressions instead of a separate
statement.

locale.c: Use REPLACEMENT_CHARACTER as a test

This is trying to determine if the locale is UTF-8.  The easiest way to
tell is if the codeset returned by nl_langinfo says UTF-8, but if that
fails or nl_langinfo() is not present on the system, a fallback method
is to use the libc routines to convert a known byte string to code point
and see if that matches the expected Unicode code point.  Prior to this
patch, the byte string representing HYPHEN was used.  That's probably
good enough, but we can do better with no extra work.  This commit
changes to use the REPLACEMENT CHARACTER instead.  That is a Unicode
concept.  The chances of a non-UTF-8 locale taking the UTF-8 byte string
for the REPLACEMENT and evaluating to REPLACEMENT are vanishingly small.

locale.c: Avoid extra call to mbtowc()

This is done only when debugging, but in some locales that have shift
states, the extra call could blow up.  Instead save the result of the
mbtowc() call we care about.

locale.c: Add macro

This adds STRLENs() where the argument must be a literal string
constant.

This may deserve wider applicability, but in case it doesn't, I'm making
it local to just this file.

locale.c: Rmv extraneous detail from comment

This comment contains a list of code points that are unusual, but it
also included ones that are standard, which made me keep looking to see
why they were unusual, each time realizing in the end that they were
not.

embed.fnc: Change fcn from A to X

This function is marked as accessible anywhere, but experimental, and
so is changeable at any time without notice, and its name begins with an
underscore to indicate its private nature.  I didn't know at the time I
wrote it that we have an existing mechanism to deal with functions whose
only use should be a public macro.  This changes to use that mechanism.

Change name of internal function

Following on the previous commit, this changes the name of the function
that changes the variable to be in sync with it.

Change name of locale per-interpreter variable

The real purpose of this internal variable is to give the name of the
locale that is the underlying one for the C program.  Various macros
already indicate that.  This furthers the process.

POSIX.xs is PERL_EXT

Specifying so automatically gets the reentrant versions of various libc
functions in threaded perls, lowering race condition odds.

Bump version of B/t/OptreeCheck to 0.16

Bump version of B/O.pm to 1.03

perl.h: Use STMT_START { ... } STMT_END

This should be used in macros that have statements.

perl.h: White-space only

Indent some nested #defines, remove an extra empty line

toke.c: Add comment

Dest buffer needs to be bigger for utf16_to_utf8()

These undocumented functions require the destination buffer to have the
worst case size.  However that size (previously listed as 3/2 * input)
is wrong for EBCDIC.  Correct the comments, and the single use of these
in core.

These functions do not have a way to avoid overflowing, which strikes me
as wrong.

_byte_dump_string(): Don't output leading space

This changes this function to not put an initial space character in the
returned string.

POSIX.xs: Move constant tests out of loop

Whether or not a locale is in UTF-8 doesn't change in this loop;
calculate it once, prior to the loop

numeric.c: Refactor #if #else in Perl_my_aotf

This simplifies things, eliminating nested #if's

numeric.c: Rename some variables

The new names are clearer.

Perl_locale(): Refactor for clarity

This code is full of 'if's interrupted by #ifdefs, which makes it hard
to read.  Changing it to a switch() makes it much easier to understand.

locale.c:sync_locale(): Add debugging info

locale.c:sync_locale(): Rmv useless call

This was changing to use the locale's radix, but this is unnecessary for
the later things in this function, and those change things to use dot,
so this call is useless.

locale.c: Use new nl_langinfo equivalent

This converts the final plain nl_langinfo() function call in locale.c to
use the new equivalent that is more thread safe, and you don't have to
free the returned memory.  There was an unlikely leak before this, if
the return was somehow "".

locale.c: Rmv erroneous complement operator

The extra '!' that snuck in there caused this code to not work properly.
Fortunately, it doesn't get used except as a last resort, and that
apparently hasn't happened so as to have gotten reported from the field.
A test can't be added because it would only occur on a system that had
bad locales.

locale.c: Refactor locale macros

This standardizes things to make things easier to understand and prepare
for future commits

locale.c: Convert setlocale() calls to macros

This will be useful in future commits

locale.c: Change static fcn name

The new name more closely reflects what it does

locale.c: Refactor static fcn to save work

This adds a parameter to the function that sets the radix character for
floating point numbers.  We know that the radix by default is a dot, so
no need to calculate it in that case.

This code was previously using localeconv() to find the locale's decimal
point.  The just added my_nl_langinfo() fcn does the same with an easier
API, and is more thread safe, and automatically switches to use
localeconv() when n nl_langinfo() isn't available, so revise the
conditional compilation directives that previously were necessary, and
collapse directives that were unnecessarily nested.

And adjust indentation

locale.c: Create extended internal Perl_langinfo()

This extended version allows it to be called so that it uses the current
locale for the LC_NUMERIC, instead of toggling to the underlying one.
(This can be useful when in the middle of things.)

This ability won't be used until the next commit

locale.c: Rmv redundant fcn call

This function is called as part of the call made in the line before.  No
need to do it twice.

locale.c: White-space, comment, rearrange some #else

This file is full of conditional compilation, due to the fact that
locale support has been highly variable in the OSes Perl has operated
on.  This commit properly indents nested compiler directives, and makes
sure there is a blank line between the directives and real code.  I find
that much easier to read.  It also re-orders some

    #ifdef some_feature
        Many lines of code handling feature
    #else
        1 to 3 lines of trivial code to avoid compilation warnings
    #endif

to

    #ifndef some_feature
        1 to 3 lines of trivial code to avoid compilation warnings
    #else
        Many lines of code handling feature
    #endif

Otherwise the trivial code may be hundreds of lines from the original
'#if', which makes it hard to grok.

This commit also clarifies and fixes typos in comments, and removes some
obsolete comments.

Merge branch 'BO' into blead

Make it simpler to divine if modules are there because of loading B/O or
because the actual program used them.

NPD

ext/B/t/strict.t: Assure B.pm and O.pm pass strict and warnings checks.

We need to test these in unit tests since they do not load these modules to
prevent pollution of the stash in compilers.

Fix warnings (used once) for O.pm

Fix warnings (used once) for B.pm

Remove unnecessary module loads from B and O

This commit removes multiple unnecessary modules so that
perl -MO= can hand back to compile as cleanly as possible.

This change caused significant jitter in tests for B::Concise. While updating
the test to the new reality, OptreeCheck.pm was corrected to stop stripping
regexes off $got when it started failing so it would be easier to see where
the failure happened.

Simplify travis.yml config for Continuous Integration

The goal is to have a quick smoke on travis smokers
to plug in short future CI for any new commits/PR.

NPD

restore error message for unterminated strings

The previous strchr/memchr changes inadvertently broke the error message
for perl -e '"'. Instead of

    Can't find string terminator '"' anywhere before EOF

it became

    Can't find string terminator """ anywhere before EOF

disable t/porting/authors.t for distro packaging

NPD

disable t/porting/podcheck.t for distro packaging

NPD

Allow custom PL_strtab hash in perl_construct.

Such a patch allow PL_strtab optimizations at compile time
to statically malloc PL_strtab to an optimized size at startup.

Custom entries can then be added (after PL_hash_seed initialization)
without risking the hash to be reset by perl_construct.

PERL_STRLEN_ROUNDUP: parenthesize macro parameter

Also:
- factor out common expression
- remove redundant double parens
- add spaces to expression

toke.c: Fix wrong use of memrchr

This was a replacement of strchr(), so should not have used the
find-right-most memrchr.

This was spotted by Christian Hansen.  I don't know what the
implications are, but thought I should get a fix in immediately.

Blead breaks DBD::SQLite

This partially reverts 0f12654f40.

The particular spot being reverted is in gv.c, and the change did not
take into account all the nuances involved, so simply revert it.  I
believe what is happening is that a negative number is being generated
and treated as a very large number.  Instead the code should retain the
original test that it was ok to do the subtraction, before actually
doing it.

Two fix-ups following b59bf0b288.

In one case, memEQs was missing a length parameter, and in the
other, two opening braces had been removed but only one closing
brace.

toke.c: use my_memrchr helper for portability [round 2]

compilation broken on darwin using clang

Use my_memrchr helper for portability

Recent commit '8725053bce' breaks darwin compilation.

We should use my_memrchr helper to avoid
portability issues, instead of calling
directly memrchr.

Merge branch 'convert strchr to memchr' into blead

Using C string functions on Perl strings doesn't work properly if they
contain embedded NULs.  This can happen with Perl program text, for
example, and even if the NUL is illegal, the generated diagnostics are
likely to be misleading as the parsing would have terminated
prematurely.

I have done an audit on core for cases where C string functions are used
in contexts where a Perl string is being processed.  This came down to
uses of strchr() and strrchr().  This branch changes many of them to
memchr() and memrchr() respectively.  Not all uses of these functions
need change, as there are places where C strings are what is being
processed, such as dealing with OS strings that are NUL terminated.
File paths and environ are two examples.

Also, memchr and memrchr tend to be faster than their str equivalents,
as they only need to look for one termination condition, and there may
be hardware assistance on some platforms.  Further, memrchr knows
exactly where to start looking, instead of having to find the NUL ending
the string (strrchr is likely to be implemented as iterating over the
string using strchr from the left, over and over until it fails).

I may have converted some str functions to mem ones unnecessarily, as I
didn't check in full detail if some were operating only on C strings, but
given that the mem ones are faster, this is OK

toke.c: Convert some strchr to memchr

This allows things to work properly in the face of embedded NULs.
See the branch merge message for more information.

toke.c use memBEGINs with prev commit