Skip to content

refactor(semantic): simplify getting AstNodeIds for CFG #5674

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
overlookmotel wants to merge 1 commit into from
Closed

refactor(semantic): simplify getting AstNodeIds for CFG #5674

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
91 changes: 41 additions & 50 deletions crates/oxc_semantic/src/builder.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,8 +106,6 @@ pub struct SemanticBuilder<'a> {
pub(crate) cfg: Option<ControlFlowGraphBuilder<'a>>,

pub(crate) class_table_builder: ClassTableBuilder,

ast_node_records: Vec<NodeId>,
}

/// Data returned by [`SemanticBuilder::build`].
Expand Down Expand Up @@ -152,7 +150,6 @@ impl<'a> SemanticBuilder<'a> {
check_syntax_error: false,
cfg: None,
class_table_builder: ClassTableBuilder::new(),
ast_node_records: Vec::new(),
}
}

Expand Down Expand Up @@ -346,7 +343,6 @@ impl<'a> SemanticBuilder<'a> {
control_flow!(self, |cfg| cfg.current_node_ix),
flags,
);
self.record_ast_node();
}

fn pop_ast_node(&mut self) {
Expand All @@ -356,34 +352,9 @@ impl<'a> SemanticBuilder<'a> {
}

#[inline]
fn record_ast_nodes(&mut self) {
if self.cfg.is_some() {
self.ast_node_records.push(NodeId::DUMMY);
}
}

#[inline]
#[allow(clippy::unnecessary_wraps)]
fn retrieve_recorded_ast_node(&mut self) -> Option<NodeId> {
if self.cfg.is_some() {
Some(self.ast_node_records.pop().expect("there is no ast node record to stop."))
} else {
None
}
}

#[inline]
fn record_ast_node(&mut self) {
// The `self.cfg.is_some()` check here could be removed, since `ast_node_records` is empty
// if CFG is disabled. But benchmarks showed removing the extra check is a perf regression.
// <https://github.com/oxc-project/oxc/pull/4273>
if self.cfg.is_some() {
if let Some(record) = self.ast_node_records.last_mut() {
if *record == NodeId::DUMMY {
*record = self.current_node_id;
}
}
}
#[allow(clippy::cast_possible_truncation)]
fn get_next_node_index(&mut self) -> u32 {
self.nodes.len() as u32
}

#[inline]
Expand Down Expand Up @@ -790,12 +761,14 @@ impl<'a> Visit<'a> for SemanticBuilder<'a> {
});
/* cfg */

self.record_ast_nodes();
let test_node_index = self.get_next_node_index();
self.visit_expression(&stmt.test);
let test_node_id = self.retrieve_recorded_ast_node();

/* cfg */
control_flow!(self, |cfg| {
// SAFETY: `test_node_index` must be a valid `NodeId`.
// If it was out of bounds, would have panicked already when pushing to `AstNodes`.
let test_node_id = Some(unsafe { NodeId::new_unchecked(test_node_index) });
cfg.append_condition_to(start_of_condition_graph_ix, test_node_id);
let end_of_condition_graph_ix = cfg.current_node_ix;

Expand Down Expand Up @@ -918,13 +891,15 @@ impl<'a> Visit<'a> for SemanticBuilder<'a> {
});
/* cfg */

self.record_ast_nodes();
let test_node_index = self.get_next_node_index();
self.visit_expression(&expr.test);
let test_node_id = self.retrieve_recorded_ast_node();

