Skip to content

random: Pass algorithm and state together as php_random_algo_with_state #13350

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Feb 25, 2024
Merged

random: Pass algorithm and state together as php_random_algo_with_state #13350

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e1e9f16
random: Remove `php_random_status`
TimWolla Dec 29, 2023
42f98a9
Introduce `php_random_algo_with_state`
TimWolla Feb 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions UPGRADING.INTERNALS
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,13 @@ PHP 8.4 INTERNALS UPGRADE NOTES
the new php_random_result struct, replacing the last_generated_size
member of the php_random_status struct and the generate_size member of
the php_random_algo struct.
- The php_random_status struct has been removed, since the previous change
reduced it to a single void* member containing the actual state, resulting
in needless indirection. Functions taking a php_random_algo struct pointer
and a php_random_status struct pointer as separate parameters now take a
single php_random_algo_with_state struct by value, making it easier to
pass around the state with its associated algorithm and thus reducing
the chance for mistakes.
- The CSPRNG API (php_random_(bytes|int)_*) is now provided by the new
and much smaller php_random_csprng.h header. The new header is included
in php_random.h for compatibility with existing users.
Expand Down
23 changes: 13 additions & 10 deletions ext/random/engine_combinedlcg.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,17 +32,17 @@
*/
#define MODMULT(a, b, c, m, s) q = s / a; s = b * (s - a * q) - c * q; if (s < 0) s += m

static void seed(php_random_status *status, uint64_t seed)
static void seed(void *status, uint64_t seed)
{
php_random_status_state_combinedlcg *s = status->state;
php_random_status_state_combinedlcg *s = status;

s->state[0] = seed & 0xffffffffU;
s->state[1] = seed >> 32;
}

static php_random_result generate(php_random_status *status)
static php_random_result generate(void *status)
{
php_random_status_state_combinedlcg *s = status->state;
php_random_status_state_combinedlcg *s = status;
int32_t q, z;

MODMULT(53668, 40014, 12211, 2147483563L, s->state[0]);
Expand All @@ -59,14 +59,17 @@ static php_random_result generate(php_random_status *status)
};
}

static zend_long range(php_random_status *status, zend_long min, zend_long max)
static zend_long range(void *status, zend_long min, zend_long max)
{
return php_random_range(&php_random_algo_combinedlcg, status, min, max);
return php_random_range((php_random_algo_with_state){
.algo = &php_random_algo_combinedlcg,
.status = status,
}, min, max);
}

