/src/php-src/Zend/zend_ast.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: Bob Weinand <bwoebi@php.net>                                |
   |          Dmitry Stogov <dmitry@php.net>                              |
   |          Nikita Popov <nikic@php.net>                                |
   +----------------------------------------------------------------------+
*/

#ifndef ZEND_AST_H
#define ZEND_AST_H

#include "zend_types.h"
#include "zend_map_ptr.h"

#ifndef ZEND_AST_SPEC
# define ZEND_AST_SPEC 1
#endif

#define ZEND_AST_SPECIAL_SHIFT      6
#define ZEND_AST_IS_LIST_SHIFT      7
#define ZEND_AST_NUM_CHILDREN_SHIFT 8

enum _zend_ast_kind {
  /* special nodes */
  ZEND_AST_ZVAL = 1 << ZEND_AST_SPECIAL_SHIFT,
  ZEND_AST_CONSTANT,
  ZEND_AST_OP_ARRAY,
  ZEND_AST_ZNODE,

  /* declaration nodes */
  ZEND_AST_FUNC_DECL,
  ZEND_AST_CLOSURE,
  ZEND_AST_METHOD,
  ZEND_AST_CLASS,
  ZEND_AST_ARROW_FUNC,
  ZEND_AST_PROPERTY_HOOK,

  /* list nodes */
  ZEND_AST_ARG_LIST = 1 << ZEND_AST_IS_LIST_SHIFT,
  ZEND_AST_ARRAY,
  ZEND_AST_ENCAPS_LIST,
  ZEND_AST_EXPR_LIST,
  ZEND_AST_STMT_LIST,
  ZEND_AST_IF,
  ZEND_AST_SWITCH_LIST,
  ZEND_AST_CATCH_LIST,
  ZEND_AST_PARAM_LIST,
  ZEND_AST_CLOSURE_USES,
  ZEND_AST_PROP_DECL,
  ZEND_AST_CONST_DECL,
  ZEND_AST_CLASS_CONST_DECL,
  ZEND_AST_NAME_LIST,
  ZEND_AST_TRAIT_ADAPTATIONS,
  ZEND_AST_USE,
  ZEND_AST_TYPE_UNION,
  ZEND_AST_TYPE_INTERSECTION,
  ZEND_AST_ATTRIBUTE_LIST,
  ZEND_AST_ATTRIBUTE_GROUP,
  ZEND_AST_MATCH_ARM_LIST,
  ZEND_AST_MODIFIER_LIST,

  /* 0 child nodes */
  ZEND_AST_MAGIC_CONST = 0 << ZEND_AST_NUM_CHILDREN_SHIFT,
  ZEND_AST_TYPE,
  ZEND_AST_CONSTANT_CLASS,
  ZEND_AST_CALLABLE_CONVERT,
  ZEND_AST_PLACEHOLDER_ARG,

  /* 1 child node */
  ZEND_AST_VAR = 1 << ZEND_AST_NUM_CHILDREN_SHIFT,
  ZEND_AST_CONST,
  ZEND_AST_UNPACK,
  ZEND_AST_UNARY_PLUS,
  ZEND_AST_UNARY_MINUS,
  ZEND_AST_CAST,
  ZEND_AST_CAST_VOID,
  ZEND_AST_EMPTY,
  ZEND_AST_ISSET,
  ZEND_AST_SILENCE,
  ZEND_AST_SHELL_EXEC,
  ZEND_AST_PRINT,
  ZEND_AST_INCLUDE_OR_EVAL,
  ZEND_AST_UNARY_OP,
  ZEND_AST_PRE_INC,
  ZEND_AST_PRE_DEC,
  ZEND_AST_POST_INC,
  ZEND_AST_POST_DEC,
  ZEND_AST_YIELD_FROM,
  ZEND_AST_CLASS_NAME,

  ZEND_AST_GLOBAL,
  ZEND_AST_UNSET,
  ZEND_AST_RETURN,
  ZEND_AST_LABEL,
  ZEND_AST_REF,
  ZEND_AST_HALT_COMPILER,
  ZEND_AST_ECHO,
  ZEND_AST_THROW,
  ZEND_AST_GOTO,
  ZEND_AST_BREAK,
  ZEND_AST_CONTINUE,
  ZEND_AST_PROPERTY_HOOK_SHORT_BODY,

