drop XorShift128+

Author: zeriyoshi

ext/random/php_random.h

@@ -192,7 +192,6 @@ extern PHPAPI zend_class_entry *random_ce_Random_Engine_CombinedLCG;
 extern PHPAPI zend_class_entry *random_ce_Random_Engine_PCG64;
 extern PHPAPI zend_class_entry *random_ce_Random_Engine_MersenneTwister;
 extern PHPAPI zend_class_entry *random_ce_Random_Engine_Secure;
-extern PHPAPI zend_class_entry *random_ce_Random_Engine_XorShift128Plus;
 extern PHPAPI zend_class_entry *random_ce_Random_Engine_Xoshiro256StarStar;
 extern PHPAPI zend_class_entry *random_ce_Random_Randomizer;
 
@@ -201,7 +200,6 @@ extern const php_random_engine_algo php_random_engine_algo_mersennetwister;
 extern const php_random_engine_algo php_random_engine_algo_pcg64;
 extern const php_random_engine_algo php_random_engine_algo_secure;
 extern const php_random_engine_algo php_random_engine_algo_user;
-extern const php_random_engine_algo php_random_engine_algo_xorshift128plus;
 extern const php_random_engine_algo php_random_engine_algo_xoshiro256starstar;
 
 typedef struct _php_random_engine {
@@ -233,10 +231,6 @@ typedef struct _php_random_engine_state_user {
 	size_t last_generate_size;
 } php_random_engine_state_user;
 
-typedef struct _php_random_engine_state_xorshift128plus {
-	uint64_t s[2];
-} php_random_engine_state_xorshift128plus;
-
 typedef struct _php_random_engine_state_xoshiro256starstar {
 	uint64_t s[4];
 } php_random_engine_state_xoshiro256starstar;

ext/random/random.c

@@ -168,15 +168,13 @@ PHPAPI zend_class_entry *random_ce_Random_Engine_CombinedLCG;
 PHPAPI zend_class_entry *random_ce_Random_Engine_MersenneTwister;
 PHPAPI zend_class_entry *random_ce_Random_Engine_PCG64;
 PHPAPI zend_class_entry *random_ce_Random_Engine_Secure;
-PHPAPI zend_class_entry *random_ce_Random_Engine_XorShift128Plus;
 PHPAPI zend_class_entry *random_ce_Random_Engine_Xoshiro256StarStar;
 PHPAPI zend_class_entry *random_ce_Random_Randomizer;
 
 static zend_object_handlers random_engine_combinedlcg_object_handlers;
 static zend_object_handlers random_engine_mersennetwister_object_handlers;
 static zend_object_handlers random_engine_pcg64_object_handlers;
 static zend_object_handlers random_engine_secure_object_handlers;
-static zend_object_handlers random_engine_xorshift128plus_object_handlers;
 static zend_object_handlers random_engine_xoshiro256starstar_object_handlers;
 static zend_object_handlers random_randomizer_object_handlers;
 
@@ -768,80 +766,6 @@ const php_random_engine_algo php_random_engine_algo_user = {
 
 /* User end */
 
-/* XorShift128Plus begin */
-
-static inline size_t xorshift128plus_dynamic_generate_size(void *state) {
-	return sizeof(uint64_t);
-}
-
-static uint64_t xorshift128plus_generate(void *state, bool *engine_unsafe) {
-	php_random_engine_state_xorshift128plus *s = state;
-	uint64_t s0, s1, r;
-
-	s1 = s->s[0];
-	s0 = s->s[1];
-	r = s0 + s1;
-	s->s[0] = s0;
-	s1 ^= s1 << 23;
-	s->s[1] = s1 ^ s0 ^ (s1 >> 18) ^ (s0 >> 5);
-
-	return r;
-}
-
-static void xorshift128plus_seed(void *state, const uint64_t seed) {
-	php_random_engine_state_xorshift128plus *s = state;
-	uint64_t sd = seed;
-
-	s->s[0] = splitmix64(&sd);
-	s->s[1] = splitmix64(&sd);
-}
-
-static int xorshift128plus_serialize(void *state, HashTable *data) {
-	php_random_engine_state_xorshift128plus *s = state;
-	zval tmp;
-	int i;
-
-	for (i = 0; i < 2; i++) {
-		ZVAL_STR(&tmp, zend_strpprintf(0, "%" PRIu64, s->s[i]));
-		zend_hash_next_index_insert(data, &tmp);
-	}
-
-	return SUCCESS;
-}
-
-static int xorshift128plus_unserialize(void *state, HashTable *data) {
-	php_random_engine_state_xorshift128plus *s = state;
-	zval *tmp;
-	int i;
-
-	for (i = 0; i < 2; i++) {
-		tmp = zend_hash_index_find(data, i);
-		if (!tmp || Z_TYPE_P(tmp) != IS_STRING) {
-			return FAILURE;
-		}
-
-		s->s[i] = strtoull(ZSTR_VAL(Z_STR_P(tmp)), NULL, 10);
-	}
-
-	return SUCCESS;
-}
-
-static zend_object *php_random_engine_xorshift128plus_new(zend_class_entry *ce) {
-	return php_random_engine_common_init(ce, &php_random_engine_algo_xorshift128plus, &random_engine_xorshift128plus_object_handlers);
-}
-
-const php_random_engine_algo php_random_engine_algo_xorshift128plus = {
-	sizeof(uint64_t),
-	xorshift128plus_dynamic_generate_size,
-	sizeof(php_random_engine_state_xorshift128plus),
-	xorshift128plus_generate,
-	xorshift128plus_seed,
-	xorshift128plus_serialize,
-	xorshift128plus_unserialize
-};
-
-/* XorShift128Plus end */
-
 /* Xoshiro256StarStar start */
 
 static inline size_t xoshiro256starstar_dynamic_generate_size(void *state) {
@@ -1642,76 +1566,6 @@ PHP_METHOD(Random_Engine_PCG64, jump)
 }
 /* }}} */
 
-/* {{{ Construct object */
-PHP_METHOD(Random_Engine_XorShift128Plus, __construct)
-{
-	php_random_engine *engine = Z_RANDOM_ENGINE_P(ZEND_THIS);
-	php_random_engine_state_xorshift128plus *state = engine->state;
-	zend_string *str_seed = NULL;
-	zend_long int_seed = 0;
-	bool seed_is_null = true;
-	int i, j;
-	
-	ZEND_PARSE_PARAMETERS_START(0, 1)
-		Z_PARAM_OPTIONAL;
-		Z_PARAM_STR_OR_LONG_OR_NULL(str_seed, int_seed, seed_is_null);
-	ZEND_PARSE_PARAMETERS_END();
-
-	if (seed_is_null) {
-		for (i = 0; i < 2; i++) {
-			if (php_random_bytes_silent(&state->s[i], sizeof(uint64_t)) == FAILURE) {
-				zend_throw_exception(spl_ce_RuntimeException, "Random number generate failed", 0);
-				RETURN_THROWS();
-			}
-		}
-	} else {
-		if (str_seed) {
-			/* char (8 bit) * 16 = 128 bits */
-			if (ZSTR_LEN(str_seed) == 16) {
-				/* Endianness safe copy */
-				for (i = 0; i < 2; i++) {
-					state->s[i] = 0;
-					for (j = 0; j < 8; j++) {
-						state->s[i] += ((uint64_t) (unsigned char) ZSTR_VAL(str_seed)[(i * 8) + j]) << (j * 8);
-					}
-				}
-			} else {
-				zend_argument_value_error(1, "state strings must be 16 bytes");
-				RETURN_THROWS();
-			}
-		} else {
-			engine->algo->seed(state, int_seed);
-		}
-	}
-}
-/* }}} */
-
-/* {{{ Jump a state */
-PHP_METHOD(Random_Engine_XorShift128Plus, jump)
-{
-	php_random_engine *engine = Z_RANDOM_ENGINE_P(ZEND_THIS);
-	php_random_engine_state_xorshift128plus *s = engine->state;
-	static const uint64_t jmp[] = { 0x8a5cd789635d2dff, 0x121fd2155c472f96 };
-	uint64_t s0 = 0, s1 = 0;
-	int i, j;
-
-	ZEND_PARSE_PARAMETERS_NONE();
-
-	for (i = 0; i < sizeof (jmp) / sizeof (*jmp); i++) {
-		for (j = 0; j < 64; j++) {
-			if (jmp[i] & 1ULL << j) {
-				s0 ^= s->s[0];
-				s1 ^= s->s[1];
-			}
-			engine->algo->generate(engine->state, NULL);
-		}
-	}
-
-	s->s[0] = s0;
-	s->s[1] = s1;
-}
-/* }}} */
-
 /* {{{ Construct object */
 PHP_METHOD(Random_Engine_Xoshiro256StarStar, __construct)
 {
@@ -2060,15 +1914,7 @@ PHP_MINIT_FUNCTION(random)
 	random_engine_secure_object_handlers.offset = XtOffsetOf(php_random_engine, std);
 	random_engine_secure_object_handlers.free_obj = php_random_engine_common_free_obj;
 	random_engine_secure_object_handlers.clone_obj = NULL;
-
-	/* Random\Engine\XorShift128Plus */
-	random_ce_Random_Engine_XorShift128Plus = register_class_Random_Engine_XorShift128Plus(random_ce_Random_SeedableEngine, random_ce_Random_SerializableEngine);
-	random_ce_Random_Engine_XorShift128Plus->create_object = php_random_engine_xorshift128plus_new;
-	memcpy(&random_engine_xorshift128plus_object_handlers, zend_get_std_object_handlers(), sizeof(zend_object_handlers));
-	random_engine_xorshift128plus_object_handlers.offset = XtOffsetOf(php_random_engine, std);
-	random_engine_xorshift128plus_object_handlers.free_obj = php_random_engine_common_free_obj;
-	random_engine_xorshift128plus_object_handlers.clone_obj = php_random_engine_common_clone_obj;
-
+	
 	/* Random\Engine\Xoshiro256StarStar */
 	random_ce_Random_Engine_Xoshiro256StarStar = register_class_Random_Engine_Xoshiro256StarStar(random_ce_Random_SeedableEngine, random_ce_Random_SerializableEngine);
 	random_ce_Random_Engine_Xoshiro256StarStar->create_object = php_random_engine_xoshiro256starstar_new;

ext/random/random.stub.php

@@ -83,25 +83,6 @@ class Secure implements Random\CryptoSafeEngine
         public function generate(): string {}
     }
 
-    class XorShift128Plus implements Random\SeedableEngine, Random\SerializableEngine
-    {
-        public function __construct(string|int|null $seed = null) {}
-
-        /** @implementation-alias Random\Engine\CombinedLCG::generate */
-        public function generate(): string {}
-
-        public function jump(): void {}
-
-        /** @implementation-alias Random\Engine\CombinedLCG::__serialize */
-        public function __serialize(): array {}
-
-        /** @implementation-alias Random\Engine\CombinedLCG::__unserialize */
-        public function __unserialize(array $data): void {}
-
-        /** @implementation-alias Random\Engine\CombinedLCG::__debugInfo */
-        public function __debugInfo(): array {}
-    }
-
     class Xoshiro256StarStar implements Random\SeedableEngine, Random\SerializableEngine
     {
         public function __construct(string|int|null $seed = null) {}
@@ -156,7 +137,7 @@ public function __construct(?Engine $engine = null) {}
 
         public function getInt(int $min = UNKNOWN, int $max = UNKNOWN): int {}
 
-        public function getBytes(int $legnth): string {}
+        public function getBytes(int $length): string {}
 
         public function shuffleArray(array $array): array {}
 

ext/random/random_arginfo.h

@@ -1,5 +1,5 @@
 /* This is a generated file, edit the .stub.php file instead.
- * Stub hash: ebab329eeeafe1b609c74aa7bb48f2069f3763da */
+ * Stub hash: a0bc52433aa2b610b62996655bed08acd9d042e9 */
 
 ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_lcg_value, 0, 0, IS_DOUBLE, 0)
 ZEND_END_ARG_INFO()
@@ -79,26 +79,14 @@ ZEND_END_ARG_INFO()
 
 #define arginfo_class_Random_Engine_Secure_generate arginfo_class_Random_Engine_CombinedLCG_generate
 
-#define arginfo_class_Random_Engine_XorShift128Plus___construct arginfo_class_Random_Engine_PCG64___construct
-
-#define arginfo_class_Random_Engine_XorShift128Plus_generate arginfo_class_Random_Engine_CombinedLCG_generate
-
-ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_class_Random_Engine_XorShift128Plus_jump, 0, 0, IS_VOID, 0)
-ZEND_END_ARG_INFO()
-
-#define arginfo_class_Random_Engine_XorShift128Plus___serialize arginfo_class_Random_Engine_CombinedLCG___serialize
-
-#define arginfo_class_Random_Engine_XorShift128Plus___unserialize arginfo_class_Random_Engine_CombinedLCG___unserialize
-
-#define arginfo_class_Random_Engine_XorShift128Plus___debugInfo arginfo_class_Random_Engine_CombinedLCG___serialize
-
 #define arginfo_class_Random_Engine_Xoshiro256StarStar___construct arginfo_class_Random_Engine_PCG64___construct
 
 #define arginfo_class_Random_Engine_Xoshiro256StarStar_generate arginfo_class_Random_Engine_CombinedLCG_generate
 
-#define arginfo_class_Random_Engine_Xoshiro256StarStar_jump arginfo_class_Random_Engine_XorShift128Plus_jump
+ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_class_Random_Engine_Xoshiro256StarStar_jump, 0, 0, IS_VOID, 0)
+ZEND_END_ARG_INFO()
 
