/src/php-src/Zend/zend_compile.h

Source
/*
   +----------------------------------------------------------------------+
   | Zend Engine                                                          |
   +----------------------------------------------------------------------+
   | Copyright © Zend Technologies Ltd., a subsidiary company of          |
   |     Perforce Software, Inc., and Contributors.                       |
   +----------------------------------------------------------------------+
   | This source file is subject to the Modified BSD License that is      |
   | bundled with this package in the file LICENSE, and is available      |
   | through the World Wide Web at <https://www.php.net/license/>.        |
   |                                                                      |
   | SPDX-License-Identifier: BSD-3-Clause                                |
   +----------------------------------------------------------------------+
   | Authors: Andi Gutmans <andi@php.net>                                 |
   |          Zeev Suraski <zeev@php.net>                                 |
   +----------------------------------------------------------------------+
*/

#ifndef ZEND_COMPILE_H
#define ZEND_COMPILE_H

#include "zend_ast.h"
#include "zend_types.h"
#include "zend_map_ptr.h"
#include "zend_alloc.h"
#include "zend_vm_opcodes.h"

#include <stdarg.h>
#include <stdint.h>

#include "zend_llist.h"
#include "zend_frameless_function.h"
#include "zend_property_hooks.h"

#define SET_UNUSED(op) do { \
  op ## _type = IS_UNUSED; \
  op.num = (uint32_t) -1; \
} while (0)

#define MAKE_NOP(opline) do { \
  (opline)->opcode = ZEND_NOP; \
  SET_UNUSED((opline)->op1); \
  SET_UNUSED((opline)->op2); \
  SET_UNUSED((opline)->result); \
} while (0)

#define RESET_DOC_COMMENT() do { \
  if (CG(doc_comment)) { \
    zend_string_release_ex(CG(doc_comment), 0); \
    CG(doc_comment) = NULL; \
  } \
} while (0)

typedef struct _zend_op_array zend_op_array;
typedef struct _zend_op zend_op;

/* On 64-bit systems less optimal, but more compact VM code leads to better
 * performance. So on 32-bit systems we use absolute addresses for jump
 * targets and constants, but on 64-bit systems relative 32-bit offsets */
#if SIZEOF_SIZE_T == 4
# define ZEND_USE_ABS_JMP_ADDR      1
# define ZEND_USE_ABS_CONST_ADDR    1
#else
# define ZEND_USE_ABS_JMP_ADDR      0
# define ZEND_USE_ABS_CONST_ADDR    0
#endif

typedef union _znode_op {
  uint32_t      constant;
  uint32_t      var;
  uint32_t      num;
  uint32_t      opline_num; /*  Needs to be signed */
#if ZEND_USE_ABS_JMP_ADDR
  zend_op       *jmp_addr;
#else
  uint32_t      jmp_offset;
#endif
#if ZEND_USE_ABS_CONST_ADDR
  zval          *zv;
#endif
} znode_op;

typedef struct _znode { /* used only during compilation */
  uint8_t op_type;
  uint8_t flag;
  union {
    znode_op op;
    zval constant; /* replaced by literal/zv */
  } u;
} znode;

typedef struct _zend_ast_znode {
  zend_ast_kind kind;
  zend_ast_attr attr;
  uint32_t lineno;
  znode node;
} zend_ast_znode;

ZEND_API zend_ast * ZEND_FASTCALL zend_ast_create_znode(const znode *node);

static zend_always_inline znode *zend_ast_get_znode(zend_ast *ast) {
  return &((zend_ast_znode *) ast)->node;
}

typedef struct _zend_declarables {
  zend_long ticks;
} zend_declarables;

/* Compilation context that is different for each file, but shared between op arrays. */
typedef struct _zend_file_context {
  zend_declarables declarables;

  zend_string *current_namespace;
  bool in_namespace;
  bool has_bracketed_namespaces;

  HashTable *imports;
  HashTable *imports_function;
  HashTable *imports_const;

  HashTable seen_symbols;
} zend_file_context;

typedef union _zend_parser_stack_elem {
  zend_ast *ast;
  zend_string *str;
  zend_ulong num;
  unsigned char *ptr;
  unsigned char *ident;
} zend_parser_stack_elem;

void zend_compile_top_stmt(zend_ast *ast);
void zend_const_expr_to_zval(zval *result, zend_ast **ast_ptr, bool allow_dynamic);

typedef int (*user_opcode_handler_t) (zend_execute_data *execute_data);

struct _zend_op {
  zend_vm_opcode_handler_t handler;
  znode_op op1;
  znode_op op2;
  znode_op result;
  uint32_t extended_value;
  uint32_t lineno;
  uint8_t opcode;       /* Opcodes defined in Zend/zend_vm_opcodes.h */
  uint8_t op1_type;     /* IS_UNUSED, IS_CONST, IS_TMP_VAR, IS_VAR, IS_CV */
  uint8_t op2_type;     /* IS_UNUSED, IS_CONST, IS_TMP_VAR, IS_VAR, IS_CV */
  uint8_t result_type;  /* IS_UNUSED, IS_CONST, IS_TMP_VAR, IS_VAR, IS_CV */
#ifdef ZEND_VERIFY_TYPE_INFERENCE
  uint32_t op1_use_type;
  uint32_t op2_use_type;
  uint32_t result_use_type;
  uint32_t op1_def_type;
  uint32_t op2_def_type;
  uint32_t result_def_type;
#endif
};


typedef struct _zend_brk_cont_element {
  int start;
  int cont;
  int brk;
  int parent;
  bool is_switch;
} zend_brk_cont_element;

typedef struct _zend_label {
  int brk_cont;
  uint32_t opline_num;
} zend_label;

typedef struct _zend_try_catch_element {
  uint32_t try_op;
  uint32_t catch_op;  /* ketchup! */
  uint32_t finally_op;
  uint32_t finally_end;
} zend_try_catch_element;

#define ZEND_LIVE_TMPVAR  0
#define ZEND_LIVE_LOOP    1
#define ZEND_LIVE_SILENCE 2
#define ZEND_LIVE_ROPE    3
#define ZEND_LIVE_NEW     4
#define ZEND_LIVE_MASK    7

typedef struct _zend_live_range {
  uint32_t var; /* low bits are used for variable type (ZEND_LIVE_* macros) */
  uint32_t start;
  uint32_t end;
} zend_live_range;

typedef struct _zend_property_info zend_property_info;

/* Compilation context that is different for each op array. */
typedef struct _zend_oparray_context {
  struct _zend_oparray_context *prev;
  zend_op_array *op_array;
  uint32_t   opcodes_size;
  uint32_t   vars_size;
  uint32_t   literals_size;
  uint32_t   fast_call_var;
  uint32_t   try_catch_offset;
  int        current_brk_cont;
  int        last_brk_cont;
  zend_brk_cont_element *brk_cont_array;
  HashTable *labels;
  zend_string *active_property_info_name;
  zend_property_hook_kind active_property_hook_kind;
  bool       in_jmp_frameless_branch;
  bool       in_finally;
  bool has_assigned_to_http_response_header;
} zend_oparray_context;