  /* 2 child nodes */
  ZEND_AST_DIM = 2 << ZEND_AST_NUM_CHILDREN_SHIFT,
  ZEND_AST_PROP,
  ZEND_AST_NULLSAFE_PROP,
  ZEND_AST_STATIC_PROP,
  ZEND_AST_CALL,
  ZEND_AST_CLASS_CONST,
  ZEND_AST_ASSIGN,
  ZEND_AST_ASSIGN_REF,
  ZEND_AST_ASSIGN_OP,
  ZEND_AST_BINARY_OP,
  ZEND_AST_GREATER,
  ZEND_AST_GREATER_EQUAL,
  ZEND_AST_AND,
  ZEND_AST_OR,
  ZEND_AST_ARRAY_ELEM,
  ZEND_AST_NEW,
  ZEND_AST_INSTANCEOF,
  ZEND_AST_YIELD,
  ZEND_AST_COALESCE,
  ZEND_AST_ASSIGN_COALESCE,

  ZEND_AST_STATIC,
  ZEND_AST_WHILE,
  ZEND_AST_DO_WHILE,
  ZEND_AST_IF_ELEM,
  ZEND_AST_SWITCH,
  ZEND_AST_SWITCH_CASE,
  ZEND_AST_DECLARE,
  ZEND_AST_USE_TRAIT,
  ZEND_AST_TRAIT_PRECEDENCE,
  ZEND_AST_TRAIT_METHOD_REFERENCE,
  ZEND_AST_NAMESPACE,
  ZEND_AST_USE_ELEM,
  ZEND_AST_TRAIT_ALIAS,
  ZEND_AST_GROUP_USE,
  ZEND_AST_ATTRIBUTE,
  ZEND_AST_MATCH,
  ZEND_AST_MATCH_ARM,
  ZEND_AST_NAMED_ARG,
  ZEND_AST_PIPE,

  /* 3 child nodes */
  ZEND_AST_METHOD_CALL = 3 << ZEND_AST_NUM_CHILDREN_SHIFT,
  ZEND_AST_NULLSAFE_METHOD_CALL,
  ZEND_AST_STATIC_CALL,
  ZEND_AST_CONDITIONAL,

  ZEND_AST_TRY,
  ZEND_AST_CATCH,
  ZEND_AST_PROP_GROUP,
  ZEND_AST_CONST_ELEM,
  ZEND_AST_CLASS_CONST_GROUP,

  /* 4 child nodes */
  ZEND_AST_FOR = 4 << ZEND_AST_NUM_CHILDREN_SHIFT,
  ZEND_AST_FOREACH,
  ZEND_AST_ENUM_CASE,
  ZEND_AST_PROP_ELEM,

  // Pseudo node for initializing enums
  ZEND_AST_CONST_ENUM_INIT,

  /* 5 child nodes */

  /* 6 child nodes */
  ZEND_AST_PARAM = 6 << ZEND_AST_NUM_CHILDREN_SHIFT,
};

typedef uint16_t zend_ast_kind;
typedef uint16_t zend_ast_attr;

struct _zend_ast {
  zend_ast_kind kind; /* Type of the node (ZEND_AST_* enum constant) */
  zend_ast_attr attr; /* Additional attribute, use depending on node type */
  uint32_t lineno;    /* Line number */
  zend_ast *child[1]; /* Array of children (using struct hack) */
};

/* Same as zend_ast, but with children count, which is updated dynamically */
typedef struct _zend_ast_list {
  zend_ast_kind kind;
  zend_ast_attr attr;
  uint32_t lineno;
  uint32_t children;
  zend_ast *child[1];
} zend_ast_list;

/* Lineno is stored in val.u2.lineno */
typedef struct _zend_ast_zval {
  zend_ast_kind kind;
  zend_ast_attr attr;
  zval val;
} zend_ast_zval;

typedef struct _zend_op_array zend_op_array;

typedef struct _zend_ast_op_array {
  zend_ast_kind kind;
  zend_ast_attr attr;
  uint32_t lineno;
  zend_op_array *op_array;
} zend_ast_op_array;

/* Separate structure for function and class declaration, as they need extra information. */
typedef struct _zend_ast_decl {
  zend_ast_kind kind;
  zend_ast_attr attr;
  uint32_t start_lineno;
  uint32_t end_lineno;
  uint32_t flags;
  zend_string *doc_comment;
  zend_string *name;
  zend_ast *child[5];
} zend_ast_decl;

// TODO: rename
typedef struct _zend_ast_fcc {
  zend_ast_kind kind; /* Type of the node (ZEND_AST_* enum constant) */
  zend_ast_attr attr; /* Additional attribute, use depending on node type */
  uint32_t lineno;    /* Line number */
  zend_string *filename;
  zend_string *name;
  zend_ast *args;
  ZEND_MAP_PTR_DEF(zend_function *, fptr);
} zend_ast_fcc;