-#define arginfo_class_Random_Engine_Xoshiro256StarStar_jumpLong arginfo_class_Random_Engine_XorShift128Plus_jump
+#define arginfo_class_Random_Engine_Xoshiro256StarStar_jumpLong arginfo_class_Random_Engine_Xoshiro256StarStar_jump
 
 #define arginfo_class_Random_Engine_Xoshiro256StarStar___serialize arginfo_class_Random_Engine_CombinedLCG___serialize
 
@@ -120,9 +108,7 @@ ZEND_END_ARG_INFO()
 
 #define arginfo_class_Random_Randomizer_getInt arginfo_rand
 
-ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_class_Random_Randomizer_getBytes, 0, 1, IS_STRING, 0)
-	ZEND_ARG_TYPE_INFO(0, legnth, IS_LONG, 0)
-ZEND_END_ARG_INFO()
+#define arginfo_class_Random_Randomizer_getBytes arginfo_random_bytes
 
 ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_class_Random_Randomizer_shuffleArray, 0, 1, IS_ARRAY, 0)
 	ZEND_ARG_TYPE_INFO(0, array, IS_ARRAY, 0)
@@ -152,8 +138,6 @@ ZEND_METHOD(Random_Engine_CombinedLCG, __debugInfo);
 ZEND_METHOD(Random_Engine_MersenneTwister, __construct);
 ZEND_METHOD(Random_Engine_PCG64, __construct);
 ZEND_METHOD(Random_Engine_PCG64, jump);