/* Class, property and method flags                  class|meth.|prop.|const*/
/*                                                        |     |     |     */
/* Common flags                                           |     |     |     */
/* ============                                           |     |     |     */
/*                                                        |     |     |     */
/* Visibility flags (public < protected < private)        |     |     |     */
#define ZEND_ACC_PUBLIC                  (1 <<  0) /*     |  X  |  X  |  X  */
#define ZEND_ACC_PROTECTED               (1 <<  1) /*     |  X  |  X  |  X  */
#define ZEND_ACC_PRIVATE                 (1 <<  2) /*     |  X  |  X  |  X  */
/*                                                        |     |     |     */
/* Property or method overrides private one               |     |     |     */
#define ZEND_ACC_CHANGED                 (1 <<  3) /*     |  X  |  X  |     */
/*                                                        |     |     |     */
/* Static method or property                              |     |     |     */
#define ZEND_ACC_STATIC                  (1 <<  4) /*     |  X  |  X  |     */
/*                                                        |     |     |     */
/* Final class or method                                  |     |     |     */
#define ZEND_ACC_FINAL                   (1 <<  5) /*  X  |  X  |  X  |  X  */
/*                                                        |     |     |     */
/* Abstract method                                        |     |     |     */
#define ZEND_ACC_ABSTRACT                (1 <<  6) /*  X  |  X  |  X  |     */
#define ZEND_ACC_EXPLICIT_ABSTRACT_CLASS (1 <<  6) /*  X  |     |     |     */
/*                                                        |     |     |     */
/* Readonly property                                      |     |     |     */
#define ZEND_ACC_READONLY                (1 <<  7) /*     |     |  X  |     */
/*                                                        |     |     |     */
/* Immutable op_array and class_entries                   |     |     |     */
/* (implemented only for lazy loading of op_arrays)       |     |     |     */
#define ZEND_ACC_IMMUTABLE               (1 <<  7) /*  X  |  X  |     |     */
/*                                                        |     |     |     */
/* Function has typed arguments / class has typed props   |     |     |     */
#define ZEND_ACC_HAS_TYPE_HINTS          (1 <<  8) /*  X  |  X  |     |     */
/*                                                        |     |     |     */
/* Top-level class or function declaration                |     |     |     */
#define ZEND_ACC_TOP_LEVEL               (1 <<  9) /*  X  |  X  |     |     */
/*                                                        |     |     |     */
/* op_array or class is preloaded                         |     |     |     */
#define ZEND_ACC_PRELOADED               (1 << 10) /*  X  |  X  |     |     */
/*                                                        |     |     |     */
/* Flag to differentiate cases from constants.            |     |     |     */
/* Must not conflict with ZEND_ACC_ visibility flags      |     |     |     */
/* or IS_CONSTANT_VISITED_MARK                            |     |     |     */
#define ZEND_CLASS_CONST_IS_CASE         (1 <<  6) /*     |     |     |  X  */
/*                                                        |     |     |     */
/* deprecation flag                                       |     |     |     */
#define ZEND_ACC_DEPRECATED              (1 << 11) /*  X  |  X  |     |  X  */
/*                                                        |     |     |     */
/* has #[\Override] attribute                             |     |     |     */
#define ZEND_ACC_OVERRIDE                (1 << 28) /*     |  X  |  X  |     */
/*                                                        |     |     |     */
/* Property Flags (unused: 13-27,29...)                   |     |     |     */
/* ===========                                            |     |     |     */
/*                                                        |     |     |     */
/* Promoted property / parameter                          |     |     |     */
#define ZEND_ACC_PROMOTED                (1 <<  8) /*     |     |  X  |     */
/*                                                        |     |     |     */
/* Virtual property without backing storage               |     |     |     */
#define ZEND_ACC_VIRTUAL                 (1 <<  9) /*     |     |  X  |     */
/*                                                        |     |     |     */
/* Asymmetric visibility                                  |     |     |     */
#define ZEND_ACC_PUBLIC_SET              (1 << 10) /*     |     |  X  |     */
#define ZEND_ACC_PROTECTED_SET           (1 << 11) /*     |     |  X  |     */
#define ZEND_ACC_PRIVATE_SET             (1 << 12) /*     |     |  X  |     */
/*                                                        |     |     |     */
/* Class Flags (unused: 31)                               |     |     |     */
/* ===========                                            |     |     |     */
/*                                                        |     |     |     */
/* Special class types                                    |     |     |     */
#define ZEND_ACC_INTERFACE               (1 <<  0) /*  X  |     |     |     */
#define ZEND_ACC_TRAIT                   (1 <<  1) /*  X  |     |     |     */
#define ZEND_ACC_ANON_CLASS              (1 <<  2) /*  X  |     |     |     */
#define ZEND_ACC_ENUM                    (1 << 28) /*  X  |     |     |     */
/*                                                        |     |     |     */
/* Class linked with parent, interfaces and traits        |     |     |     */
#define ZEND_ACC_LINKED                  (1 <<  3) /*  X  |     |     |     */
/*                                                        |     |     |     */
/* Class is abstract, since it is set by any              |     |     |     */
/* abstract method                                        |     |     |     */
#define ZEND_ACC_IMPLICIT_ABSTRACT_CLASS (1 <<  4) /*  X  |     |     |     */
/*                                                        |     |     |     */
/* Class has magic methods __get/__set/__unset/           |     |     |     */
/* __isset that use guards                                |     |     |     */
#define ZEND_ACC_USE_GUARDS              (1 << 30) /*  X  |     |     |     */
/*                                                        |     |     |     */
/* Class constants updated                                |     |     |     */
#define ZEND_ACC_CONSTANTS_UPDATED       (1 << 12) /*  X  |     |     |     */
/*                                                        |     |     |     */
/* Objects of this class may not have dynamic properties  |     |     |     */
#define ZEND_ACC_NO_DYNAMIC_PROPERTIES   (1 << 13) /*  X  |     |     |     */
/*                                                        |     |     |     */
/* User class has methods with static variables           |     |     |     */
#define ZEND_HAS_STATIC_IN_METHODS       (1 << 14) /*  X  |     |     |     */
/*                                                        |     |     |     */
/* Objects of this class may have dynamic properties      |     |     |     */
/* without triggering a deprecation warning               |     |     |     */
#define ZEND_ACC_ALLOW_DYNAMIC_PROPERTIES (1 << 15) /* X  |     |     |     */
/*                                                        |     |     |     */
/* Readonly class                                         |     |     |     */
#define ZEND_ACC_READONLY_CLASS          (1 << 16) /*  X  |     |     |     */
/*                                                        |     |     |     */
/* Parent class is resolved (CE).                         |     |     |     */
#define ZEND_ACC_RESOLVED_PARENT         (1 << 17) /*  X  |     |     |     */
/*                                                        |     |     |     */
/* Interfaces are resolved (CEs).                         |     |     |     */
#define ZEND_ACC_RESOLVED_INTERFACES     (1 << 18) /*  X  |     |     |     */
/*                                                        |     |     |     */
/* Class has unresolved variance obligations.             |     |     |     */
#define ZEND_ACC_UNRESOLVED_VARIANCE     (1 << 19) /*  X  |     |     |     */
/*                                                        |     |     |     */
/* Class is linked apart from variance obligations.       |     |     |     */
#define ZEND_ACC_NEARLY_LINKED           (1 << 20) /*  X  |     |     |     */
/* Class has readonly props                               |     |     |     */
#define ZEND_ACC_HAS_READONLY_PROPS      (1 << 21) /*  X  |     |     |     */
/*                                                        |     |     |     */
/* stored in opcache (may be partially)                   |     |     |     */
#define ZEND_ACC_CACHED                  (1 << 22) /*  X  |     |     |     */
/*                                                        |     |     |     */
/* temporary flag used during delayed variance checks     |     |     |     */
#define ZEND_ACC_CACHEABLE               (1 << 23) /*  X  |     |     |     */
/*                                                        |     |     |     */
#define ZEND_ACC_HAS_AST_CONSTANTS       (1 << 24) /*  X  |     |     |     */
#define ZEND_ACC_HAS_AST_PROPERTIES      (1 << 25) /*  X  |     |     |     */
#define ZEND_ACC_HAS_AST_STATICS         (1 << 26) /*  X  |     |     |     */
/*                                                        |     |     |     */
/* loaded from file cache to process memory               |     |     |     */
#define ZEND_ACC_FILE_CACHED             (1 << 27) /*  X  |     |     |     */
/*                                                        |     |     |     */
/* Class cannot be serialized or unserialized             |     |     |     */
#define ZEND_ACC_NOT_SERIALIZABLE        (1 << 29) /*  X  |     |     |     */
/*                                                        |     |     |     */
/* Class Flags 2 (ce_flags2) (unused: 0-31)               |     |     |     */
/* =========================                              |     |     |     */
/*                                                        |     |     |     */
/* #define ZEND_ACC2_EXAMPLE             (1 << 0)      X  |     |     |     */
/*                                                        |     |     |     */
/* Function Flags (unused: 30)                            |     |     |     */
/* ==============                                         |     |     |     */
/*                                                        |     |     |     */
/* Function returning by reference                        |     |     |     */
#define ZEND_ACC_RETURN_REFERENCE        (1 << 12) /*     |  X  |     |     */
/*                                                        |     |     |     */
/* Function has a return type                             |     |     |     */
#define ZEND_ACC_HAS_RETURN_TYPE         (1 << 13) /*     |  X  |     |     */
/*                                                        |     |     |     */
/* Function with variable number of arguments             |     |     |     */
#define ZEND_ACC_VARIADIC                (1 << 14) /*     |  X  |     |     */
/*                                                        |     |     |     */
/* op_array has finally blocks (user only)                |     |     |     */
#define ZEND_ACC_HAS_FINALLY_BLOCK       (1 << 15) /*     |  X  |     |     */
/*                                                        |     |     |     */
/* "main" op_array with                                   |     |     |     */
/* ZEND_DECLARE_CLASS_DELAYED opcodes                     |     |     |     */
#define ZEND_ACC_EARLY_BINDING           (1 << 16) /*     |  X  |     |     */
/*                                                        |     |     |     */
/* closure uses $this                                     |     |     |     */
#define ZEND_ACC_USES_THIS               (1 << 17) /*     |  X  |     |     */
/*                                                        |     |     |     */
/* call through user function trampoline. e.g.            |     |     |     */
/* __call, __callStatic                                   |     |     |     */
#define ZEND_ACC_CALL_VIA_TRAMPOLINE     (1 << 18) /*     |  X  |     |     */
/*                                                        |     |     |     */
/* disable inline caching                                 |     |     |     */
#define ZEND_ACC_NEVER_CACHE             (1 << 19) /*     |  X  |     |     */
/*                                                        |     |     |     */
/* op_array is a clone of trait method                    |     |     |     */
#define ZEND_ACC_TRAIT_CLONE             (1 << 20) /*     |  X  |     |     */
/*                                                        |     |     |     */
/* functions is a constructor                             |     |     |     */
#define ZEND_ACC_CTOR                    (1 << 21) /*     |  X  |     |     */
/*                                                        |     |     |     */
/* Closure related                                        |     |     |     */
#define ZEND_ACC_CLOSURE                 (1 << 22) /*     |  X  |     |     */
#define ZEND_ACC_FAKE_CLOSURE            (1 << 23) /*     |  X  |     |     */ /* Same as ZEND_CALL_FAKE_CLOSURE */
/*                                                        |     |     |     */
#define ZEND_ACC_GENERATOR               (1 << 24) /*     |  X  |     |     */
/*                                                        |     |     |     */
/* function was processed by pass two (user only)         |     |     |     */
#define ZEND_ACC_DONE_PASS_TWO           (1 << 25) /*     |  X  |     |     */
/*                                                        |     |     |     */
/* internal function is allocated at arena (int only)     |     |     |     */
#define ZEND_ACC_ARENA_ALLOCATED         (1 << 25) /*     |  X  |     |     */
/*                                                        |     |     |     */
/* run_time_cache allocated on heap (user only)           |     |     |     */
#define ZEND_ACC_HEAP_RT_CACHE           (1 << 26) /*     |  X  |     |     */
/*                                                        |     |     |     */
/* method flag used by Closure::__invoke() (int only)     |     |     |     */
#define ZEND_ACC_USER_ARG_INFO           (1 << 26) /*     |  X  |     |     */
/*                                                        |     |     |     */
/* supports opcache compile-time evaluation (funcs)       |     |     |     */
#define ZEND_ACC_COMPILE_TIME_EVAL       (1 << 27) /*     |  X  |     |     */
/*                                                        |     |     |     */
/* Has IS_PTR operands that needs special cleaning; same  |     |     |     */
/* value as ZEND_ACC_OVERRIDE but override is for class   |     |     |     */
/* methods and this is for the top level op array         |     |     |     */
#define ZEND_ACC_PTR_OPS                 (1 << 28) /*     |  X  |     |     */
/*                                                        |     |     |     */
/* has #[\NoDiscard] attribute                            |     |     |     */
#define ZEND_ACC_NODISCARD               (1 << 29) /*     |  X  |     |     */
/*                                                        |     |     |     */
/* op_array uses strict mode types                        |     |     |     */
#define ZEND_ACC_STRICT_TYPES            (1U << 31) /*    |  X  |     |     */
/*                                                        |     |     |     */
/* Function Flags 2 (fn_flags2) (unused: 1-31)            |     |     |     */
/* ============================                           |     |     |     */
/*                                                        |     |     |     */
/* Function forbids dynamic calls                         |     |     |     */
#define ZEND_ACC2_FORBID_DYN_CALLS       (1 << 0)  /*     |  X  |     |     */

