php-src/UPGRADING.INTERNALS

PHP 8.2 INTERNALS UPGRADE NOTES

1. Internal API changes

2. Build system changes

3. Module changes

4. OpCode changes

5. SAPI changes

========================
1. Internal API changes
========================

* Removed zend_binary_zval_str(n)casecmp() APIs. These were thin wrappers
  around zend_binary_str(n)casecmp_l() -- rather than
  zend_binary_str(n)casecmp() as one would expect. Call the appropriate
  wrapped function directly instead.
* Removed the (ZEND_)WRONG_PARAM_COUNT_WITH_RETVAL() macros.
* php_stristr() no longer lowercases the haystack and needle as a side effect.
  Call zend_str_tolower() yourself if necessary. You no longer need to copy
  the haystack and needle before passing them to php_stristr().
* zend_register_module_ex() no longer copies the module entry.
* The main/php_stdint.h header has been removed.
  Include the standard <inttypes.h> and/or <stdint.h> headers instead.
  Replace usage of u_char by the standard C99 uint8_t type.
* A new ZEND_THREEWAY_COMPARE() macro has been introduced which does a
  three-way comparison of two integers and returns -1, 0 or 1 if the LHS is
  smaller, equal or larger than the RHS
* Deprecated zend_atoi() and zend_atol(). Use ZEND_STRTOL() for general purpose
  string to long conversion, or a variant of zend_ini_parse_quantity() for
  parsing ini quantities.
* The return types of the following object handlers has changed from int to zend_result
  - zend_object_cast_t
  - zend_object_count_elements_t
  - zend_object_get_closure_t
  - zend_object_do_operation_t
* Added a new zero_position argument to php_stream_fopen_from_fd_rel to reflect
  if this a newly created file so the current file offset needs not to be checked.
* Added smart_str_trim_to_size(). The function trims the memory allocated for the
  string. This can considerably reduce the memory footprint of strings smaller
  than approximately 4096 bytes.
* smart_str_extract() and the spprintf family of functions now use
  smart_str_trim_to_size() before returning the string.
* It is recommended to use smart_str_extract() or smart_str_trim_to_size() when
  using the smart_str API.
* zend_is_callable_ex, and functions which call it such as zend_is_callable and
  zend_fcall_info_init, will issue deprecation notices if passed values which
  are deprecated (see main UPGRADING notes). To suppress the notice, e.g. to
  avoid duplicates when processing the same value multiple times, pass or add
  IS_CALLABLE_SUPPRESS_DEPRECATIONS to the check_flags parameter.
* Registered zend_observer_fcall_init handlers are now also called for internal functions.
* The pestrdup and pestrndup macros and zend_strndup function are now also infallible
  for persistent strings, so checking for NULL is no longer necessary.
* The CHECK_NULL_PATH and CHECK_ZVAL_NULL_PATH macros are now wrappers using
  the new inline functions: bool zend_str_has_nul_byte(const zend_string *str)
  and zend_char_has_nul_byte(const char *s, size_t known_length)
* Added zend_enum_get_case_by_value() function, which provides an internal API
  similiar to BackedEnum::from() and BackedEnum::tryFrom().

========================
2. Build system changes
========================

* The build system now requires PHP 7.4.0 at least. Previously PHP 7.1 was
  required.
* Unsupported libxml2 2.10.0 symbols are no longer exported on Windows.
* Identifier names for namespaced functions generated from stub files through
  gen_stub.php have been changed. This requires that namespaced functions
  should be declared via the PHP_FUNCTION macro by using the fully qualified
  function name (whereas each part is separated by "_") instead of just the
  function name itself.

========================
3. Module changes
========================

  a. ext/standard
    - The PHP APIs string_natural_compare_function_ex(),
      string_natural_case_compare_function(), and string_natural_compare_function()
      have been removed. They always returned SUCCESS and were a wrapper around
      strnatcmp_ex(). Use strnatcmp_ex() directly instead.
    - The PHP API php_fgetcsv() now returns a HashTable* instead of having an in-out
      zval parameter.
      It now returns NULL on an empty line instead of [null].
      A new function php_bc_fgetcsv_empty_line() has been added to get a HashTable* which
      represents [null].
  b. ext/pdo
    - pdo_raise_impl_error()'s parameter sqlstate has been changed from
      const char * to pdo_error_type (aka char [6]).

========================
4. OpCode changes
========================

* The ZEND_INIT_FCALL opcode now asserts that the function exists in the symbol
  table as the function's existence is checked at compile time.
  For extensions modifying the function symbol table, setting
  CG(compiler_options) |= ZEND_COMPILE_IGNORE_USER_FUNCTIONS | ZEND_COMPILE_IGNORE_INTERNAL_FUNCTIONS;
  will produce ZEND_INIT_FCALL_BY_NAME opcodes instead which check for the
  existence of the function at runtime.

========================
5. SAPI changes
========================

 * The signature of php_module_startup() has changed from
   int php_module_startup(sapi_module_struct *sf, zend_module_entry *additional_modules, uint32_t num_additional_modules)
   to
   zend_result php_module_startup(sapi_module_struct *sf, zend_module_entry *additional_module)
   as only one additional module was ever provided.