Remove ->last_unsafe from php_random_status

TimWolla · TimWolla · commit 687ca1441e6a · 2022-07-25T19:34:33.000+02:00
Whenever -&gt;last_unsafe is set to `true` an exception has been thrown. Thus we
can replace the check for `-&gt;last_unsafe` with a check for `EG(exception)`
which is a much more natural way to ommunicate an error up the chain.
diff --git a/ext/random/engine_mt19937.c b/ext/random/engine_mt19937.c
@@ -301,7 +301,7 @@ PHP_METHOD(Random_Engine_Mt19937, generate)
 
 	generated = engine->algo->generate(engine->status);
 	size = engine->status->last_generated_size;
-	if (engine->status->last_unsafe) {
+	if (EG(exception)) {
 		zend_throw_exception(spl_ce_RuntimeException, "Random number generation failed", 0);
 		RETURN_THROWS();
 	}
diff --git a/ext/random/engine_secure.c b/ext/random/engine_secure.c
@@ -29,9 +29,7 @@ static uint64_t generate(php_random_status *status)
 {
 	zend_ulong r = 0;
 
-	if (php_random_bytes_throw(&r, sizeof(zend_ulong)) == FAILURE) {
-		status->last_unsafe = true;
-	}
+	php_random_bytes_throw(&r, sizeof(zend_ulong));
 
 	return r;
 }
@@ -40,9 +38,7 @@ static zend_long range(php_random_status *status, zend_long min, zend_long max)
 {
 	zend_long result = 0;
 
-	if (php_random_int_throw(min, max, &result) == FAILURE) {
-		status->last_unsafe = true;
-	}
+	php_random_int_throw(min, max, &result);
 
 	return result;
 }
diff --git a/ext/random/engine_user.c b/ext/random/engine_user.c
@@ -31,7 +31,6 @@ static uint64_t generate(php_random_status *status)
 	zend_call_known_instance_method_with_0_params(s->generate_method, s->object, &retval);
 
 	if (EG(exception)) {
-		status->last_unsafe = true;
 		return 0;
 	}
 
@@ -51,7 +50,6 @@ static uint64_t generate(php_random_status *status)
 		}
 	} else {
 		zend_throw_error(NULL, "A random engine must return a non-empty string");
-		status->last_unsafe = true;
 		return 0;
 	}
 