#define ZEND_ACC_PPP_MASK  (ZEND_ACC_PUBLIC | ZEND_ACC_PROTECTED | ZEND_ACC_PRIVATE)
#define ZEND_ACC_PPP_SET_MASK  (ZEND_ACC_PUBLIC_SET | ZEND_ACC_PROTECTED_SET | ZEND_ACC_PRIVATE_SET)

static zend_always_inline uint32_t zend_visibility_to_set_visibility(uint32_t visibility)
{
  switch (visibility) {
    case ZEND_ACC_PUBLIC:
      return ZEND_ACC_PUBLIC_SET;
    case ZEND_ACC_PROTECTED:
      return ZEND_ACC_PROTECTED_SET;
    case ZEND_ACC_PRIVATE:
      return ZEND_ACC_PRIVATE_SET;
    default: ZEND_UNREACHABLE();
  }
}

/* call through internal function handler. e.g. Closure::invoke() */
#define ZEND_ACC_CALL_VIA_HANDLER     ZEND_ACC_CALL_VIA_TRAMPOLINE

#define ZEND_ACC_UNINSTANTIABLE (       \
  ZEND_ACC_INTERFACE |                \
  ZEND_ACC_TRAIT |                    \
  ZEND_ACC_IMPLICIT_ABSTRACT_CLASS |  \
  ZEND_ACC_EXPLICIT_ABSTRACT_CLASS |  \
  ZEND_ACC_ENUM                       \
)

#define ZEND_SHORT_CIRCUITING_CHAIN_MASK 0x3
#define ZEND_SHORT_CIRCUITING_CHAIN_EXPR 0
#define ZEND_SHORT_CIRCUITING_CHAIN_ISSET 1
#define ZEND_SHORT_CIRCUITING_CHAIN_EMPTY 2

// Must not clash with ZEND_SHORT_CIRCUITING_CHAIN_MASK
#define ZEND_JMP_NULL_BP_VAR_IS 4

const char *zend_visibility_string(uint32_t fn_flags);

#define ZEND_PROPERTY_HOOK_COUNT 2
#define ZEND_PROPERTY_HOOK_STRUCT_SIZE (sizeof(zend_function*) * ZEND_PROPERTY_HOOK_COUNT)

/* Stored in zend_property_info.offset, not returned by zend_get_property_offset(). */
#define ZEND_VIRTUAL_PROPERTY_OFFSET ((uint32_t)-1)

zend_property_hook_kind zend_get_property_hook_kind_from_name(const zend_string *name);

typedef struct _zend_property_info {
  uint32_t offset; /* property offset for object properties or
                        property index for static properties */
  uint32_t flags;
  zend_string *name;
  zend_string *doc_comment;
  HashTable *attributes;
  zend_class_entry *ce;
  zend_type type;
  const zend_property_info *prototype;
  zend_function **hooks;
} zend_property_info;

#define OBJ_PROP(obj, offset) \
  ((zval*)((char*)(obj) + offset))
#define OBJ_PROP_NUM(obj, num) \
  (&(obj)->properties_table[(num)])
#define OBJ_PROP_TO_OFFSET(num) \
  ((uint32_t)(offsetof(zend_object, properties_table) + sizeof(zval) * (num)))
#define OBJ_PROP_TO_NUM(offset) \
  (((offset) - OBJ_PROP_TO_OFFSET(0)) / sizeof(zval))
#define OBJ_PROP_SLOT_TO_OFFSET(obj, slot) \
  ((uintptr_t)(slot) - (uintptr_t)(obj))

typedef struct _zend_class_constant {
  zval value; /* flags are stored in u2 */
  zend_string *doc_comment;
  HashTable *attributes;
  zend_class_entry *ce;
  zend_type type;
} zend_class_constant;

#define ZEND_CLASS_CONST_FLAGS(c) Z_CONSTANT_FLAGS((c)->value)