/* cfg */
let (after_condition_graph_ix, before_consequent_expr_graph_ix) =
control_flow!(self, |cfg| {
// SAFETY: `test_node_index` must be a valid `NodeId`.
// If it was out of bounds, would have panicked already when pushing to `AstNodes`.
let test_node_id = Some(unsafe { NodeId::new_unchecked(test_node_index) });
cfg.append_condition_to(start_of_condition_graph_ix, test_node_id);
let after_condition_graph_ix = cfg.current_node_ix;
// conditional expression basic block
Expand Down Expand Up @@ -989,12 +964,16 @@ impl<'a> Visit<'a> for SemanticBuilder<'a> {
/* cfg */

if let Some(test) = &stmt.test {
self.record_ast_nodes();
let test_node_index = self.get_next_node_index();
self.visit_expression(test);
let test_node_id = self.retrieve_recorded_ast_node();

/* cfg */
control_flow!(self, |cfg| cfg.append_condition_to(test_graph_ix, test_node_id));
control_flow!(self, |cfg| {
// SAFETY: `test_node_index` must be a valid `NodeId`.
// If it was out of bounds, would have panicked already when pushing to `AstNodes`.
let test_node_id = Some(unsafe { NodeId::new_unchecked(test_node_index) });
cfg.append_condition_to(test_graph_ix, test_node_id);
});
/* cfg */
}

Expand Down Expand Up @@ -1050,13 +1029,15 @@ impl<'a> Visit<'a> for SemanticBuilder<'a> {
control_flow!(self, |cfg| (cfg.current_node_ix, cfg.new_basic_block_normal(),));
/* cfg */

self.record_ast_nodes();
let right_node_index = self.get_next_node_index();
self.visit_expression(&stmt.right);
let right_node_id = self.retrieve_recorded_ast_node();

/* cfg */
let (end_of_prepare_cond_graph_ix, iteration_graph_ix, body_graph_ix) =
control_flow!(self, |cfg| {
// SAFETY: `right_node_index` must be a valid `NodeId`.
// If it was out of bounds, would have panicked already when pushing to `AstNodes`.
let right_node_id = Some(unsafe { NodeId::new_unchecked(right_node_index) });
let end_of_prepare_cond_graph_ix = cfg.current_node_ix;
let iteration_graph_ix = cfg.new_basic_block_normal();
cfg.append_iteration(right_node_id, IterationInstructionKind::In);
Expand Down Expand Up @@ -1109,13 +1090,15 @@ impl<'a> Visit<'a> for SemanticBuilder<'a> {
control_flow!(self, |cfg| (cfg.current_node_ix, cfg.new_basic_block_normal()));
/* cfg */

self.record_ast_nodes();
let right_node_index = self.get_next_node_index();
self.visit_expression(&stmt.right);
let right_node_id = self.retrieve_recorded_ast_node();

/* cfg */
let (end_of_prepare_cond_graph_ix, iteration_graph_ix, body_graph_ix) =
control_flow!(self, |cfg| {
// SAFETY: `right_node_index` must be a valid `NodeId`.
// If it was out of bounds, would have panicked already when pushing to `AstNodes`.
let right_node_id = Some(unsafe { NodeId::new_unchecked(right_node_index) });
let end_of_prepare_cond_graph_ix = cfg.current_node_ix;
let iteration_graph_ix = cfg.new_basic_block_normal();
cfg.append_iteration(right_node_id, IterationInstructionKind::Of);
Expand Down Expand Up @@ -1164,12 +1147,14 @@ impl<'a> Visit<'a> for SemanticBuilder<'a> {
control_flow!(self, |cfg| (cfg.current_node_ix, cfg.new_basic_block_normal(),));
/* cfg */

self.record_ast_nodes();
let test_node_index = self.get_next_node_index();
self.visit_expression(&stmt.test);
let test_node_id = self.retrieve_recorded_ast_node();

/* cfg */
let (after_test_graph_ix, before_consequent_stmt_graph_ix) = control_flow!(self, |cfg| {
// SAFETY: `test_node_index` must be a valid `NodeId`.
// If it was out of bounds, would have panicked already when pushing to `AstNodes`.
let test_node_id = Some(unsafe { NodeId::new_unchecked(test_node_index) });
cfg.append_condition_to(start_of_condition_graph_ix, test_node_id);
(cfg.current_node_ix, cfg.new_basic_block_normal())
});
Expand Down Expand Up @@ -1356,10 +1341,14 @@ impl<'a> Visit<'a> for SemanticBuilder<'a> {
self.enter_node(kind);

if let Some(expr) = &case.test {
self.record_ast_nodes();
let test_node_index = self.get_next_node_index();
self.visit_expression(expr);
let test_node_id = self.retrieve_recorded_ast_node();
control_flow!(self, |cfg| cfg.append_condition_to(cfg.current_node_ix, test_node_id));
control_flow!(self, |cfg| {
// SAFETY: `test_node_index` must be a valid `NodeId`.
// If it was out of bounds, would have panicked already when pushing to `AstNodes`.
let test_node_id = Some(unsafe { NodeId::new_unchecked(test_node_index) });
cfg.append_condition_to(cfg.current_node_ix, test_node_id);
});
}

/* cfg */
Expand Down Expand Up @@ -1534,12 +1523,14 @@ impl<'a> Visit<'a> for SemanticBuilder<'a> {
control_flow!(self, |cfg| (cfg.current_node_ix, cfg.new_basic_block_normal()));
/* cfg */

self.record_ast_nodes();
let test_node_index = self.get_next_node_index();
self.visit_expression(&stmt.test);
let test_node_id = self.retrieve_recorded_ast_node();

/* cfg - body basic block */
let body_graph_ix = control_flow!(self, |cfg| {
// SAFETY: `test_node_index` must be a valid `NodeId`.
// If it was out of bounds, would have panicked already when pushing to `AstNodes`.
let test_node_id = Some(unsafe { NodeId::new_unchecked(test_node_index) });
cfg.append_condition_to(condition_graph_ix, test_node_id);
let body_graph_ix = cfg.new_basic_block_normal();

Expand Down