typedef void (*zend_ast_process_t)(zend_ast *ast);
extern ZEND_API zend_ast_process_t zend_ast_process;

ZEND_API zend_ast * ZEND_FASTCALL zend_ast_create_zval_with_lineno(const zval *zv, uint32_t lineno);
ZEND_API zend_ast * ZEND_FASTCALL zend_ast_create_zval_ex(const zval *zv, zend_ast_attr attr);
ZEND_API zend_ast * ZEND_FASTCALL zend_ast_create_zval(const zval *zv);
ZEND_API zend_ast * ZEND_FASTCALL zend_ast_create_zval_from_str(zend_string *str);
ZEND_API zend_ast * ZEND_FASTCALL zend_ast_create_zval_from_long(zend_long lval);

ZEND_API zend_ast * ZEND_FASTCALL zend_ast_create_constant(zend_string *name, zend_ast_attr attr);
ZEND_API zend_ast * ZEND_FASTCALL zend_ast_create_class_const_or_name(zend_ast *class_name, zend_ast *name);

ZEND_API zend_ast * ZEND_FASTCALL zend_ast_create_op_array(zend_op_array *op_array);

#if ZEND_AST_SPEC
# define ZEND_AST_SPEC_CALL(name, ...) \
  ZEND_EXPAND_VA(ZEND_AST_SPEC_CALL_(name, __VA_ARGS__, _n, _5, _4, _3, _2, _1, _0)(__VA_ARGS__))
# define ZEND_AST_SPEC_CALL_(name, _, _6, _5, _4, _3, _2, _1, suffix, ...) \
  name ## suffix
# define ZEND_AST_SPEC_CALL_EX(name, ...) \
  ZEND_EXPAND_VA(ZEND_AST_SPEC_CALL_EX_(name, __VA_ARGS__, _n, _5, _4, _3, _2, _1, _0)(__VA_ARGS__))
# define ZEND_AST_SPEC_CALL_EX_(name, _, _7, _6, _5, _4, _3, _2, _1, suffix, ...) \
  name ## suffix

ZEND_API zend_ast * ZEND_FASTCALL zend_ast_create_0(zend_ast_kind kind);
ZEND_API zend_ast * ZEND_FASTCALL zend_ast_create_1(zend_ast_kind kind, zend_ast *child);
ZEND_API zend_ast * ZEND_FASTCALL zend_ast_create_2(zend_ast_kind kind, zend_ast *child1, zend_ast *child2);
ZEND_API zend_ast * ZEND_FASTCALL zend_ast_create_3(zend_ast_kind kind, zend_ast *child1, zend_ast *child2, zend_ast *child3);
ZEND_API zend_ast * ZEND_FASTCALL zend_ast_create_4(zend_ast_kind kind, zend_ast *child1, zend_ast *child2, zend_ast *child3, zend_ast *child4);
ZEND_API zend_ast * ZEND_FASTCALL zend_ast_create_5(zend_ast_kind kind, zend_ast *child1, zend_ast *child2, zend_ast *child3, zend_ast *child4, zend_ast *child5);

ZEND_API zend_ast * ZEND_FASTCALL zend_ast_create_va(zend_ast_kind kind, zend_ast_attr attr, va_list *va);
/* Need to use unsigned args to avoid va promotion UB. */
ZEND_API zend_ast * zend_ast_create_n(unsigned kind, ...);
ZEND_API zend_ast * zend_ast_create_ex_n(zend_ast_kind kind, unsigned attr, ...);

static zend_always_inline zend_ast * zend_ast_create_ex_0(zend_ast_kind kind, zend_ast_attr attr) {
  zend_ast *ast = zend_ast_create_0(kind);
  ast->attr = attr;
  return ast;
}
static zend_always_inline zend_ast * zend_ast_create_ex_1(zend_ast_kind kind, zend_ast_attr attr, zend_ast *child) {
  zend_ast *ast = zend_ast_create_1(kind, child);
  ast->attr = attr;
  return ast;
}
static zend_always_inline zend_ast * zend_ast_create_ex_2(zend_ast_kind kind, zend_ast_attr attr, zend_ast *child1, zend_ast *child2) {
  zend_ast *ast = zend_ast_create_2(kind, child1, child2);
  ast->attr = attr;
  return ast;
}
static zend_always_inline zend_ast * zend_ast_create_ex_3(zend_ast_kind kind, zend_ast_attr attr, zend_ast *child1, zend_ast *child2, zend_ast *child3) {
  zend_ast *ast = zend_ast_create_3(kind, child1, child2, child3);
  ast->attr = attr;
  return ast;
}
static zend_always_inline zend_ast * zend_ast_create_ex_4(zend_ast_kind kind, zend_ast_attr attr, zend_ast *child1, zend_ast *child2, zend_ast *child3, zend_ast *child4) {
  zend_ast *ast = zend_ast_create_4(kind, child1, child2, child3, child4);
  ast->attr = attr;
  return ast;
}
static zend_always_inline zend_ast * zend_ast_create_ex_5(zend_ast_kind kind, zend_ast_attr attr, zend_ast *child1, zend_ast *child2, zend_ast *child3, zend_ast *child4, zend_ast *child5) {
  zend_ast *ast = zend_ast_create_5(kind, child1, child2, child3, child4, child5);
  ast->attr = attr;
  return ast;
}