C23_ENUM(zend_function_type, uint8_t) {
  ZEND_INTERNAL_FUNCTION = 1,
  ZEND_USER_FUNCTION = 2,
  ZEND_EVAL_CODE = 4,
};

/* arg_info for internal functions */
typedef struct _zend_internal_arg_info {
  const char *name;
  zend_type type;
  const char *default_value;
} zend_internal_arg_info;

/* arg_info for user functions */
typedef struct _zend_arg_info {
  zend_string *name;
  zend_type type;
  zend_string *default_value;
  zend_string *doc_comment;
} zend_arg_info;

/* the following structure repeats the layout of zend_internal_arg_info,
 * but its fields have different meaning. It's used as the first element of
 * arg_info array to define properties of internal functions.
 * It's also used for the return type.
 */
typedef struct _zend_internal_function_info {
  uintptr_t required_num_args;
  zend_type type;
  const char *default_value;
} zend_internal_function_info;

struct _zend_op_array {
  /* Common elements */
  zend_function_type type;
  uint8_t arg_flags[3]; /* bitset of arg_info.pass_by_reference */
  uint32_t fn_flags;
  zend_string *function_name;
  zend_class_entry *scope;
  zend_function *prototype;
  uint32_t num_args;
  uint32_t required_num_args;
  zend_arg_info *arg_info;
  HashTable *attributes;
  ZEND_MAP_PTR_DEF(void **, run_time_cache);
  zend_string *doc_comment;
  uint32_t T;         /* number of temporary variables */
  uint32_t fn_flags2;
  const zend_property_info *prop_info; /* The corresponding prop_info if this is a hook. */
  /* END of common elements */

  uint32_t cache_size; /* number of run_time_cache_slots * sizeof(void*) */
  int last_var;        /* number of CV variables */
  uint32_t last;       /* number of opcodes */

  zend_op *opcodes;
  ZEND_MAP_PTR_DEF(HashTable *, static_variables_ptr);
  HashTable *static_variables;
  zend_string **vars; /* names of CV variables */

  uint32_t *refcount;

  uint32_t last_live_range;
  uint32_t last_try_catch;
  zend_live_range *live_range;
  zend_try_catch_element *try_catch_array;

  zend_string *filename;
  uint32_t line_start;
  uint32_t line_end;

  uint32_t last_literal;
  uint32_t num_dynamic_func_defs;
  zval *literals;

  /* Functions that are declared dynamically are stored here and
   * referenced by index from opcodes. */
  zend_op_array **dynamic_func_defs;

  void *reserved[ZEND_MAX_RESERVED_RESOURCES];
};


#define ZEND_RETURN_VALUE       0
#define ZEND_RETURN_REFERENCE     1

#define INTERNAL_FUNCTION_PARAMETERS zend_execute_data *execute_data, zval *return_value
#define INTERNAL_FUNCTION_PARAM_PASSTHRU execute_data, return_value

/* zend_internal_function_handler */
typedef void (ZEND_FASTCALL *zif_handler)(INTERNAL_FUNCTION_PARAMETERS);

typedef struct _zend_internal_function {
  /* Common elements */
  zend_function_type type;
  uint8_t arg_flags[3]; /* bitset of arg_info.pass_by_reference */
  uint32_t fn_flags;
  zend_string* function_name;
  zend_class_entry *scope;
  zend_function *prototype;
  uint32_t num_args;
  uint32_t required_num_args;
  zend_arg_info *arg_info;
  HashTable *attributes;
  ZEND_MAP_PTR_DEF(void **, run_time_cache);
  zend_string *doc_comment;
  uint32_t T;         /* number of temporary variables */
  uint32_t fn_flags2;
  const zend_property_info *prop_info; /* The corresponding prop_info if this is a hook. */
  /* END of common elements */

  zif_handler handler;
  struct _zend_module_entry *module;
  const zend_frameless_function_info *frameless_function_infos;
  void *reserved[ZEND_MAX_RESERVED_RESOURCES];
} zend_internal_function;

#define ZEND_FN_SCOPE_NAME(function)  ((function) && (function)->common.scope ? ZSTR_VAL((function)->common.scope->name) : "")

union _zend_function {
  zend_function_type type;  /* MUST be the first element of this struct! */
  uint32_t   quick_arg_flags;

  struct {
    zend_function_type type;  /* never used */
    uint8_t arg_flags[3]; /* bitset of arg_info.pass_by_reference */
    uint32_t fn_flags;
    zend_string *function_name;
    zend_class_entry *scope;
    zend_function *prototype;
    uint32_t num_args;
    uint32_t required_num_args;
    zend_arg_info *arg_info;  /* index -1 represents the return value info, if any */
    HashTable   *attributes;
    ZEND_MAP_PTR_DEF(void **, run_time_cache);
    zend_string *doc_comment;
    uint32_t T;         /* number of temporary variables */
    uint32_t fn_flags2;
    const zend_property_info *prop_info; /* The corresponding prop_info if this is a hook. */
  } common;

  zend_op_array op_array;
  zend_internal_function internal_function;
};

struct _zend_execute_data {
  const zend_op       *opline;           /* executed opline                */
  zend_execute_data   *call;             /* current call                   */
  zval                *return_value;
  zend_function       *func;             /* executed function              */
  zval                 This;             /* this + call_info + num_args    */
  zend_execute_data   *prev_execute_data;
  zend_array          *symbol_table;
  void               **run_time_cache;   /* cache op_array->run_time_cache */
  zend_array          *extra_named_params;
};

#define ZEND_CALL_HAS_THIS           IS_OBJECT_EX

/* Top 16 bits of Z_TYPE_INFO(EX(This)) are used as call_info flags */
#define ZEND_CALL_FUNCTION           (0 << 16)
#define ZEND_CALL_CODE               (1 << 16)
#define ZEND_CALL_NESTED             (0 << 17)
#define ZEND_CALL_TOP                (1 << 17)
#define ZEND_CALL_ALLOCATED          (1 << 18)
#define ZEND_CALL_FREE_EXTRA_ARGS    (1 << 19)
#define ZEND_CALL_HAS_SYMBOL_TABLE   (1 << 20)
#define ZEND_CALL_RELEASE_THIS       (1 << 21)
#define ZEND_CALL_CLOSURE            (1 << 22)
#define ZEND_CALL_FAKE_CLOSURE       (1 << 23) /* Same as ZEND_ACC_FAKE_CLOSURE */
#define ZEND_CALL_GENERATOR          (1 << 24)
#define ZEND_CALL_DYNAMIC            (1 << 25)
#define ZEND_CALL_MAY_HAVE_UNDEF     (1 << 26)
#define ZEND_CALL_HAS_EXTRA_NAMED_PARAMS (1 << 27)
#define ZEND_CALL_OBSERVED           (1 << 28) /* "fcall_begin" observer handler may set this flag */
                                               /* to prevent optimization in RETURN handler and    */
                                               /* keep all local variables for "fcall_end" handler */
#define ZEND_CALL_JIT_RESERVED       (1 << 29) /* reserved for tracing JIT */
#define ZEND_CALL_NEEDS_REATTACH     (1 << 30)
#define ZEND_CALL_SEND_ARG_BY_REF    (1u << 31)

#define ZEND_CALL_NESTED_FUNCTION    (ZEND_CALL_FUNCTION | ZEND_CALL_NESTED)
#define ZEND_CALL_NESTED_CODE        (ZEND_CALL_CODE | ZEND_CALL_NESTED)
#define ZEND_CALL_TOP_FUNCTION       (ZEND_CALL_TOP | ZEND_CALL_FUNCTION)
#define ZEND_CALL_TOP_CODE           (ZEND_CALL_CODE | ZEND_CALL_TOP)

#define ZEND_CALL_INFO(call) \
  Z_TYPE_INFO((call)->This)

#define ZEND_CALL_KIND_EX(call_info) \
  (call_info & (ZEND_CALL_CODE | ZEND_CALL_TOP))

#define ZEND_CALL_KIND(call) \
  ZEND_CALL_KIND_EX(ZEND_CALL_INFO(call))

#define ZEND_ADD_CALL_FLAG_EX(call_info, flag) do { \
    call_info |= (flag); \
  } while (0)

