Invent nodetag_only attribute for Nodes.

tglsfdc · tglsfdc · commit ca187d7455f1 · 2022-07-12T10:46:58.000-04:00
This allows explaining gen_node_support.pl's handling of execnodes.h and some other input files as being a shortcut for explicit marking of all their node declarations as pg_node_attr(nodetag_only). I foresee that someday we might need to be more fine-grained about that, and this change provides the infrastructure needed to do so. For now, it just allows removal of the script's klugy special case for CallContext and InlineCodeBlock. Discussion: https://postgr.es/m/75063.1657410615@sss.pgh.pa.us
diff --git a/src/backend/nodes/gen_node_support.pl b/src/backend/nodes/gen_node_support.pl
@@ -50,6 +50,8 @@ sub elem
 my @no_read;
 # node types we don't want read/write support for
 my @no_read_write;
+# node types we don't want any support functions for, just node tags
+my @nodetag_only;
 
 # types that are copied by straight assignment
 my @scalar_types = qw(
@@ -95,7 +97,10 @@ sub elem
 # currently not required.
 push @scalar_types, qw(QualCost);
 
-# Nodes from these input files don't need support functions, just node tags.
+# Nodes from these input files are automatically treated as nodetag_only.
+# In the future we might add explicit pg_node_attr labeling to some of these
+# files and remove them from this list, but for now this is the path of least
+# resistance.
 my @nodetag_only_files = qw(
   nodes/execnodes.h
   access/amapi.h
@@ -113,10 +118,8 @@ sub elem
 
 # XXX various things we are not publishing right now to stay level
 # with the manual system
-push @no_copy,  qw(CallContext InlineCodeBlock);
-push @no_equal, qw(CallContext InlineCodeBlock);
 push @no_read_write,
-  qw(AccessPriv AlterTableCmd CallContext CreateOpClassItem FunctionParameter InferClause InlineCodeBlock ObjectWithArgs OnConflictClause PartitionCmd RoleSpec VacuumRelation);
+  qw(AccessPriv AlterTableCmd CreateOpClassItem FunctionParameter InferClause ObjectWithArgs OnConflictClause PartitionCmd RoleSpec VacuumRelation);
 push @no_read, qw(A_ArrayExpr A_Indices A_Indirection AlterStatsStmt
   CollateClause ColumnDef ColumnRef CreateForeignTableStmt CreateStatsStmt
   CreateStmt FuncCall ImportForeignSchemaStmt IndexElem IndexStmt
@@ -254,6 +257,10 @@ sub elem
 						{
 							push @no_read, $in_struct;
 						}
+						elsif ($attr eq 'nodetag_only')
+						{
+							push @nodetag_only, $in_struct;
+						}
 						elsif ($attr eq 'special_read_write')
 						{
 							# This attribute is called
@@ -314,13 +321,9 @@ sub elem
 					$node_type_info{$in_struct}->{field_types} = \%ft;
 					$node_type_info{$in_struct}->{field_attrs} = \%fa;
 
-					# Exclude nodes in nodetag_only_files from support.
-					if (elem $infile, @nodetag_only_files)
-					{
-						push @no_copy,       $in_struct;
-						push @no_equal,      $in_struct;
-						push @no_read_write, $in_struct;
-					}
+					# Propagate nodetag_only marking from files to nodes
+					push @nodetag_only, $in_struct
+					  if (elem $infile, @nodetag_only_files);
 
 					# Propagate some node attributes from supertypes
 					if ($supertype)
@@ -515,6 +518,7 @@ sub elem
 foreach my $n (@node_types)
 {
 	next if elem $n, @abstract_types;
+	next if elem $n, @nodetag_only;
 	my $struct_no_copy  = (elem $n, @no_copy);
 	my $struct_no_equal = (elem $n, @no_equal);
 	next if $struct_no_copy && $struct_no_equal;
@@ -706,6 +710,7 @@ sub elem
 foreach my $n (@node_types)
 {
 	next if elem $n, @abstract_types;
+	next if elem $n, @nodetag_only;
 	next if elem $n, @no_read_write;
 
 	# XXX For now, skip all "Stmt"s except that ones that were there before.
diff --git a/src/include/nodes/nodes.h b/src/include/nodes/nodes.h
@@ -61,12 +61,17 @@ typedef enum NodeTag
  *
  * - no_read: Does not support nodeRead() at all.
  *
+ * - nodetag_only: Does not support copyObject(), equal(), outNode(),
+ *   or nodeRead().
+ *
  * - special_read_write: Has special treatment in outNode() and nodeRead().
  *
  * Node types can be supertypes of other types whether or not they are marked
  * abstract: if a node struct appears as the first field of another struct
  * type, then it is the supertype of that type.  The no_copy, no_equal, and
  * no_read node attributes are automatically inherited from the supertype.
+ * (Notice that nodetag_only does not inherit, so it's not quite equivalent
+ * to a combination of other attributes.)
  *
  * Valid node field attributes:
  *
diff --git a/src/include/nodes/parsenodes.h b/src/include/nodes/parsenodes.h
@@ -3382,6 +3382,8 @@ typedef struct DoStmt
 
 typedef struct InlineCodeBlock
 {
+	pg_node_attr(nodetag_only)	/* this is not a member of parse trees */
+
 	NodeTag		type;
 	char	   *source_text;	/* source text of anonymous code block */
 	Oid			langOid;		/* OID of selected language */
@@ -3408,6 +3410,8 @@ typedef struct CallStmt
 
 typedef struct CallContext
 {
+	pg_node_attr(nodetag_only)	/* this is not a member of parse trees */
+
 	NodeTag		type;
 	bool		atomic;
 } CallContext;

Original file line number	Diff line number	Diff line change
`@@ -61,12 +61,17 @@ typedef enum NodeTag`
`61`	`61`	`*`
`62`	`62`	`* - no_read: Does not support nodeRead() at all.`
`63`	`63`	`*`
	`64`	`+ * - nodetag_only: Does not support copyObject(), equal(), outNode(),`
	`65`	`+ * or nodeRead().`
	`66`	`+ *`
`64`	`67`	`* - special_read_write: Has special treatment in outNode() and nodeRead().`
`65`	`68`	`*`
`66`	`69`	`* Node types can be supertypes of other types whether or not they are marked`
`67`	`70`	`* abstract: if a node struct appears as the first field of another struct`
`68`	`71`	`* type, then it is the supertype of that type. The no_copy, no_equal, and`
`69`	`72`	`* no_read node attributes are automatically inherited from the supertype.`
	`73`	`+ * (Notice that nodetag_only does not inherit, so it's not quite equivalent`
	`74`	`+ * to a combination of other attributes.)`
`70`	`75`	`*`
`71`	`76`	`* Valid node field attributes:`
`72`	`77`	`*`