ZEND_API zend_ast * ZEND_FASTCALL zend_ast_create_list_0(zend_ast_kind kind);
ZEND_API zend_ast * ZEND_FASTCALL zend_ast_create_list_1(zend_ast_kind kind, zend_ast *child);
ZEND_API zend_ast * ZEND_FASTCALL zend_ast_create_list_2(zend_ast_kind kind, zend_ast *child1, zend_ast *child2);

ZEND_API zend_ast * ZEND_FASTCALL zend_ast_create_arg_list_0(zend_ast_kind kind);
ZEND_API zend_ast * ZEND_FASTCALL zend_ast_create_arg_list_1(zend_ast_kind kind, zend_ast *child);
ZEND_API zend_ast * ZEND_FASTCALL zend_ast_create_arg_list_2(zend_ast_kind kind, zend_ast *child1, zend_ast *child2);

# define zend_ast_create(...) \
  ZEND_AST_SPEC_CALL(zend_ast_create, __VA_ARGS__)
# define zend_ast_create_ex(...) \
  ZEND_AST_SPEC_CALL_EX(zend_ast_create_ex, __VA_ARGS__)
# define zend_ast_create_list(init_children, ...) \
  ZEND_AST_SPEC_CALL(zend_ast_create_list, __VA_ARGS__)
# define zend_ast_create_arg_list(init_children, ...) \
  ZEND_AST_SPEC_CALL(zend_ast_create_arg_list, __VA_ARGS__)

#else
ZEND_API zend_ast *zend_ast_create(zend_ast_kind kind, ...);
ZEND_API zend_ast *zend_ast_create_ex(zend_ast_kind kind, zend_ast_attr attr, ...);
ZEND_API zend_ast *zend_ast_create_list(uint32_t init_children, zend_ast_kind kind, ...);
ZEND_API zend_ast *zend_ast_create_arg_list(uint32_t init_children, zend_ast_kind kind, ...);
#endif

ZEND_ATTRIBUTE_NODISCARD ZEND_API zend_ast * ZEND_FASTCALL zend_ast_list_add(zend_ast *list, zend_ast *op);

/* Like zend_ast_list_add(), but wraps the list into a ZEND_AST_CALLABLE_CONVERT
 * if any arg is a ZEND_AST_PLACEHOLDER_ARG. list can be a zend_ast_list, or a
 * zend_ast_fcc. */
ZEND_API zend_ast * ZEND_FASTCALL zend_ast_arg_list_add(zend_ast *list, zend_ast *arg);

ZEND_API zend_ast *zend_ast_create_decl(
  zend_ast_kind kind, uint32_t flags, uint32_t start_lineno, zend_string *doc_comment,
  zend_string *name, zend_ast *child0, zend_ast *child1, zend_ast *child2, zend_ast *child3, zend_ast *child4
);

ZEND_API zend_ast * ZEND_FASTCALL zend_ast_create_fcc(zend_ast *args);

typedef struct {
  bool had_side_effects;
} zend_ast_evaluate_ctx;

ZEND_API zend_result ZEND_FASTCALL zend_ast_evaluate(zval *result, zend_ast *ast, zend_class_entry *scope);
ZEND_API zend_result ZEND_FASTCALL zend_ast_evaluate_ex(zval *result, zend_ast *ast, zend_class_entry *scope, bool *short_circuited_ptr, zend_ast_evaluate_ctx *ctx);
ZEND_API zend_string *zend_ast_export(const char *prefix, zend_ast *ast, const char *suffix);

/* Copies 'ast' to the heap, returns a refcounted AST reference */
ZEND_API zend_ast_ref * ZEND_FASTCALL zend_ast_copy(zend_ast *ast);
/* Duplicates 'ast' on the arena */
ZEND_API zend_ast * ZEND_FASTCALL zend_ast_dup(zend_ast *ast);
ZEND_API void ZEND_FASTCALL zend_ast_destroy(zend_ast *ast);
ZEND_API void ZEND_FASTCALL zend_ast_ref_destroy(zend_ast_ref *ast);