#define ZEND_DEL_CALL_FLAG_EX(call_info, flag) do { \
    call_info &= ~(flag); \
  } while (0)

#define ZEND_ADD_CALL_FLAG(call, flag) do { \
    ZEND_ADD_CALL_FLAG_EX(Z_TYPE_INFO((call)->This), flag); \
  } while (0)

#define ZEND_DEL_CALL_FLAG(call, flag) do { \
    ZEND_DEL_CALL_FLAG_EX(Z_TYPE_INFO((call)->This), flag); \
  } while (0)

#define ZEND_CALL_NUM_ARGS(call) \
  (call)->This.u2.num_args

/* Ensure the correct alignment before slots calculation */
ZEND_STATIC_ASSERT(ZEND_MM_ALIGNED_SIZE(sizeof(zval)) == sizeof(zval),
                   "zval must be aligned by ZEND_MM_ALIGNMENT");
/* A number of call frame slots (zvals) reserved for zend_execute_data. */
#define ZEND_CALL_FRAME_SLOT \
  ((int)((sizeof(zend_execute_data) + sizeof(zval) - 1) / sizeof(zval)))

#define ZEND_CALL_VAR(call, n) \
  ((zval*)(((char*)(call)) + ((int)(n))))

#define ZEND_CALL_VAR_NUM(call, n) \
  (((zval*)(call)) + (ZEND_CALL_FRAME_SLOT + ((int)(n))))

#define ZEND_CALL_ARG(call, n) \
  ZEND_CALL_VAR_NUM(call, ((int)(n)) - 1)

#define EX(element)       ((execute_data)->element)

#define EX_CALL_INFO()      ZEND_CALL_INFO(execute_data)
#define EX_CALL_KIND()      ZEND_CALL_KIND(execute_data)
#define EX_NUM_ARGS()     ZEND_CALL_NUM_ARGS(execute_data)

#define ZEND_CALL_USES_STRICT_TYPES(call) \
  (((call)->func->common.fn_flags & ZEND_ACC_STRICT_TYPES) != 0)

#define EX_USES_STRICT_TYPES() \
  ZEND_CALL_USES_STRICT_TYPES(execute_data)

#define ZEND_ARG_USES_STRICT_TYPES() \
  (EG(current_execute_data)->prev_execute_data && \
   EG(current_execute_data)->prev_execute_data->func && \
   ZEND_CALL_USES_STRICT_TYPES(EG(current_execute_data)->prev_execute_data))

#define ZEND_FLF_ARG_USES_STRICT_TYPES() \
  (EG(current_execute_data) && \
   EG(current_execute_data)->func && \
   ZEND_CALL_USES_STRICT_TYPES(EG(current_execute_data)))

#define ZEND_RET_USES_STRICT_TYPES() \
  ZEND_CALL_USES_STRICT_TYPES(EG(current_execute_data))

#define EX_VAR(n)       ZEND_CALL_VAR(execute_data, n)
#define EX_VAR_NUM(n)     ZEND_CALL_VAR_NUM(execute_data, n)

#define EX_VAR_TO_NUM(n)    ((uint32_t)((n) / sizeof(zval) - ZEND_CALL_FRAME_SLOT))
#define EX_NUM_TO_VAR(n)    ((uint32_t)(((n) + ZEND_CALL_FRAME_SLOT) * sizeof(zval)))

#define ZEND_OPLINE_TO_OFFSET(opline, target) \
  ((char*)(target) - (char*)(opline))

#define ZEND_OPLINE_NUM_TO_OFFSET(op_array, opline, opline_num) \
  ((char*)&(op_array)->opcodes[opline_num] - (char*)(opline))

#define ZEND_OFFSET_TO_OPLINE(base, offset) \
  ((zend_op*)(((char*)(base)) + (int)offset))

#define ZEND_OFFSET_TO_OPLINE_NUM(op_array, base, offset) \
  (ZEND_OFFSET_TO_OPLINE(base, offset) - op_array->opcodes)

#if ZEND_USE_ABS_JMP_ADDR

/* run-time jump target */
# define OP_JMP_ADDR(opline, node) \
  (node).jmp_addr

# define ZEND_SET_OP_JMP_ADDR(opline, node, val) do { \
    (node).jmp_addr = (val); \
  } while (0)

/* convert jump target from compile-time to run-time */
# define ZEND_PASS_TWO_UPDATE_JMP_TARGET(op_array, opline, node) do { \
    (node).jmp_addr = (op_array)->opcodes + (node).opline_num; \
  } while (0)

/* convert jump target back from run-time to compile-time */
# define ZEND_PASS_TWO_UNDO_JMP_TARGET(op_array, opline, node) do { \
    (node).opline_num = (node).jmp_addr - (op_array)->opcodes; \
  } while (0)

#else

/* run-time jump target */
# define OP_JMP_ADDR(opline, node) \
  ZEND_OFFSET_TO_OPLINE(opline, (node).jmp_offset)

# define ZEND_SET_OP_JMP_ADDR(opline, node, val) do { \
    (node).jmp_offset = ZEND_OPLINE_TO_OFFSET(opline, val); \
  } while (0)

/* convert jump target from compile-time to run-time */
# define ZEND_PASS_TWO_UPDATE_JMP_TARGET(op_array, opline, node) do { \
    (node).jmp_offset = ZEND_OPLINE_NUM_TO_OFFSET(op_array, opline, (node).opline_num); \
  } while (0)

/* convert jump target back from run-time to compile-time */
# define ZEND_PASS_TWO_UNDO_JMP_TARGET(op_array, opline, node) do { \
    (node).opline_num = ZEND_OFFSET_TO_OPLINE_NUM(op_array, opline, (node).jmp_offset); \
  } while (0)

#endif

/* constant-time constant */
# define CT_CONSTANT_EX(op_array, num) \
  ((op_array)->literals + (num))

# define CT_CONSTANT(node) \
  CT_CONSTANT_EX(CG(active_op_array), (node).constant)

#if ZEND_USE_ABS_CONST_ADDR

/* run-time constant */
# define RT_CONSTANT(opline, node) \
  (node).zv

/* convert constant from compile-time to run-time */
# define ZEND_PASS_TWO_UPDATE_CONSTANT(op_array, opline, node) do { \
    (node).zv = CT_CONSTANT_EX(op_array, (node).constant); \
  } while (0)

#else

/* At run-time, constants are allocated together with op_array->opcodes
 * and addressed relatively to current opline.
 */

/* run-time constant */
# define RT_CONSTANT(opline, node) \
  ((zval*)(((char*)(opline)) + (int32_t)(node).constant))

/* convert constant from compile-time to run-time */
# define ZEND_PASS_TWO_UPDATE_CONSTANT(op_array, opline, node) do { \
    (node).constant = \
      (((char*)CT_CONSTANT_EX(op_array, (node).constant)) - \
      ((char*)opline)); \
  } while (0)

#endif

/* convert constant back from run-time to compile-time */
#define ZEND_PASS_TWO_UNDO_CONSTANT(op_array, opline, node) do { \
    (node).constant = RT_CONSTANT(opline, node) - (op_array)->literals; \
  } while (0)

#define RUN_TIME_CACHE(op_array) \
  ZEND_MAP_PTR_GET((op_array)->run_time_cache)

#define ZEND_OP_ARRAY_EXTENSION(op_array, handle) \
  ((void**)RUN_TIME_CACHE(op_array))[handle]

#define IS_UNUSED 0    /* Unused operand */
#define IS_CONST  (1<<0)
#define IS_TMP_VAR  (1<<1)
#define IS_VAR    (1<<2)
#define IS_CV   (1<<3)  /* Compiled variable */

/* Used for result.type of smart branch instructions */
#define IS_SMART_BRANCH_JMPZ  (1<<4)
#define IS_SMART_BRANCH_JMPNZ (1<<5)

#define ZEND_EXTRA_VALUE 1

#include "zend_globals.h"

typedef enum _zend_compile_position {
  ZEND_COMPILE_POSITION_AT_SHEBANG = 0,
  ZEND_COMPILE_POSITION_AT_OPEN_TAG,
  ZEND_COMPILE_POSITION_AFTER_OPEN_TAG
} zend_compile_position;