static bool serialize(php_random_status *status, HashTable *data)
static bool serialize(void *status, HashTable *data)
{
php_random_status_state_combinedlcg *s = status->state;
php_random_status_state_combinedlcg *s = status;
zval t;

for (uint32_t i = 0; i < 2; i++) {
Expand All @@ -77,9 +80,9 @@ static bool serialize(php_random_status *status, HashTable *data)
return true;
}

static bool unserialize(php_random_status *status, HashTable *data)
static bool unserialize(void *status, HashTable *data)
{
php_random_status_state_combinedlcg *s = status->state;
php_random_status_state_combinedlcg *s = status;
zval *t;

for (uint32_t i = 0; i < 2; i++) {
Expand Down
39 changes: 21 additions & 18 deletions ext/random/engine_mt19937.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,14 +139,14 @@ static inline void mt19937_seed_state(php_random_status_state_mt19937 *state, ui
mt19937_reload(state);
}

static void seed(php_random_status *status, uint64_t seed)
static void seed(void *status, uint64_t seed)
{
mt19937_seed_state(status->state, seed);
mt19937_seed_state(status, seed);
}

static php_random_result generate(php_random_status *status)
static php_random_result generate(void *status)
{
php_random_status_state_mt19937 *s = status->state;
php_random_status_state_mt19937 *s = status;
uint32_t s1;

if (s->count >= MT_N) {
Expand All @@ -164,14 +164,17 @@ static php_random_result generate(php_random_status *status)
};
}

static zend_long range(php_random_status *status, zend_long min, zend_long max)
static zend_long range(void *status, zend_long min, zend_long max)
{
return php_random_range(&php_random_algo_mt19937, status, min, max);
return php_random_range((php_random_algo_with_state){
.algo = &php_random_algo_mt19937,
.status = status,
}, min, max);
}

static bool serialize(php_random_status *status, HashTable *data)
static bool serialize(void *status, HashTable *data)
{
php_random_status_state_mt19937 *s = status->state;
php_random_status_state_mt19937 *s = status;
zval t;

for (uint32_t i = 0; i < MT_N; i++) {
Expand All @@ -186,9 +189,9 @@ static bool serialize(php_random_status *status, HashTable *data)
return true;
}

static bool unserialize(php_random_status *status, HashTable *data)
static bool unserialize(void *status, HashTable *data)
{
php_random_status_state_mt19937 *s = status->state;
php_random_status_state_mt19937 *s = status;
zval *t;

/* Verify the expected number of elements, this implicitly ensures that no additional elements are present. */
Expand Down Expand Up @@ -251,8 +254,8 @@ PHPAPI void php_random_mt19937_seed_default(php_random_status_state_mt19937 *sta
/* {{{ Random\Engine\Mt19937::__construct() */
PHP_METHOD(Random_Engine_Mt19937, __construct)
{
php_random_engine *engine = Z_RANDOM_ENGINE_P(ZEND_THIS);
php_random_status_state_mt19937 *state = engine->status->state;
php_random_algo_with_state engine = Z_RANDOM_ENGINE_P(ZEND_THIS)->engine;
php_random_status_state_mt19937 *state = engine.status;
zend_long seed, mode = MT_RAND_MT19937;
bool seed_is_null = true;

Expand Down Expand Up @@ -290,12 +293,12 @@ PHP_METHOD(Random_Engine_Mt19937, __construct)
/* {{{ Random\Engine\Mt19937::generate() */
PHP_METHOD(Random_Engine_Mt19937, generate)
{
php_random_engine *engine = Z_RANDOM_ENGINE_P(ZEND_THIS);
php_random_algo_with_state engine = Z_RANDOM_ENGINE_P(ZEND_THIS)->engine;
zend_string *bytes;

ZEND_PARSE_PARAMETERS_NONE();

php_random_result generated = engine->algo->generate(engine->status);
php_random_result generated = engine.algo->generate(engine.status);
if (EG(exception)) {
RETURN_THROWS();
}
Expand Down Expand Up @@ -329,7 +332,7 @@ PHP_METHOD(Random_Engine_Mt19937, __serialize)

/* state */
array_init(&t);
if (!engine->algo->serialize(engine->status, Z_ARRVAL(t))) {
if (!engine->engine.algo->serialize(engine->engine.status, Z_ARRVAL(t))) {
zend_throw_exception(NULL, "Engine serialize failed", 0);
RETURN_THROWS();
}
Expand Down Expand Up @@ -372,7 +375,7 @@ PHP_METHOD(Random_Engine_Mt19937, __unserialize)
zend_throw_exception_ex(NULL, 0, "Invalid serialization data for %s object", ZSTR_VAL(engine->std.ce->name));
RETURN_THROWS();
}
if (!engine->algo->unserialize(engine->status, Z_ARRVAL_P(t))) {
if (!engine->engine.algo->unserialize(engine->engine.status, Z_ARRVAL_P(t))) {
zend_throw_exception_ex(NULL, 0, "Invalid serialization data for %s object", ZSTR_VAL(engine->std.ce->name));
RETURN_THROWS();
}
Expand All @@ -392,9 +395,9 @@ PHP_METHOD(Random_Engine_Mt19937, __debugInfo)
}
ZVAL_ARR(return_value, zend_array_dup(engine->std.properties));

if (engine->algo->serialize) {
if (engine->engine.algo->serialize) {
array_init(&t);
if (!engine->algo->serialize(engine->status, Z_ARRVAL(t))) {
if (!engine->engine.algo->serialize(engine->engine.status, Z_ARRVAL(t))) {
zend_throw_exception(NULL, "Engine serialize failed", 0);
RETURN_THROWS();
}
Expand Down
31 changes: 17 additions & 14 deletions ext/random/engine_pcgoneseq128xslrr64.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,14 +43,14 @@ static inline void seed128(php_random_status_state_pcgoneseq128xslrr64 *s, php_r
step(s);
}

static void seed(php_random_status *status, uint64_t seed)
static void seed(void *status, uint64_t seed)
{
seed128(status->state, php_random_uint128_constant(0ULL, seed));
seed128(status, php_random_uint128_constant(0ULL, seed));
}

static php_random_result generate(php_random_status *status)
static php_random_result generate(void *status)
{
php_random_status_state_pcgoneseq128xslrr64 *s = status->state;
php_random_status_state_pcgoneseq128xslrr64 *s = status;

step(s);

Expand All @@ -60,14 +60,17 @@ static php_random_result generate(php_random_status *status)
};
}

static zend_long range(php_random_status *status, zend_long min, zend_long max)
static zend_long range(void *status, zend_long min, zend_long max)
{
return php_random_range(&php_random_algo_pcgoneseq128xslrr64, status, min, max);
return php_random_range((php_random_algo_with_state){
.algo = &php_random_algo_pcgoneseq128xslrr64,
.status = status,
}, min, max);
}

static bool serialize(php_random_status *status, HashTable *data)
static bool serialize(void *status, HashTable *data)
{
php_random_status_state_pcgoneseq128xslrr64 *s = status->state;
php_random_status_state_pcgoneseq128xslrr64 *s = status;
uint64_t u;
zval z;

Expand All @@ -82,9 +85,9 @@ static bool serialize(php_random_status *status, HashTable *data)
return true;
}

static bool unserialize(php_random_status *status, HashTable *data)
static bool unserialize(void *status, HashTable *data)
{
php_random_status_state_pcgoneseq128xslrr64 *s = status->state;
php_random_status_state_pcgoneseq128xslrr64 *s = status;
uint64_t u[2];
zval *t;

Expand Down Expand Up @@ -142,8 +145,8 @@ PHPAPI void php_random_pcgoneseq128xslrr64_advance(php_random_status_state_pcgon
/* {{{ Random\Engine\PcgOneseq128XslRr64::__construct */
PHP_METHOD(Random_Engine_PcgOneseq128XslRr64, __construct)
{
php_random_engine *engine = Z_RANDOM_ENGINE_P(ZEND_THIS);
php_random_status_state_pcgoneseq128xslrr64 *state = engine->status->state;
php_random_algo_with_state engine = Z_RANDOM_ENGINE_P(ZEND_THIS)->engine;
php_random_status_state_pcgoneseq128xslrr64 *state = engine.status;
zend_string *str_seed = NULL;
zend_long int_seed = 0;
bool seed_is_null = true;
Expand Down Expand Up @@ -191,8 +194,8 @@ PHP_METHOD(Random_Engine_PcgOneseq128XslRr64, __construct)
/* {{{ Random\Engine\PcgOneseq128XslRr64::jump() */
PHP_METHOD(Random_Engine_PcgOneseq128XslRr64, jump)
{
php_random_engine *engine = Z_RANDOM_ENGINE_P(ZEND_THIS);
php_random_status_state_pcgoneseq128xslrr64 *state = engine->status->state;
php_random_algo_with_state engine = Z_RANDOM_ENGINE_P(ZEND_THIS)->engine;
php_random_status_state_pcgoneseq128xslrr64 *state = engine.status;
zend_long advance = 0;

ZEND_PARSE_PARAMETERS_START(1, 1)
Expand Down
4 changes: 2 additions & 2 deletions ext/random/engine_secure.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@

#include "Zend/zend_exceptions.h"

static php_random_result generate(php_random_status *status)
static php_random_result generate(void *status)
{
zend_ulong r = 0;

Expand All @@ -37,7 +37,7 @@ static php_random_result generate(php_random_status *status)
};
}

static zend_long range(php_random_status *status, zend_long min, zend_long max)
static zend_long range(void *status, zend_long min, zend_long max)
{
zend_long result = 0;

Expand Down
11 changes: 7 additions & 4 deletions ext/random/engine_user.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,9 @@
#include "php.h"
#include "php_random.h"

static php_random_result generate(php_random_status *status)
static php_random_result generate(void *status)
{
php_random_status_state_user *s = status->state;
php_random_status_state_user *s = status;
uint64_t result = 0;
size_t size;
zval retval;
Expand Down Expand Up @@ -65,9 +65,12 @@ static php_random_result generate(php_random_status *status)
};
}

static zend_long range(php_random_status *status, zend_long min, zend_long max)
static zend_long range(void *status, zend_long min, zend_long max)
{
return php_random_range(&php_random_algo_user, status, min, max);
return php_random_range((php_random_algo_with_state){
.algo = &php_random_algo_user,
.status = status,
}, min, max);
}

const php_random_algo php_random_algo_user = {
Expand Down
35 changes: 19 additions & 16 deletions ext/random/engine_xoshiro256starstar.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,27 +102,30 @@ static inline void seed64(php_random_status_state_xoshiro256starstar *state, uin
seed256(state, s[0], s[1], s[2], s[3]);
}

static void seed(php_random_status *status, uint64_t seed)
static void seed(void *status, uint64_t seed)
{
seed64(status->state, seed);
seed64(status, seed);
}

static php_random_result generate(php_random_status *status)
static php_random_result generate(void *status)
{
return (php_random_result){
.size = sizeof(uint64_t),
.result = generate_state(status->state),
.result = generate_state(status),
};
}

static zend_long range(php_random_status *status, zend_long min, zend_long max)
static zend_long range(void *status, zend_long min, zend_long max)
{
return php_random_range(&php_random_algo_xoshiro256starstar, status, min, max);
return php_random_range((php_random_algo_with_state){
.algo = &php_random_algo_xoshiro256starstar,
.status = status,
}, min, max);
}

static bool serialize(php_random_status *status, HashTable *data)
static bool serialize(void *status, HashTable *data)
{
php_random_status_state_xoshiro256starstar *s = status->state;
php_random_status_state_xoshiro256starstar *s = status;
zval t;

for (uint32_t i = 0; i < 4; i++) {
Expand All @@ -133,9 +136,9 @@ static bool serialize(php_random_status *status, HashTable *data)
return true;
}

static bool unserialize(php_random_status *status, HashTable *data)
static bool unserialize(void *status, HashTable *data)
{
php_random_status_state_xoshiro256starstar *s = status->state;
php_random_status_state_xoshiro256starstar *s = status;
zval *t;

/* Verify the expected number of elements, this implicitly ensures that no additional elements are present. */
Expand Down Expand Up @@ -180,8 +183,8 @@ PHPAPI void php_random_xoshiro256starstar_jump_long(php_random_status_state_xosh
/* {{{ Random\Engine\Xoshiro256StarStar::jump() */
PHP_METHOD(Random_Engine_Xoshiro256StarStar, jump)
{
php_random_engine *engine = Z_RANDOM_ENGINE_P(ZEND_THIS);
php_random_status_state_xoshiro256starstar *state = engine->status->state;
php_random_algo_with_state engine = Z_RANDOM_ENGINE_P(ZEND_THIS)->engine;
php_random_status_state_xoshiro256starstar *state = engine.status;

ZEND_PARSE_PARAMETERS_NONE();

Expand All @@ -192,8 +195,8 @@ PHP_METHOD(Random_Engine_Xoshiro256StarStar, jump)
/* {{{ Random\Engine\Xoshiro256StarStar::jumpLong() */
PHP_METHOD(Random_Engine_Xoshiro256StarStar, jumpLong)
{
php_random_engine *engine = Z_RANDOM_ENGINE_P(ZEND_THIS);
php_random_status_state_xoshiro256starstar *state = engine->status->state;
php_random_algo_with_state engine = Z_RANDOM_ENGINE_P(ZEND_THIS)->engine;
php_random_status_state_xoshiro256starstar *state = engine.status;

ZEND_PARSE_PARAMETERS_NONE();

Expand All @@ -204,8 +207,8 @@ PHP_METHOD(Random_Engine_Xoshiro256StarStar, jumpLong)
/* {{{ Random\Engine\Xoshiro256StarStar::__construct */
PHP_METHOD(Random_Engine_Xoshiro256StarStar, __construct)
{
php_random_engine *engine = Z_RANDOM_ENGINE_P(ZEND_THIS);
php_random_status_state_xoshiro256starstar *state = engine->status->state;
php_random_algo_with_state engine = Z_RANDOM_ENGINE_P(ZEND_THIS)->engine;
php_random_status_state_xoshiro256starstar *state = engine.status;
zend_string *str_seed = NULL;
zend_long int_seed = 0;
bool seed_is_null = true;
Expand Down
Loading