OP_SUBSTR_LEFT - a specialised OP_SUBSTR variant

[richardleach]

This commit adds OP_SUBSTR_NIBBLE and associated machinery for fast handling of the constructions:

    substr EXPR,0,LENGTH,''

and

    substr EXPR,0,LENGTH

Where EXPR is a scalar lexical, the OFFSET is zero, and either there is no REPLACEMENT or it is the empty string. LENGTH can be anything that OP_SUBSTR supports. These constraints allow for a very stripped back and optimised version of pp_substr.

The primary motivation was for situations where a scalar, containing some network packets or other binary data structure, is being parsed piecemeal. Nibbling away at the scalar can be useful when you don't know how exactly it will be parsed and unpacked until you get started. It also means that you don't need to worry about correctly updating a separate offset variable.

This operator also turns out to be an efficient way to (destructively) break an expression up into fixed size chunks. For example, given:

my $x = ''; my $str = "A"x100_000_000;

This code:

$x = substr($str, 0, 5, "") while ($str);

is twice as fast as doing:

for ($pos = 0; $pos < length($str); $pos += 5) {
    $x = substr($str, $pos, 5);
}

Compared with blead, $y = substr($x, 0, 5) runs 40% faster and $y = substr($x, 0, 5, '') runs 45% faster.

---

• This set of changes requires a perldelta entry, and I will add one shortly.

[leonerd]

A couple of small comments but overall nothing troubling-looking here.

I wonder a bit about the name though. I've usually seen the word "nibble" to mean a half-byte; i.e. a 4-bit value. I wondered if that is what is going on here at first. If there are other candidate names to call it, perhaps something else would be better? Not a huge problem though.

[richardleach]

How about substr_chop, since a big part of its design is being a fast route for getting to Perl_sv_chop?

Food related alternatives: substr_peck? substr_graze? substr_smidgen? substr_julienne? substr_shuck? substr_heel, like the end of a loaf? Non-foodie: substr_shave?

[richardleach]

Not sure what's going on with the ABRT test failures. Don't get them locally. ./perl -Ilib t/perf/benchmarks.t seemingly only uses 8MB of memory, so running out of memory doesn't seem to be the cause.

[richardleach]

Not sure what's going on with the ABRT test failures.

Looks like an op_private flags assertion. I'll dig into it soon.

[richardleach]

I'm rebasing and renaming it to SUBSTR_CHOP.

[leonerd]

Doesn't perl's chop() function eat from the other end though?

[richardleach]

The Perl chop takes from the end, but Perl_sv_chop takes from the front. (I don't know who we have to thank for that amazing piece of naming.) The pp_ function for this op calls Perl_sv_chop.

[jkeenan]

@richardleach , merge conflicts ^^

[leonerd]

The Perl chop takes from the end, but Perl_sv_chop takes from the front. (I don't know who we have to thank for that amazing piece of naming.) The pp_ function for this op calls Perl_sv_chop.

Oh wow. Huh. In that case, might as well call this one SUBSTR_CHOP indeed then.

Otherwise my thoughts were going to be something like SUBSTR_PREFIX but that isn't much more descriptive.

[Grinnz]

Consider ltrim, with inspiration from PHP and Redis (or lstrip a la Ruby/Python but that sounds more whitespace-specific). Though it is also unrelated to builtin::trim, I think it's a bit more descriptive at least

[richardleach]

Consider ltrim, with inspiration from PHP and Redis (or lstrip a la Ruby/Python but that sounds more whitespace-specific). Though it is also unrelated to builtin::trim, I think it's a bit more descriptive at least

Hmmm, I'm not sure about this. It seems only more descriptive to someone who already is familiar with ltrim, otherwise it's likely to lead to confusion with builtin:trim or even reducing the other end of the string. There might be some confusion around _CHOP, but at least the connection to sv_chop is there.

[tonycoz]

Maybe OP_SUBSTR_LEFT borrowing from perl's BASIC antecedents.

[richardleach]

Maybe OP_SUBSTR_LEFT borrowing from perl's BASIC antecedents.

Ok, that seems straightforward enough without colliding with Perlspace. Will rename.

[richardleach]

OP renamed to OP_SUBSTR_LEFT and, I think, review comments all addressed.

[tonycoz]

You're checking SvROK(sv) before calling SvGETMAGIC() which would be incorrect if sv is tied - I think I would have caught that before, but maybe I missed it.

You could move the reference check after the SvGETMAGIC() inside the do_chop conditional to fix it (and better match pp_substr).

[bulk88]

BINOPs like PP

if(index($str, 'ZZZZZZ) == -1) { }
XS have no concpext of "G_BOOL" content. There is definently a need to deliver bool contet, from runloop to the XS.