BEGIN_EXTERN_C()

void init_compiler(void);
void shutdown_compiler(void);
void zend_init_compiler_data_structures(void);

void zend_oparray_context_begin(zend_oparray_context *prev_context, zend_op_array *op_array);
void zend_oparray_context_end(const zend_oparray_context *prev_context);
void zend_file_context_begin(zend_file_context *prev_context);
void zend_file_context_end(const zend_file_context *prev_context);

extern ZEND_API zend_op_array *(*zend_compile_file)(zend_file_handle *file_handle, int type);
extern ZEND_API zend_op_array *(*zend_compile_string)(zend_string *source_string, const char *filename, zend_compile_position position);

ZEND_API int ZEND_FASTCALL lex_scan(zval *zendlval, zend_parser_stack_elem *elem);
void startup_scanner(void);
void shutdown_scanner(void);

ZEND_API zend_string *zend_set_compiled_filename(zend_string *new_compiled_filename);
ZEND_API void zend_restore_compiled_filename(zend_string *original_compiled_filename);
ZEND_API zend_string *zend_get_compiled_filename(void);
ZEND_API uint32_t zend_get_compiled_lineno(void);
ZEND_API size_t zend_get_scanned_file_offset(void);

ZEND_API zend_string *zend_get_compiled_variable_name(const zend_op_array *op_array, uint32_t var);

#ifdef ZTS
const char *zend_get_zendtext(void);
#endif

typedef zend_result (ZEND_FASTCALL *unary_op_type)(zval *, zval *);
typedef zend_result (ZEND_FASTCALL *binary_op_type)(zval *, zval *, zval *);

ZEND_API unary_op_type get_unary_op(int opcode);
ZEND_API binary_op_type get_binary_op(int opcode);

void zend_stop_lexing(void);
void zend_emit_final_return(bool return_one);

typedef enum {
  ZEND_MODIFIER_TARGET_PROPERTY = 0,
  ZEND_MODIFIER_TARGET_METHOD,
  ZEND_MODIFIER_TARGET_CONSTANT,
  ZEND_MODIFIER_TARGET_CPP,
  ZEND_MODIFIER_TARGET_PROPERTY_HOOK,
} zend_modifier_target;

/* Used during AST construction */
zend_ast *zend_ast_append_str(zend_ast *left, zend_ast *right);
zend_ast *zend_negate_num_string(zend_ast *ast);
uint32_t zend_add_class_modifier(uint32_t flags, uint32_t new_flag);
uint32_t zend_add_anonymous_class_modifier(uint32_t flags, uint32_t new_flag);
uint32_t zend_add_member_modifier(uint32_t flags, uint32_t new_flag, zend_modifier_target target);

uint32_t zend_modifier_token_to_flag(zend_modifier_target target, uint32_t flags);
uint32_t zend_modifier_list_to_flags(zend_modifier_target target, zend_ast *modifiers);

bool zend_handle_encoding_declaration(zend_ast *ast);

ZEND_API zend_class_entry *zend_bind_class_in_slot(
    zval *class_table_slot, const zval *lcname, zend_string *lc_parent_name);
ZEND_API zend_result do_bind_function(zend_function *func, const zval *lcname);
ZEND_API zend_result do_bind_class(zval *lcname, zend_string *lc_parent_name);

void zend_resolve_goto_label(zend_op_array *op_array, zend_op *opline);

ZEND_API void function_add_ref(zend_function *function);
zend_string *zval_make_interned_string(zval *zv);

#define INITIAL_OP_ARRAY_SIZE 64


/* helper functions in zend_language_scanner.l */
struct _zend_arena;

ZEND_API zend_op_array *compile_file(zend_file_handle *file_handle, int type);
ZEND_API zend_op_array *compile_string(zend_string *source_string, const char *filename, zend_compile_position position);
ZEND_API zend_op_array *compile_filename(int type, zend_string *filename);
ZEND_API zend_op_array *zend_compile_ast(zend_ast *ast, int type, zend_string *filename);
ZEND_API zend_ast *zend_compile_string_to_ast(
    zend_string *code, struct _zend_arena **ast_arena, zend_string *filename);
ZEND_API zend_result zend_execute_scripts(int type, zval *retval, int file_count, ...);
ZEND_API zend_result zend_execute_script(int type, zval *retval, zend_file_handle *file_handle);
ZEND_API zend_result open_file_for_scanning(zend_file_handle *file_handle);
ZEND_API void init_op_array(zend_op_array *op_array, zend_function_type type, int initial_ops_size);
ZEND_API void destroy_op_array(zend_op_array *op_array);
ZEND_API void zend_destroy_static_vars(zend_op_array *op_array);
ZEND_API void zend_destroy_file_handle(zend_file_handle *file_handle);
ZEND_API void zend_cleanup_mutable_class_data(zend_class_entry *ce);
ZEND_API void zend_cleanup_internal_class_data(zend_class_entry *ce);
ZEND_API void zend_type_release(zend_type type, bool persistent);
ZEND_API zend_string *zend_create_member_string(const zend_string *class_name, const zend_string *member_name);


ZEND_API ZEND_COLD void zend_user_exception_handler(void);

#define zend_try_exception_handler() do { \
    if (UNEXPECTED(EG(exception))) { \
      if (Z_TYPE(EG(user_exception_handler)) != IS_UNDEF) { \
        zend_user_exception_handler(); \
      } \
    } \
  } while (0)

ZEND_API void zend_free_internal_arg_info(zend_internal_function *function,
    bool permanent);
ZEND_API void destroy_zend_function(zend_function *function);
ZEND_API void zend_function_dtor(zval *zv);
ZEND_API void destroy_zend_class(zval *zv);
void zend_class_add_ref(zval *zv);

ZEND_API zend_string *zend_mangle_property_name(const char *src1, size_t src1_length, const char *src2, size_t src2_length, bool internal);
#define zend_unmangle_property_name(mangled_property, class_name, prop_name) \
        zend_unmangle_property_name_ex(mangled_property, class_name, prop_name, NULL)
ZEND_API zend_result zend_unmangle_property_name_ex(const zend_string *name, const char **class_name, const char **prop_name, size_t *prop_len);

static zend_always_inline const char *zend_get_unmangled_property_name(const zend_string *mangled_prop) {
  const char *class_name, *prop_name;
  zend_unmangle_property_name(mangled_prop, &class_name, &prop_name);
  return prop_name;
}

#define ZEND_FUNCTION_DTOR zend_function_dtor
#define ZEND_CLASS_DTOR destroy_zend_class

typedef bool (*zend_needs_live_range_cb)(const zend_op_array *op_array, const zend_op *opline);
ZEND_API void zend_recalc_live_ranges(
  zend_op_array *op_array, zend_needs_live_range_cb needs_live_range);

ZEND_API void pass_two(zend_op_array *op_array);
ZEND_API bool zend_is_compiling(void);
ZEND_API char *zend_make_compiled_string_description(const char *name);
ZEND_API void zend_initialize_class_data(zend_class_entry *ce, bool nullify_handlers);
uint32_t zend_get_class_fetch_type(const zend_string *name);
ZEND_API uint8_t zend_get_call_op(const zend_op *init_op, const zend_function *fbc, bool result_used);
ZEND_API bool zend_is_smart_branch(const zend_op *opline);

typedef bool (*zend_auto_global_callback)(zend_string *name);
typedef struct _zend_auto_global {
  zend_string *name;
  zend_auto_global_callback auto_global_callback;
  bool jit;
  bool armed;
} zend_auto_global;

ZEND_API zend_result zend_register_auto_global(zend_string *name, bool jit, zend_auto_global_callback auto_global_callback);
ZEND_API void zend_activate_auto_globals(void);
ZEND_API bool zend_is_auto_global(zend_string *name);
ZEND_API bool zend_is_auto_global_str(const char *name, size_t len);
ZEND_API size_t zend_dirname(char *path, size_t len);
ZEND_API void zend_set_function_arg_flags(zend_function *func);

int ZEND_FASTCALL zendlex(zend_parser_stack_elem *elem);

void zend_assert_valid_class_name(const zend_string *const_name, const char *type);