diff --git a/ext/random/php_random.h b/ext/random/php_random.h
@@ -201,7 +201,6 @@ PHPAPI int php_random_int(zend_long min, zend_long max, zend_long *result, bool
 
 typedef struct _php_random_status_ {
 	size_t last_generated_size;
-	bool last_unsafe;
 	void *state;
 } php_random_status;
 
diff --git a/ext/random/random.c b/ext/random/random.c
@@ -96,7 +96,7 @@ static inline uint32_t rand_range32(const php_random_algo *algo, php_random_stat
 		r = algo->generate(status);
 		result = result | (r << (total_size * 8));
 		total_size += status->last_generated_size;
-		if (status->last_unsafe) {
+		if (EG(exception)) {
 			return 0;
 		}
 	} while (total_size < sizeof(uint32_t));
@@ -122,7 +122,6 @@ static inline uint32_t rand_range32(const php_random_algo *algo, php_random_stat
 		/* If the requirements cannot be met in a cycles, return fail */
 		if (++count > RANDOM_RANGE_ATTEMPTS) {
 			zend_throw_error(NULL, "Failed to generate an acceptable random number in %d attempts", RANDOM_RANGE_ATTEMPTS);
-			status->last_unsafe = true;
 			return 0;
 		}
 
@@ -132,7 +131,7 @@ static inline uint32_t rand_range32(const php_random_algo *algo, php_random_stat
 			r = algo->generate(status);
 			result = result | (r << (total_size * 8));
 			total_size += status->last_generated_size;
-			if (status->last_unsafe) {
+			if (EG(exception)) {
 				return 0;
 			}
 		} while (total_size < sizeof(uint32_t));
@@ -153,7 +152,7 @@ static inline uint64_t rand_range64(const php_random_algo *algo, php_random_stat
 		r = algo->generate(status);
 		result = result | (r << (total_size * 8));
 		total_size += status->last_generated_size;
-		if (status->last_unsafe) {
+		if (EG(exception)) {
 			return 0;
 		}
 	} while (total_size < sizeof(uint64_t));
@@ -179,7 +178,6 @@ static inline uint64_t rand_range64(const php_random_algo *algo, php_random_stat
 		/* If the requirements cannot be met in a cycles, return fail */
 		if (++count > RANDOM_RANGE_ATTEMPTS) {
 			zend_throw_error(NULL, "Failed to generate an acceptable random number in %d attempts", RANDOM_RANGE_ATTEMPTS);
-			status->last_unsafe = true;
 			return 0;
 		}
 
@@ -189,7 +187,7 @@ static inline uint64_t rand_range64(const php_random_algo *algo, php_random_stat
 			r = algo->generate(status);
 			result = result | (r << (total_size * 8));
 			total_size += status->last_generated_size;
-			if (status->last_unsafe) {
+			if (EG(exception)) {
 				return 0;
 			}
 		} while (total_size < sizeof(uint64_t));
@@ -245,7 +243,6 @@ PHPAPI php_random_status *php_random_status_alloc(const php_random_algo *algo, c
 	php_random_status *status = pecalloc(1, sizeof(php_random_status), persistent);
 
 	status->last_generated_size = algo->generate_size;
-	status->last_unsafe = false;
 	status->state = algo->state_size > 0 ? pecalloc(1, algo->state_size, persistent) : NULL;
 
 	return status;
@@ -254,7 +251,6 @@ PHPAPI php_random_status *php_random_status_alloc(const php_random_algo *algo, c
 PHPAPI php_random_status *php_random_status_copy(const php_random_algo *algo, php_random_status *old_status, php_random_status *new_status)
 {
 	new_status->last_generated_size = old_status->last_generated_size;
-	new_status->last_unsafe = old_status->last_unsafe;
 	new_status->state = memcpy(new_status->state, old_status->state, algo->state_size);
 
 	return new_status;
diff --git a/ext/random/randomizer.c b/ext/random/randomizer.c
@@ -105,7 +105,7 @@ PHP_METHOD(Random_Randomizer, getInt)
 			zend_throw_exception(spl_ce_RuntimeException, "Generated value exceeds size of int", 0);
 			RETURN_THROWS();
 		}
-		if (randomizer->status->last_unsafe) {
+		if (EG(exception)) {
 			zend_throw_exception(spl_ce_RuntimeException, "Random number generation failed", 0);
 			RETURN_THROWS();
 		}
@@ -123,7 +123,7 @@ PHP_METHOD(Random_Randomizer, getInt)
 	}
 
 	result = randomizer->algo->range(randomizer->status, min, max);
-	if (randomizer->status->last_unsafe) {
+	if (EG(exception)) {
 		zend_throw_exception(spl_ce_RuntimeException, "Random number generation failed", 0);
 		RETURN_THROWS();
 	}
@@ -155,7 +155,7 @@ PHP_METHOD(Random_Randomizer, getBytes)
 
 	while (total_size < required_size) {
 		result = randomizer->algo->generate(randomizer->status);
-		if (randomizer->status->last_unsafe) {
+		if (EG(exception)) {
 			zend_string_free(retval);
 			zend_throw_exception(spl_ce_RuntimeException, "Random number generation failed", 0);
 			RETURN_THROWS();
diff --git a/ext/standard/array.c b/ext/standard/array.c
@@ -2936,7 +2936,7 @@ PHPAPI bool php_array_data_shuffle(const php_random_algo *algo, php_random_statu
 		}
 		while (--n_left) {
 			rnd_idx = algo->range(status, 0, n_left);
-			if (status->last_unsafe) {
+			if (EG(exception)) {
 				return false;
 			}
 			if (rnd_idx != n_left) {
@@ -2964,7 +2964,7 @@ PHPAPI bool php_array_data_shuffle(const php_random_algo *algo, php_random_statu
 		}
 		while (--n_left) {
 			rnd_idx = algo->range(status, 0, n_left);
-			if (status->last_unsafe) {
+			if (EG(exception)) {
 				return false;
 			}
 			if (rnd_idx != n_left) {
diff --git a/ext/standard/string.c b/ext/standard/string.c
@@ -5755,7 +5755,7 @@ PHPAPI bool php_binary_string_shuffle(const php_random_algo *algo, php_random_st
 
 	while (--n_left) {
 		rnd_idx = algo->range(status, 0, n_left);
-		if (status->last_unsafe) {
+		if (EG(exception)) {
 			return false;
 		}
 		if (rnd_idx != n_left) {

Original file line number	Diff line number	Diff line change
`@@ -301,7 +301,7 @@ PHP_METHOD(Random_Engine_Mt19937, generate)`
`301`	`301`
`302`	`302`	`generated = engine->algo->generate(engine->status);`
`303`	`303`	`size = engine->status->last_generated_size;`
`304`		`- if (engine->status->last_unsafe) {`
	`304`	`+ if (EG(exception)) {`
`305`	`305`	`zend_throw_exception(spl_ce_RuntimeException, "Random number generation failed", 0);`
`306`	`306`	`RETURN_THROWS();`
`307`	`307`	`}`
Original file line number	Diff line number	Diff line change
`@@ -29,9 +29,7 @@ static uint64_t generate(php_random_status *status)`
`29`	`29`	`{`
`30`	`30`	`zend_ulong r = 0;`
`31`	`31`
`32`		`- if (php_random_bytes_throw(&r, sizeof(zend_ulong)) == FAILURE) {`
`33`		`- status->last_unsafe = true;`
`34`		`- }`
	`32`	`+ php_random_bytes_throw(&r, sizeof(zend_ulong));`
`35`	`33`
`36`	`34`	`return r;`
`37`	`35`	`}`
`@@ -40,9 +38,7 @@ static zend_long range(php_random_status *status, zend_long min, zend_long max)`
`40`	`38`	`{`
`41`	`39`	`zend_long result = 0;`
`42`	`40`
`43`		`- if (php_random_int_throw(min, max, &result) == FAILURE) {`
`44`		`- status->last_unsafe = true;`
`45`		`- }`
	`41`	`+ php_random_int_throw(min, max, &result);`
`46`	`42`
`47`	`43`	`return result;`
`48`	`44`	`}`
Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,6 @@ static uint64_t generate(php_random_status *status)`
`31`	`31`	`zend_call_known_instance_method_with_0_params(s->generate_method, s->object, &retval);`
`32`	`32`
`33`	`33`	`if (EG(exception)) {`
`34`		`- status->last_unsafe = true;`
`35`	`34`	`return 0;`
`36`	`35`	`}`
`37`	`36`
`@@ -51,7 +50,6 @@ static uint64_t generate(php_random_status *status)`
`51`	`50`	`}`
`52`	`51`	`} else {`
`53`	`52`	`zend_throw_error(NULL, "A random engine must return a non-empty string");`
`54`		`- status->last_unsafe = true;`
`55`	`53`	`return 0;`
`56`	`54`	`}`
`57`	`55`
Original file line number	Diff line number	Diff line change
`@@ -105,7 +105,7 @@ PHP_METHOD(Random_Randomizer, getInt)`
`105`	`105`	`zend_throw_exception(spl_ce_RuntimeException, "Generated value exceeds size of int", 0);`
`106`	`106`	`RETURN_THROWS();`
`107`	`107`	`}`
`108`		`- if (randomizer->status->last_unsafe) {`
	`108`	`+ if (EG(exception)) {`
`109`	`109`	`zend_throw_exception(spl_ce_RuntimeException, "Random number generation failed", 0);`
`110`	`110`	`RETURN_THROWS();`
`111`	`111`	`}`
`@@ -123,7 +123,7 @@ PHP_METHOD(Random_Randomizer, getInt)`
`123`	`123`	`}`
`124`	`124`
`125`	`125`	`result = randomizer->algo->range(randomizer->status, min, max);`
`126`		`- if (randomizer->status->last_unsafe) {`
	`126`	`+ if (EG(exception)) {`
`127`	`127`	`zend_throw_exception(spl_ce_RuntimeException, "Random number generation failed", 0);`
`128`	`128`	`RETURN_THROWS();`
`129`	`129`	`}`
`@@ -155,7 +155,7 @@ PHP_METHOD(Random_Randomizer, getBytes)`
`155`	`155`
`156`	`156`	`while (total_size < required_size) {`
`157`	`157`	`result = randomizer->algo->generate(randomizer->status);`
`158`		`- if (randomizer->status->last_unsafe) {`
	`158`	`+ if (EG(exception)) {`
`159`	`159`	`zend_string_free(retval);`
`160`	`160`	`zend_throw_exception(spl_ce_RuntimeException, "Random number generation failed", 0);`
`161`	`161`	`RETURN_THROWS();`
Original file line number	Diff line number	Diff line change
`@@ -2936,7 +2936,7 @@ PHPAPI bool php_array_data_shuffle(const php_random_algo *algo, php_random_statu`
`2936`	`2936`	`}`
`2937`	`2937`	`while (--n_left) {`
`2938`	`2938`	`rnd_idx = algo->range(status, 0, n_left);`
`2939`		`- if (status->last_unsafe) {`
	`2939`	`+ if (EG(exception)) {`
`2940`	`2940`	`return false;`
`2941`	`2941`	`}`
`2942`	`2942`	`if (rnd_idx != n_left) {`
`@@ -2964,7 +2964,7 @@ PHPAPI bool php_array_data_shuffle(const php_random_algo *algo, php_random_statu`
`2964`	`2964`	`}`
`2965`	`2965`	`while (--n_left) {`
`2966`	`2966`	`rnd_idx = algo->range(status, 0, n_left);`
`2967`		`- if (status->last_unsafe) {`
	`2967`	`+ if (EG(exception)) {`
`2968`	`2968`	`return false;`
`2969`	`2969`	`}`
`2970`	`2970`	`if (rnd_idx != n_left) {`
Original file line number	Diff line number	Diff line change
`@@ -5755,7 +5755,7 @@ PHPAPI bool php_binary_string_shuffle(const php_random_algo *algo, php_random_st`
`5755`	`5755`
`5756`	`5756`	`while (--n_left) {`
`5757`	`5757`	`rnd_idx = algo->range(status, 0, n_left);`
`5758`		`- if (status->last_unsafe) {`
	`5758`	`+ if (EG(exception)) {`
`5759`	`5759`	`return false;`
`5760`	`5760`	`}`
`5761`	`5761`	`if (rnd_idx != n_left) {`