typedef void (*zend_ast_apply_func)(zend_ast **ast_ptr, void *context);
ZEND_API void zend_ast_apply(zend_ast *ast, zend_ast_apply_func fn, void *context);

static zend_always_inline size_t zend_ast_size(uint32_t children) {
  return offsetof(zend_ast, child) + (sizeof(zend_ast *) * children);
}

static zend_always_inline bool zend_ast_is_special(const zend_ast *ast) {
  return (ast->kind >> ZEND_AST_SPECIAL_SHIFT) & 1;
}

static zend_always_inline bool zend_ast_is_decl(const zend_ast *ast) {
  return zend_ast_is_special(ast) && ast->kind >= ZEND_AST_FUNC_DECL;
}

static zend_always_inline bool zend_ast_is_list(const zend_ast *ast) {
  return (ast->kind >> ZEND_AST_IS_LIST_SHIFT) & 1;
}
static zend_always_inline zend_ast_list *zend_ast_get_list(zend_ast *ast) {
  ZEND_ASSERT(zend_ast_is_list(ast));
  return (zend_ast_list *) ast;
}

static zend_always_inline zval *zend_ast_get_zval(zend_ast *ast) {
  ZEND_ASSERT(ast->kind == ZEND_AST_ZVAL);
  return &((zend_ast_zval *) ast)->val;
}
static zend_always_inline zend_string *zend_ast_get_str(zend_ast *ast) {
  const zval *zv = zend_ast_get_zval(ast);
  ZEND_ASSERT(Z_TYPE_P(zv) == IS_STRING);
  return Z_STR_P(zv);
}

static zend_always_inline zend_ast_op_array *zend_ast_get_op_array(zend_ast *ast) {
  ZEND_ASSERT(ast->kind == ZEND_AST_OP_ARRAY);
  return (zend_ast_op_array *) ast;
}

static zend_always_inline zend_string *zend_ast_get_constant_name(zend_ast *ast) {
  ZEND_ASSERT(ast->kind == ZEND_AST_CONSTANT);
  ZEND_ASSERT(Z_TYPE(((zend_ast_zval *) ast)->val) == IS_STRING);
  return Z_STR(((zend_ast_zval *) ast)->val);
}

static zend_always_inline uint32_t zend_ast_get_num_children(const zend_ast *ast) {
  ZEND_ASSERT(!zend_ast_is_list(ast));
  ZEND_ASSERT(!zend_ast_is_special(ast));

  return ast->kind >> ZEND_AST_NUM_CHILDREN_SHIFT;
}
static zend_always_inline uint32_t zend_ast_get_lineno(zend_ast *ast) {
  if (ast->kind == ZEND_AST_ZVAL) {
    const zval *zv = zend_ast_get_zval(ast);
    return Z_LINENO_P(zv);
  } else if (ast->kind == ZEND_AST_CONSTANT) {
    const zval *zv = &((const zend_ast_zval *) ast)->val;
    return Z_LINENO_P(zv);
  } else {
    return ast->lineno;
  }
}

static zend_always_inline zend_ast *zend_ast_create_binary_op(uint32_t opcode, zend_ast *op0, zend_ast *op1) {
  return zend_ast_create_ex(ZEND_AST_BINARY_OP, opcode, op0, op1);
}

zend_ast *zend_ast_create_concat_op(zend_ast *op0, zend_ast *op1);

static zend_always_inline zend_ast *zend_ast_create_assign_op(uint32_t opcode, zend_ast *op0, zend_ast *op1) {
  return zend_ast_create_ex(ZEND_AST_ASSIGN_OP, opcode, op0, op1);
}
static zend_always_inline zend_ast *zend_ast_create_cast(uint32_t type, zend_ast *op0) {
  return zend_ast_create_ex(ZEND_AST_CAST, type, op0);
}
static zend_always_inline zend_ast *zend_ast_list_rtrim(zend_ast *ast) {
  zend_ast_list *list = zend_ast_get_list(ast);
  if (list->children && list->child[list->children - 1] == NULL) {
    list->children--;
  }
  return ast;
}

zend_ast * ZEND_FASTCALL zend_ast_with_attributes(zend_ast *ast, zend_ast *attr);

zend_ast * ZEND_FASTCALL zend_ast_call_get_args(zend_ast *ast);

/* Recognize parent::$prop::get() pattern. */
bool zend_ast_is_parent_hook_call(const zend_ast *ast);

#endif

Coverage Report

Created: 2026-10-28 06:20