zend_string *zend_type_to_string_resolved(zend_type type, const zend_class_entry *scope);
ZEND_API zend_string *zend_type_to_string(zend_type type);

/* class fetches */
#define ZEND_FETCH_CLASS_DEFAULT  0
#define ZEND_FETCH_CLASS_SELF   1
#define ZEND_FETCH_CLASS_PARENT   2
#define ZEND_FETCH_CLASS_STATIC   3
#define ZEND_FETCH_CLASS_AUTO   4
#define ZEND_FETCH_CLASS_INTERFACE  5
#define ZEND_FETCH_CLASS_TRAIT    6
#define ZEND_FETCH_CLASS_MASK        0x0f
#define ZEND_FETCH_CLASS_NO_AUTOLOAD 0x80
#define ZEND_FETCH_CLASS_SILENT      0x0100
#define ZEND_FETCH_CLASS_EXCEPTION   0x0200
#define ZEND_FETCH_CLASS_ALLOW_UNLINKED 0x0400
#define ZEND_FETCH_CLASS_ALLOW_NEARLY_LINKED 0x0800

/* These should not clash with ZEND_ACC_PPP_MASK and ZEND_ACC_PPP_SET_MASK */
#define ZEND_PARAM_REF      (1<<3)
#define ZEND_PARAM_VARIADIC (1<<4)

#define ZEND_NAME_FQ       0
#define ZEND_NAME_NOT_FQ   1
#define ZEND_NAME_RELATIVE 2

/* ZEND_FETCH_ flags in class name AST of new const expression must not clash with ZEND_NAME_ flags */
#define ZEND_CONST_EXPR_NEW_FETCH_TYPE_SHIFT 2

#define ZEND_TYPE_NULLABLE (1<<8)

#define ZEND_ARRAY_SYNTAX_LIST 1  /* list() */
#define ZEND_ARRAY_SYNTAX_LONG 2  /* array() */
#define ZEND_ARRAY_SYNTAX_SHORT 3 /* [] */

/* var status for backpatching */
#define BP_VAR_R      0
#define BP_VAR_W      1
#define BP_VAR_RW     2
#define BP_VAR_IS     3
#define BP_VAR_FUNC_ARG   4
#define BP_VAR_UNSET    5

#define ZEND_USER_CODE(type)    ((type) != ZEND_INTERNAL_FUNCTION)

#define ZEND_EVAL       (1<<0)
#define ZEND_INCLUDE      (1<<1)
#define ZEND_INCLUDE_ONCE   (1<<2)
#define ZEND_REQUIRE      (1<<3)
#define ZEND_REQUIRE_ONCE   (1<<4)

/* global/local fetches */
#define ZEND_FETCH_GLOBAL   (1<<1)
#define ZEND_FETCH_LOCAL    (1<<2)
#define ZEND_FETCH_GLOBAL_LOCK  (1<<3)

#define ZEND_FETCH_TYPE_MASK  0xe

/* Only one of these can ever be in use */
#define ZEND_FETCH_REF      1
#define ZEND_FETCH_DIM_WRITE  2
#define ZEND_FETCH_OBJ_FLAGS  3

/* Used to mark what kind of operation a writing FETCH_DIM is used in,
 * to produce a more precise error on incorrect string offset use. */
#define ZEND_FETCH_DIM_REF 1
#define ZEND_FETCH_DIM_DIM 2
#define ZEND_FETCH_DIM_OBJ 3
#define ZEND_FETCH_DIM_INCDEC 4

#define ZEND_ISEMPTY      (1<<0)

#define ZEND_LAST_CATCH     (1<<0)

#define ZEND_FREE_ON_RETURN     (1<<0)
#define ZEND_FREE_SWITCH        (1<<1)
#define ZEND_FREE_VOID_CAST     (1<<2)

#define ZEND_SEND_BY_VAL     0u
#define ZEND_SEND_BY_REF     1u
#define ZEND_SEND_PREFER_REF 2u

#define ZEND_THROW_IS_EXPR 1u

#define ZEND_FCALL_MAY_HAVE_EXTRA_NAMED_PARAMS (1<<0)

/* The send mode, the is_variadic, the is_promoted, and the is_tentative flags are stored as part of zend_type */
#define _ZEND_SEND_MODE_SHIFT _ZEND_TYPE_EXTRA_FLAGS_SHIFT
#define _ZEND_IS_VARIADIC_BIT (1 << (_ZEND_TYPE_EXTRA_FLAGS_SHIFT + 2))
#define _ZEND_IS_PROMOTED_BIT (1 << (_ZEND_TYPE_EXTRA_FLAGS_SHIFT + 3))
#define _ZEND_IS_TENTATIVE_BIT (1 << (_ZEND_TYPE_EXTRA_FLAGS_SHIFT + 4))
#define ZEND_ARG_SEND_MODE(arg_info) \
  ((ZEND_TYPE_FULL_MASK((arg_info)->type) >> _ZEND_SEND_MODE_SHIFT) & 3)
#define ZEND_ARG_IS_VARIADIC(arg_info) \
  ((ZEND_TYPE_FULL_MASK((arg_info)->type) & _ZEND_IS_VARIADIC_BIT) != 0)
#define ZEND_ARG_IS_PROMOTED(arg_info) \
  ((ZEND_TYPE_FULL_MASK((arg_info)->type) & _ZEND_IS_PROMOTED_BIT) != 0)
#define ZEND_ARG_TYPE_IS_TENTATIVE(arg_info) \
  ((ZEND_TYPE_FULL_MASK((arg_info)->type) & _ZEND_IS_TENTATIVE_BIT) != 0)

#define ZEND_DIM_IS         (1 << 0) /* isset fetch needed for null coalesce. Set in zend_compile.c for ZEND_AST_DIM nested within ZEND_AST_COALESCE. */
#define ZEND_ALT_CASE_SYNTAX    (1 << 1) /* deprecated switch case terminated by semicolon */

/* Attributes for ${} encaps var in strings (ZEND_AST_DIM or ZEND_AST_VAR node) */
/* ZEND_AST_VAR nodes can have any of the ZEND_ENCAPS_VAR_* flags */
/* ZEND_AST_DIM flags can have ZEND_ENCAPS_VAR_DOLLAR_CURLY during the parse phase. */
#define ZEND_ENCAPS_VAR_DOLLAR_CURLY (1 << 0)
#define ZEND_ENCAPS_VAR_DOLLAR_CURLY_VAR_VAR (1 << 1)

/* Make sure these don't clash with ZEND_FETCH_CLASS_* flags. */
#define IS_CONSTANT_CLASS                    0x400 /* __CLASS__ in trait */
#define IS_CONSTANT_UNQUALIFIED_IN_NAMESPACE 0x800

static zend_always_inline bool zend_check_arg_send_type(const zend_function *zf, uint32_t arg_num, uint32_t mask)
{
  arg_num--;
  if (UNEXPECTED(arg_num >= zf->common.num_args)) {
    if (EXPECTED((zf->common.fn_flags & ZEND_ACC_VARIADIC) == 0)) {
      return 0;
    }
    arg_num = zf->common.num_args;
  }
  return UNEXPECTED((ZEND_ARG_SEND_MODE(&zf->common.arg_info[arg_num]) & mask) != 0);
}

#define ARG_MUST_BE_SENT_BY_REF(zf, arg_num) \
  zend_check_arg_send_type(zf, arg_num, ZEND_SEND_BY_REF)

#define ARG_SHOULD_BE_SENT_BY_REF(zf, arg_num) \
  zend_check_arg_send_type(zf, arg_num, ZEND_SEND_BY_REF|ZEND_SEND_PREFER_REF)

#define ARG_MAY_BE_SENT_BY_REF(zf, arg_num) \
  zend_check_arg_send_type(zf, arg_num, ZEND_SEND_PREFER_REF)

/* Quick API to check first 12 arguments */
#define MAX_ARG_FLAG_NUM 12

#ifdef WORDS_BIGENDIAN
# define ZEND_SET_ARG_FLAG(zf, arg_num, mask) do { \
    (zf)->quick_arg_flags |= ((mask) << ((arg_num) - 1) * 2); \
  } while (0)
# define ZEND_CHECK_ARG_FLAG(zf, arg_num, mask) \
  (((zf)->quick_arg_flags >> (((arg_num) - 1) * 2)) & (mask))