-ZEND_METHOD(Random_Engine_XorShift128Plus, __construct);
-ZEND_METHOD(Random_Engine_XorShift128Plus, jump);
 ZEND_METHOD(Random_Engine_Xoshiro256StarStar, __construct);
 ZEND_METHOD(Random_Engine_Xoshiro256StarStar, jump);
 ZEND_METHOD(Random_Engine_Xoshiro256StarStar, jumpLong);
@@ -217,17 +201,6 @@ static const zend_function_entry class_Random_Engine_Secure_methods[] = {
 };
 
 
-static const zend_function_entry class_Random_Engine_XorShift128Plus_methods[] = {
-	ZEND_ME(Random_Engine_XorShift128Plus, __construct, arginfo_class_Random_Engine_XorShift128Plus___construct, ZEND_ACC_PUBLIC)
-	ZEND_MALIAS(Random_Engine_CombinedLCG, generate, generate, arginfo_class_Random_Engine_XorShift128Plus_generate, ZEND_ACC_PUBLIC)
-	ZEND_ME(Random_Engine_XorShift128Plus, jump, arginfo_class_Random_Engine_XorShift128Plus_jump, ZEND_ACC_PUBLIC)
-	ZEND_MALIAS(Random_Engine_CombinedLCG, __serialize, __serialize, arginfo_class_Random_Engine_XorShift128Plus___serialize, ZEND_ACC_PUBLIC)
-	ZEND_MALIAS(Random_Engine_CombinedLCG, __unserialize, __unserialize, arginfo_class_Random_Engine_XorShift128Plus___unserialize, ZEND_ACC_PUBLIC)
-	ZEND_MALIAS(Random_Engine_CombinedLCG, __debugInfo, __debugInfo, arginfo_class_Random_Engine_XorShift128Plus___debugInfo, ZEND_ACC_PUBLIC)
-	ZEND_FE_END
-};
-
-
 static const zend_function_entry class_Random_Engine_Xoshiro256StarStar_methods[] = {
 	ZEND_ME(Random_Engine_Xoshiro256StarStar, __construct, arginfo_class_Random_Engine_Xoshiro256StarStar___construct, ZEND_ACC_PUBLIC)
 	ZEND_MALIAS(Random_Engine_CombinedLCG, generate, generate, arginfo_class_Random_Engine_Xoshiro256StarStar_generate, ZEND_ACC_PUBLIC)
@@ -320,17 +293,6 @@ static zend_class_entry *register_class_Random_Engine_Secure(zend_class_entry *c
 	return class_entry;
 }
 
-static zend_class_entry *register_class_Random_Engine_XorShift128Plus(zend_class_entry *class_entry_Random_Engine_Random_SeedableEngine, zend_class_entry *class_entry_Random_Engine_Random_SerializableEngine)
-{
-	zend_class_entry ce, *class_entry;
-
-	INIT_NS_CLASS_ENTRY(ce, "Random\\Engine", "XorShift128Plus", class_Random_Engine_XorShift128Plus_methods);
-	class_entry = zend_register_internal_class_ex(&ce, NULL);
-	zend_class_implements(class_entry, 2, class_entry_Random_Engine_Random_SeedableEngine, class_entry_Random_Engine_Random_SerializableEngine);
-
-	return class_entry;
-}
-
 static zend_class_entry *register_class_Random_Engine_Xoshiro256StarStar(zend_class_entry *class_entry_Random_Engine_Random_SeedableEngine, zend_class_entry *class_entry_Random_Engine_Random_SerializableEngine)
 {
 	zend_class_entry ce, *class_entry;

ext/random/tests/02_engine/user_compatibility.phpt

@@ -30,15 +30,6 @@ for ($i = 0; $i < 1000; $i++) {
     }
 }
 
-$native_engine = new \Random\Engine\XorShift128Plus(1234);
-$user_engine = new class (1234) extends \Random\Engine\XorShift128Plus {};
-
-for ($i = 0; $i < 1000; $i++) {
-    if ($native_engine->generate() !== $user_engine->generate()) {
-        die('failure XorShift128Plus');
-    }
-}
-
 $native_engine = new \Random\Engine\Xoshiro256StarStar(1234);
 $user_engine = new class (1234) extends \Random\Engine\Xoshiro256StarStar {};