ParagonIE_Sodium_Core32_SipHash::sipHash24( string $in, string $key ): string

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$instring

$keystring

Return value

string

Performance profile

How much work a call to ParagonIE_Sodium_Core32_SipHash::sipHash24() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Light

Touches nothing outside its own arguments.

Scaling

Scales with input

The body loops, so the work grows with what you pass in.

Instructions

148–246

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 295.

Plugin surface

None

Nothing here hands control to plugin code.

Called by

1

1 place in core call this, so the cost is paid more often than your own code shows.

What one call costs · 8 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost ParagonIE_Sodium_Core32_SipHash::sipHash24() can have, taken from its control-flow graph on PHP 8.5.

Uses · 7

• ParagonIE_Sodium_Core32_SipHash::strlen()
• ParagonIE_Sodium_Core32_Int64::__construct()ParagonIE_Sodium_Core32_Int64 constructor.
• ParagonIE_Sodium_Core32_Int64::fromReverseString()
• ParagonIE_Sodium_Core32_SipHash::substr()
• ParagonIE_Sodium_Core32_SipHash::sipRound()
• ParagonIE_Sodium_Core32_Int64::fromInts()
• ParagonIE_Sodium_Core32_SipHash::chrToInt()

Used by · 1

• ParagonIE_Sodium_Compat::crypto_shorthash()Calculates a SipHash-2-4 hash of a message for a given key.

Source code

View on Trac ↗View on GitHub ↗

76    public static function sipHash24($in, $key)77    {78        $inlen = self::strlen($in);79 80        # /* "somepseudorandomlygeneratedbytes" */81        # u64 v0 = 0x736f6d6570736575ULL;82        # u64 v1 = 0x646f72616e646f6dULL;83        # u64 v2 = 0x6c7967656e657261ULL;84        # u64 v3 = 0x7465646279746573ULL;85        $v = array(86            new ParagonIE_Sodium_Core32_Int64(87                array(0x736f, 0x6d65, 0x7073, 0x6575)88            ),89            new ParagonIE_Sodium_Core32_Int64(90                array(0x646f, 0x7261, 0x6e64, 0x6f6d)91            ),92            new ParagonIE_Sodium_Core32_Int64(93                array(0x6c79, 0x6765, 0x6e65, 0x7261)94            ),95            new ParagonIE_Sodium_Core32_Int64(96                array(0x7465, 0x6462, 0x7974, 0x6573)97            )98        );99 100        # u64 k0 = LOAD64_LE( k );101        # u64 k1 = LOAD64_LE( k + 8 );102        $k = array(103            ParagonIE_Sodium_Core32_Int64::fromReverseString(104                self::substr($key, 0, 8)105            ),106            ParagonIE_Sodium_Core32_Int64::fromReverseString(107                self::substr($key, 8, 8)108            )109        );110 111        # b = ( ( u64 )inlen ) << 56;112        $b = new ParagonIE_Sodium_Core32_Int64(113            array(($inlen << 8) & 0xffff, 0, 0, 0)114        );115 116        # v3 ^= k1;117        $v[3] = $v[3]->xorInt64($k[1]);118        # v2 ^= k0;119        $v[2] = $v[2]->xorInt64($k[0]);120        # v1 ^= k1;121        $v[1] = $v[1]->xorInt64($k[1]);122        # v0 ^= k0;123        $v[0] = $v[0]->xorInt64($k[0]);124 125        $left = $inlen;126        # for ( ; in != end; in += 8 )127        while ($left >= 8) {128            # m = LOAD64_LE( in );129            $m = ParagonIE_Sodium_Core32_Int64::fromReverseString(130                self::substr($in, 0, 8)131            );132 133            # v3 ^= m;134            $v[3] = $v[3]->xorInt64($m);135 136            # SIPROUND;137            # SIPROUND;138            $v = self::sipRound($v);139            $v = self::sipRound($v);140 141            # v0 ^= m;142            $v[0] = $v[0]->xorInt64($m);143 144            $in = self::substr($in, 8);145            $left -= 8;146        }147 148        # switch( left )149        #  {150        #     case 7: b |= ( ( u64 )in[ 6] )  << 48;151        #     case 6: b |= ( ( u64 )in[ 5] )  << 40;152        #     case 5: b |= ( ( u64 )in[ 4] )  << 32;153        #     case 4: b |= ( ( u64 )in[ 3] )  << 24;154        #     case 3: b |= ( ( u64 )in[ 2] )  << 16;155        #     case 2: b |= ( ( u64 )in[ 1] )  <<  8;

Changelog

Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 7.1.0 tag, from src/wp-includes/sodium_compat/src/Core32/SipHash.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.