#else
# define ZEND_SET_ARG_FLAG(zf, arg_num, mask) do { \
    (zf)->quick_arg_flags |= (((mask) << 6) << (arg_num) * 2); \
  } while (0)
# define ZEND_CHECK_ARG_FLAG(zf, arg_num, mask) \
  (((zf)->quick_arg_flags >> (((arg_num) + 3) * 2)) & (mask))
#endif

#define QUICK_ARG_MUST_BE_SENT_BY_REF(zf, arg_num) \
  ZEND_CHECK_ARG_FLAG(zf, arg_num, ZEND_SEND_BY_REF)

#define QUICK_ARG_SHOULD_BE_SENT_BY_REF(zf, arg_num) \
  ZEND_CHECK_ARG_FLAG(zf, arg_num, ZEND_SEND_BY_REF|ZEND_SEND_PREFER_REF)

#define QUICK_ARG_MAY_BE_SENT_BY_REF(zf, arg_num) \
  ZEND_CHECK_ARG_FLAG(zf, arg_num, ZEND_SEND_PREFER_REF)

#define ZEND_RETURN_VAL 0
#define ZEND_RETURN_REF 1

#define ZEND_BIND_VAL      0
#define ZEND_BIND_REF      1
#define ZEND_BIND_IMPLICIT 2
#define ZEND_BIND_EXPLICIT 4

#define ZEND_RETURNS_FUNCTION (1<<0)
#define ZEND_RETURNS_VALUE    (1<<1)

#define ZEND_ARRAY_ELEMENT_REF    (1<<0)
#define ZEND_ARRAY_NOT_PACKED   (1<<1)
#define ZEND_ARRAY_SIZE_SHIFT   2

/* Attribute for ternary inside parentheses */
#define ZEND_PARENTHESIZED_CONDITIONAL 1

/* Used to distinguish (parent::$prop)::get() from parent hook call. */
#define ZEND_PARENTHESIZED_STATIC_PROP 1

/* Used to disallow pipes with arrow functions that lead to confusing parse trees. */
#define ZEND_PARENTHESIZED_ARROW_FUNC 1

/* For "use" AST nodes and the seen symbol table */
#define ZEND_SYMBOL_CLASS    (1<<0)
#define ZEND_SYMBOL_FUNCTION (1<<1)
#define ZEND_SYMBOL_CONST    (1<<2)

/* All increment opcodes are even (decrement are odd) */
#define ZEND_IS_INCREMENT(opcode) (((opcode) & 1) == 0)

#define ZEND_IS_BINARY_ASSIGN_OP_OPCODE(opcode) \
  (((opcode) >= ZEND_ADD) && ((opcode) <= ZEND_POW))

/* PFAs/FCCs */
#define ZEND_PLACEHOLDER_VARIADIC (1<<0)

/* Pseudo-opcodes that are used only temporarily during compilation */
#define ZEND_GOTO  253
#define ZEND_BRK   254
#define ZEND_CONT  255


END_EXTERN_C()

#define ZEND_CLONE_FUNC_NAME    "__clone"
#define ZEND_CONSTRUCTOR_FUNC_NAME  "__construct"
#define ZEND_DESTRUCTOR_FUNC_NAME "__destruct"
#define ZEND_GET_FUNC_NAME          "__get"
#define ZEND_SET_FUNC_NAME          "__set"
#define ZEND_UNSET_FUNC_NAME        "__unset"
#define ZEND_ISSET_FUNC_NAME        "__isset"
#define ZEND_CALL_FUNC_NAME         "__call"
#define ZEND_CALLSTATIC_FUNC_NAME   "__callStatic"
#define ZEND_CALLSTATIC_FUNC_LCNAME "__callstatic"
#define ZEND_TOSTRING_FUNC_NAME     "__toString"
#define ZEND_TOSTRING_FUNC_LCNAME   "__tostring"
#define ZEND_INVOKE_FUNC_NAME       "__invoke"
#define ZEND_DEBUGINFO_FUNC_NAME    "__debugInfo"
#define ZEND_DEBUGINFO_FUNC_LCNAME  "__debuginfo"
#define ZEND_SLEEP_FUNC_NAME        "__sleep"
#define ZEND_WAKEUP_FUNC_NAME       "__wakeup"
#define ZEND_SERIALIZE_FUNC_NAME    "__serialize"
#define ZEND_UNSERIALIZE_FUNC_NAME  "__unserialize"
#define ZEND_SET_STATE_FUNC_NAME    "__set_state"

/* The following constants may be combined in CG(compiler_options)
 * to change the default compiler behavior */

/* generate extended debug information */
#define ZEND_COMPILE_EXTENDED_STMT              (1<<0)
#define ZEND_COMPILE_EXTENDED_FCALL             (1<<1)
#define ZEND_COMPILE_EXTENDED_INFO              (ZEND_COMPILE_EXTENDED_STMT|ZEND_COMPILE_EXTENDED_FCALL)

/* call op_array handler of extensions */
#define ZEND_COMPILE_HANDLE_OP_ARRAY            (1<<2)

/* generate ZEND_INIT_FCALL_BY_NAME for internal functions instead of ZEND_INIT_FCALL */
#define ZEND_COMPILE_IGNORE_INTERNAL_FUNCTIONS  (1<<3)

/* don't perform early binding for classes inherited form internal ones;
 * in namespaces assume that internal class that doesn't exist at compile-time
 * may appear in run-time */
#define ZEND_COMPILE_IGNORE_INTERNAL_CLASSES    (1<<4)

/* generate ZEND_DECLARE_CLASS_DELAYED opcode to delay early binding */
#define ZEND_COMPILE_DELAYED_BINDING            (1<<5)

/* disable constant substitution at compile-time */
#define ZEND_COMPILE_NO_CONSTANT_SUBSTITUTION   (1<<6)

/* disable substitution of persistent constants at compile-time */
#define ZEND_COMPILE_NO_PERSISTENT_CONSTANT_SUBSTITUTION  (1<<8)

/* generate ZEND_INIT_FCALL_BY_NAME for userland functions instead of ZEND_INIT_FCALL */
#define ZEND_COMPILE_IGNORE_USER_FUNCTIONS      (1<<9)

/* force ZEND_ACC_USE_GUARDS for all classes */
#define ZEND_COMPILE_GUARDS           (1<<10)

/* disable builtin special case function calls */
#define ZEND_COMPILE_NO_BUILTINS        (1<<11)

/* result of compilation may be stored in file cache */
#define ZEND_COMPILE_WITH_FILE_CACHE      (1<<12)

/* ignore functions and classes declared in other files */
#define ZEND_COMPILE_IGNORE_OTHER_FILES     (1<<13)

/* this flag is set when compiler invoked by opcache_compile_file() */
#define ZEND_COMPILE_WITHOUT_EXECUTION          (1<<14)

/* this flag is set when compiler invoked during preloading */
#define ZEND_COMPILE_PRELOAD                    (1<<15)

/* disable jumptable optimization for switch statements */
#define ZEND_COMPILE_NO_JUMPTABLES        (1<<16)

/* this flag is set when compiler invoked during preloading in separate process */
#define ZEND_COMPILE_PRELOAD_IN_CHILD           (1<<17)

/* ignore observer notifications, e.g. to manually notify afterwards in a post-processing step after compilation */
#define ZEND_COMPILE_IGNORE_OBSERVER      (1<<18)

/* The default value for CG(compiler_options) */
#define ZEND_COMPILE_DEFAULT          ZEND_COMPILE_HANDLE_OP_ARRAY

/* The default value for CG(compiler_options) during eval() */
#define ZEND_COMPILE_DEFAULT_FOR_EVAL     0

ZEND_API bool zend_is_op_long_compatible(const zval *op);
ZEND_API bool zend_binary_op_produces_error(uint32_t opcode, const zval *op1, const zval *op2);
ZEND_API bool zend_unary_op_produces_error(uint32_t opcode, const zval *op);

bool zend_try_ct_eval_cast(zval *result, uint32_t type, zval *op1);

bool zend_op_may_elide_result(uint8_t opcode);

#endif /* ZEND_COMPILE_H */

Coverage Report

Created: 2026-09-14 06:25