/* +----------------------------------------------------------------------+ | Copyright (c) The PHP Group | +----------------------------------------------------------------------+ | This source file is subject to version 3.01 of the PHP license, | | that is bundled with this package in the file LICENSE, and is | | available through the world-wide-web at the following url: | | https://www.php.net/license/3_01.txt | | If you did not receive a copy of the PHP license and are unable to | | obtain it through the world-wide-web, please send a note to | | license@php.net so we can mail you a copy immediately. | +----------------------------------------------------------------------+ | Authors: Rasmus Lerdorf | | Zeev Suraski | | Sascha Schumann | | Pedro Melo | | Sterling Hughes | | Sammy Kaye Powers | | Go Kudo | | | | Based on code from: Richard J. Wagner | | Makoto Matsumoto | | Takuji Nishimura | | Shawn Cokus | | David Blackman | | Sebastiano Vigna | | Melissa O'Neill | +----------------------------------------------------------------------+ */ #ifndef PHP_RANDOM_H # define PHP_RANDOM_H # include "php.h" # include "php_random_csprng.h" # include "php_random_uint128.h" PHPAPI double php_combined_lcg(void); typedef struct _php_random_fallback_seed_state php_random_fallback_seed_state; PHPAPI uint64_t php_random_generate_fallback_seed(void); PHPAPI uint64_t php_random_generate_fallback_seed_ex(php_random_fallback_seed_state *state); static inline zend_long GENERATE_SEED(void) { return (zend_long)php_random_generate_fallback_seed(); } # define PHP_MT_RAND_MAX ((zend_long) (0x7FFFFFFF)) /* (1<<31) - 1 */ enum php_random_mt19937_mode { MT_RAND_MT19937 = 0, MT_RAND_PHP = 1, }; #define PHP_RANDOM_RANGE_ATTEMPTS (50) PHPAPI void php_mt_srand(uint32_t seed); PHPAPI uint32_t php_mt_rand(void); PHPAPI zend_long php_mt_rand_range(zend_long min, zend_long max); PHPAPI zend_long php_mt_rand_common(zend_long min, zend_long max); typedef struct _php_random_status_state_mt19937 { uint32_t count; enum php_random_mt19937_mode mode; uint32_t state[624]; } php_random_status_state_mt19937; typedef struct _php_random_status_state_pcgoneseq128xslrr64 { php_random_uint128_t state; } php_random_status_state_pcgoneseq128xslrr64; typedef struct _php_random_status_state_xoshiro256starstar { uint64_t state[4]; } php_random_status_state_xoshiro256starstar; typedef struct _php_random_status_state_user { zend_object *object; zend_function *generate_method; } php_random_status_state_user; typedef struct _php_random_result { uint64_t result; size_t size; } php_random_result; typedef struct _php_random_algo { const size_t state_size; php_random_result (*generate)(void *state); zend_long (*range)(void *state, zend_long min, zend_long max); bool (*serialize)(void *state, HashTable *data); bool (*unserialize)(void *state, HashTable *data); } php_random_algo; typedef struct _php_random_algo_with_state { const php_random_algo *algo; void *state; } php_random_algo_with_state; typedef struct _php_random_fallback_seed_state { bool initialized; unsigned char seed[20]; } php_random_fallback_seed_state; extern PHPAPI const php_random_algo php_random_algo_mt19937; extern PHPAPI const php_random_algo php_random_algo_pcgoneseq128xslrr64; extern PHPAPI const php_random_algo php_random_algo_xoshiro256starstar; extern PHPAPI const php_random_algo php_random_algo_secure; extern PHPAPI const php_random_algo php_random_algo_user; typedef struct _php_random_engine { php_random_algo_with_state engine; zend_object std; } php_random_engine; typedef struct _php_random_randomizer { php_random_algo_with_state engine; bool is_userland_algo; zend_object std; } php_random_randomizer; extern PHPAPI zend_class_entry *random_ce_Random_Engine; extern PHPAPI zend_class_entry *random_ce_Random_CryptoSafeEngine; extern PHPAPI zend_class_entry *random_ce_Random_RandomError; extern PHPAPI zend_class_entry *random_ce_Random_BrokenRandomEngineError; extern PHPAPI zend_class_entry *random_ce_Random_RandomException; extern PHPAPI zend_class_entry *random_ce_Random_Engine_PcgOneseq128XslRr64; extern PHPAPI zend_class_entry *random_ce_Random_Engine_Mt19937; extern PHPAPI zend_class_entry *random_ce_Random_Engine_Xoshiro256StarStar; extern PHPAPI zend_class_entry *random_ce_Random_Engine_Secure; extern PHPAPI zend_class_entry *random_ce_Random_Randomizer; extern PHPAPI zend_class_entry *random_ce_Random_IntervalBoundary; static inline php_random_engine *php_random_engine_from_obj(zend_object *object) { return (php_random_engine *)((char *)(object) - XtOffsetOf(php_random_engine, std)); } static inline php_random_randomizer *php_random_randomizer_from_obj(zend_object *object) { return (php_random_randomizer *)((char *)(object) - XtOffsetOf(php_random_randomizer, std)); } # define Z_RANDOM_ENGINE_P(zval) php_random_engine_from_obj(Z_OBJ_P(zval)) # define Z_RANDOM_RANDOMIZER_P(zval) php_random_randomizer_from_obj(Z_OBJ_P(zval)); PHPAPI void *php_random_status_alloc(const php_random_algo *algo, const bool persistent); PHPAPI void *php_random_status_copy(const php_random_algo *algo, void *old_status, void *new_status); PHPAPI void php_random_status_free(void *status, const bool persistent); PHPAPI php_random_engine *php_random_engine_common_init(zend_class_entry *ce, zend_object_handlers *handlers, const php_random_algo *algo); PHPAPI void php_random_engine_common_free_object(zend_object *object); PHPAPI zend_object *php_random_engine_common_clone_object(zend_object *object); PHPAPI uint32_t php_random_range32(php_random_algo_with_state engine, uint32_t umax); PHPAPI uint64_t php_random_range64(php_random_algo_with_state engine, uint64_t umax); PHPAPI zend_long php_random_range(php_random_algo_with_state engine, zend_long min, zend_long max); PHPAPI const php_random_algo *php_random_default_algo(void); PHPAPI void *php_random_default_status(void); static inline php_random_algo_with_state php_random_default_engine(void) { php_random_algo_with_state raws; raws.algo = php_random_default_algo(); raws.state = php_random_default_status(); return raws; } PHPAPI zend_string *php_random_bin2hex_le(const void *ptr, const size_t len); PHPAPI bool php_random_hex2bin_le(zend_string *hexstr, void *dest); PHPAPI void php_random_mt19937_seed32(php_random_status_state_mt19937 *state, uint32_t seed); PHPAPI void php_random_mt19937_seed_default(php_random_status_state_mt19937 *state); PHPAPI void php_random_pcgoneseq128xslrr64_seed128(php_random_status_state_pcgoneseq128xslrr64 *s, php_random_uint128_t seed); PHPAPI void php_random_pcgoneseq128xslrr64_advance(php_random_status_state_pcgoneseq128xslrr64 *state, uint64_t advance); PHPAPI void php_random_xoshiro256starstar_seed64(php_random_status_state_xoshiro256starstar *state, uint64_t seed); PHPAPI void php_random_xoshiro256starstar_seed256(php_random_status_state_xoshiro256starstar *state, uint64_t s0, uint64_t s1, uint64_t s2, uint64_t s3); PHPAPI void php_random_xoshiro256starstar_jump(php_random_status_state_xoshiro256starstar *state); PHPAPI void php_random_xoshiro256starstar_jump_long(php_random_status_state_xoshiro256starstar *state); PHPAPI double php_random_gammasection_closed_open(php_random_algo_with_state engine, double min, double max); PHPAPI double php_random_gammasection_closed_closed(php_random_algo_with_state engine, double min, double max); PHPAPI double php_random_gammasection_open_closed(php_random_algo_with_state engine, double min, double max); PHPAPI double php_random_gammasection_open_open(php_random_algo_with_state engine, double min, double max); extern zend_module_entry random_module_entry; # define phpext_random_ptr &random_module_entry PHP_MINIT_FUNCTION(random); PHP_MSHUTDOWN_FUNCTION(random); PHP_RINIT_FUNCTION(random); ZEND_BEGIN_MODULE_GLOBALS(random) bool combined_lcg_seeded; bool mt19937_seeded; php_random_fallback_seed_state fallback_seed_state; int32_t combined_lcg[2]; php_random_status_state_mt19937 mt19937; ZEND_END_MODULE_GLOBALS(random) PHPAPI ZEND_EXTERN_MODULE_GLOBALS(random) # define RANDOM_G(v) ZEND_MODULE_GLOBALS_ACCESSOR(random, v) #endif /* PHP_RANDOM_H */