fix: Refines memory computation of AbstractTraverseDevice and its subclasses

Author: Young-Leo

iotdb-core/datanode/src/main/java/org/apache/iotdb/db/queryengine/plan/relational/sql/ast/AbstractQueryDeviceWithCache.java

@@ -31,6 +31,7 @@
 import org.apache.iotdb.db.schemaengine.table.DataNodeTableCache;
 
 import org.apache.tsfile.read.common.block.TsBlock;
+import org.apache.tsfile.utils.RamUsageEstimator;
 
 import java.util.ArrayList;
 import java.util.HashMap;
@@ -42,6 +43,9 @@
 
 public abstract class AbstractQueryDeviceWithCache extends AbstractTraverseDevice {
 
+  private static final long INSTANCE_SIZE =
+      RamUsageEstimator.shallowSizeOfInstance(AbstractQueryDeviceWithCache.class);
+
   // For query devices fully in cache
   protected List<ShowDevicesResult> results = new ArrayList<>();
 
@@ -111,4 +115,21 @@ public static List<ColumnHeader> getDeviceColumnHeaderList(
   public abstract DatasetHeader getDataSetHeader();
 
   public abstract TsBlock getTsBlock(final Analysis analysis);
+
+  @Override
+  public long ramBytesUsed() {
+    return INSTANCE_SIZE + ramBytesUsedForCommonFields();
+  }
+
+  @Override
+  protected long ramBytesUsedForCommonFields() {
+    long size = super.ramBytesUsedForCommonFields();
+    if (results != null) {
+      size += RamUsageEstimator.shallowSizeOf(results);
+      for (ShowDevicesResult result : results) {
+        size += AstMemoryEstimationHelper.getEstimatedSizeOfAccountableObject(result);
+      }
+    }
+    return size;
+  }
 }

iotdb-core/datanode/src/main/java/org/apache/iotdb/db/queryengine/plan/relational/sql/ast/AbstractTraverseDevice.java

@@ -47,6 +47,9 @@
 // Show, Count, Update, Delete Devices
 public abstract class AbstractTraverseDevice extends Statement {
 
+  private static final long INSTANCE_SIZE =
+      RamUsageEstimator.shallowSizeOfInstance(AbstractTraverseDevice.class);
+
   protected String database;
 
   protected String tableName;
@@ -247,6 +250,11 @@ protected String toStringContent() {
         + '}';
   }
 
+  @Override
+  public long ramBytesUsed() {
+    return INSTANCE_SIZE + ramBytesUsedForCommonFields();
+  }
+
   protected long ramBytesUsedForCommonFields() {
     long size = 0;
     size += AstMemoryEstimationHelper.getEstimatedSizeOfNodeLocation(getLocationInternal());
@@ -255,6 +263,30 @@ protected long ramBytesUsedForCommonFields() {
     size += AstMemoryEstimationHelper.getEstimatedSizeOfAccountableObject(tagFuzzyPredicate);
     size += RamUsageEstimator.sizeOf(database);
     size += RamUsageEstimator.sizeOf(tableName);
+    if (tagDeterminedFilterList != null) {
+      size += RamUsageEstimator.shallowSizeOf(tagDeterminedFilterList);
+      for (List<SchemaFilter> filters : tagDeterminedFilterList) {
+        if (filters != null) {
+          size += RamUsageEstimator.shallowSizeOf(filters);
+          for (SchemaFilter filter : filters) {
+            size += AstMemoryEstimationHelper.getEstimatedSizeOfAccountableObject(filter);
+          }
+        }
+      }
+    }
+    if (columnHeaderList != null) {
+      size += RamUsageEstimator.shallowSizeOf(columnHeaderList);
+      for (ColumnHeader header : columnHeaderList) {
+        size += AstMemoryEstimationHelper.getEstimatedSizeOfAccountableObject(header);
+      }
+    }
+    size += AstMemoryEstimationHelper.getEstimatedSizeOfStringList(attributeColumns);
+    if (partitionKeyList != null) {
+      size += RamUsageEstimator.shallowSizeOf(partitionKeyList);
+      for (IDeviceID deviceID : partitionKeyList) {
+        size += AstMemoryEstimationHelper.getEstimatedSizeOfAccountableObject(deviceID);
+      }
+    }
     return size;
   }
 }

iotdb-core/datanode/src/main/java/org/apache/iotdb/db/queryengine/plan/relational/sql/ast/DeleteDevice.java

@@ -256,15 +256,7 @@ public String toString() {
   @Override
   public long ramBytesUsed() {
     long size = INSTANCE_SIZE;
-    size += AstMemoryEstimationHelper.getEstimatedSizeOfNodeLocation(getLocationInternal());
-    size += AstMemoryEstimationHelper.getEstimatedSizeOfAccountableObject(table);
-    size += AstMemoryEstimationHelper.getEstimatedSizeOfAccountableObject(where);
-    size += RamUsageEstimator.sizeOf(database);
-    size += RamUsageEstimator.sizeOf(tableName);
-    size += RamUsageEstimator.shallowSizeOf(tagDeterminedFilterList);
-    size += AstMemoryEstimationHelper.getEstimatedSizeOfAccountableObject(tagFuzzyPredicate);
-    size += RamUsageEstimator.shallowSizeOf(columnHeaderList);
-    size += AstMemoryEstimationHelper.getEstimatedSizeOfStringList(getAttributeColumns());
+    size += ramBytesUsedForCommonFields();
     if (modEntries != null) {
       size += RamUsageEstimator.shallowSizeOf(modEntries);
       for (TableDeletionEntry entry : modEntries) {

iotdb-core/datanode/src/main/java/org/apache/iotdb/db/queryengine/plan/relational/sql/ast/ShowDevice.java

@@ -25,7 +25,6 @@
 import org.apache.iotdb.db.queryengine.common.header.DatasetHeader;
 import org.apache.iotdb.db.queryengine.execution.operator.schema.source.TableDeviceQuerySource;
 import org.apache.iotdb.db.queryengine.plan.relational.analyzer.Analysis;
-import org.apache.iotdb.db.schemaengine.schemaregion.read.resp.info.impl.ShowDevicesResult;
 import org.apache.iotdb.db.schemaengine.table.DataNodeTableCache;
 
 import org.apache.tsfile.enums.TSDataType;
@@ -147,19 +146,9 @@ public String toString() {
 
   @Override
   public long ramBytesUsed() {
-    long size = INSTANCE_SIZE;
-    size += AstMemoryEstimationHelper.getEstimatedSizeOfNodeLocation(getLocationInternal());
-    size += AstMemoryEstimationHelper.getEstimatedSizeOfAccountableObject(offset);
-    size += AstMemoryEstimationHelper.getEstimatedSizeOfAccountableObject(limit);
-    // AbstractQueryDeviceWithCache fields
-    if (results != null) {
-      size += RamUsageEstimator.shallowSizeOf(results);
-      for (ShowDevicesResult result : results) {
-        if (result != null) {
-          size += result.ramBytesUsed();
-        }
-      }
-    }
-    return size;
+    return INSTANCE_SIZE
+        + ramBytesUsedForCommonFields()
+        + AstMemoryEstimationHelper.getEstimatedSizeOfAccountableObject(offset)
+        + AstMemoryEstimationHelper.getEstimatedSizeOfAccountableObject(limit);
   }
 }

iotdb-core/node-commons/src/main/java/org/apache/iotdb/commons/schema/column/ColumnHeader.java

@@ -20,14 +20,18 @@
 package org.apache.iotdb.commons.schema.column;
 
 import org.apache.tsfile.enums.TSDataType;
+import org.apache.tsfile.utils.Accountable;
+import org.apache.tsfile.utils.RamUsageEstimator;
 import org.apache.tsfile.utils.ReadWriteIOUtils;
 
 import java.io.DataOutputStream;
 import java.io.IOException;
 import java.nio.ByteBuffer;
 import java.util.Objects;
 
-public class ColumnHeader {
+public class ColumnHeader implements Accountable {
+  private static final long INSTANCE_SIZE =
+      RamUsageEstimator.shallowSizeOfInstance(ColumnHeader.class);
 
   private final String columnName;
   private final TSDataType dataType;
@@ -119,4 +123,12 @@ public boolean equals(Object o) {
   public int hashCode() {
     return Objects.hash(columnName, dataType, alias);
   }
+
+  @Override
+  public long ramBytesUsed() {
+    long size = INSTANCE_SIZE;
+    size += RamUsageEstimator.sizeOf(columnName);
+    size += RamUsageEstimator.sizeOf(alias);
+    return size;
+  }
 }

iotdb-core/node-commons/src/main/java/org/apache/iotdb/commons/schema/filter/SchemaFilter.java

@@ -33,6 +33,7 @@
 import org.apache.iotdb.commons.schema.filter.impl.values.LikeFilter;
 import org.apache.iotdb.commons.schema.filter.impl.values.PreciseFilter;
 
+import org.apache.tsfile.utils.Accountable;
 import org.apache.tsfile.utils.ReadWriteIOUtils;
 
 import java.io.DataOutputStream;
@@ -41,7 +42,7 @@
 import java.util.ArrayList;
 import java.util.List;
 
-public abstract class SchemaFilter {
+public abstract class SchemaFilter implements Accountable {
 
   public static void serialize(final SchemaFilter schemaFilter, final ByteBuffer byteBuffer) {
     if (schemaFilter == null) {

iotdb-core/node-commons/src/main/java/org/apache/iotdb/commons/schema/filter/impl/DataTypeFilter.java

@@ -24,6 +24,7 @@
 import org.apache.iotdb.commons.schema.filter.SchemaFilterVisitor;
 
 import org.apache.tsfile.enums.TSDataType;
+import org.apache.tsfile.utils.RamUsageEstimator;
 
 import java.io.DataOutputStream;
 import java.io.IOException;
@@ -32,6 +33,9 @@
 
 public class DataTypeFilter extends SchemaFilter {
 
+  private static final long INSTANCE_SIZE =
+      RamUsageEstimator.shallowSizeOfInstance(DataTypeFilter.class);
+
   private final TSDataType dataType;
 
   public DataTypeFilter(final TSDataType dataType) {
@@ -82,4 +86,9 @@ public boolean equals(final Object o) {
   public int hashCode() {
     return Objects.hash(dataType);
   }
+
+  @Override
+  public long ramBytesUsed() {
+    return INSTANCE_SIZE;
+  }
 }

iotdb-core/node-commons/src/main/java/org/apache/iotdb/commons/schema/filter/impl/PathContainsFilter.java

@@ -23,6 +23,7 @@
 import org.apache.iotdb.commons.schema.filter.SchemaFilterType;
 import org.apache.iotdb.commons.schema.filter.SchemaFilterVisitor;
 
+import org.apache.tsfile.utils.RamUsageEstimator;
 import org.apache.tsfile.utils.ReadWriteIOUtils;
 
 import java.io.DataOutputStream;
@@ -31,6 +32,10 @@
 import java.util.Objects;
 
 public class PathContainsFilter extends SchemaFilter {
+
+  private static final long INSTANCE_SIZE =
+      RamUsageEstimator.shallowSizeOfInstance(PathContainsFilter.class);
+
   private final String containString;
 
   public PathContainsFilter(final String containString) {
@@ -81,4 +86,9 @@ public boolean equals(final Object o) {
   public int hashCode() {
     return Objects.hash(containString);
   }
+
+  @Override
+  public long ramBytesUsed() {
+    return INSTANCE_SIZE + RamUsageEstimator.sizeOf(containString);
+  }
 }

iotdb-core/node-commons/src/main/java/org/apache/iotdb/commons/schema/filter/impl/TagFilter.java

@@ -23,6 +23,7 @@
 import org.apache.iotdb.commons.schema.filter.SchemaFilterType;
 import org.apache.iotdb.commons.schema.filter.SchemaFilterVisitor;
 
+import org.apache.tsfile.utils.RamUsageEstimator;
 import org.apache.tsfile.utils.ReadWriteIOUtils;
 
 import java.io.DataOutputStream;
@@ -32,6 +33,9 @@
 
 public class TagFilter extends SchemaFilter {
 
+  private static final long INSTANCE_SIZE =
+      RamUsageEstimator.shallowSizeOfInstance(TagFilter.class);
+
   private final String key;
   private final String value;
   private final boolean isContains;
@@ -102,4 +106,9 @@ public boolean equals(final Object o) {
   public int hashCode() {
     return Objects.hash(key, value, isContains);
   }
+
+  @Override
+  public long ramBytesUsed() {
+    return INSTANCE_SIZE + RamUsageEstimator.sizeOf(key) + RamUsageEstimator.sizeOf(value);
+  }
 }

iotdb-core/node-commons/src/main/java/org/apache/iotdb/commons/schema/filter/impl/TemplateFilter.java

@@ -22,6 +22,7 @@
 import org.apache.iotdb.commons.schema.filter.SchemaFilterType;
 import org.apache.iotdb.commons.schema.filter.SchemaFilterVisitor;
 
+import org.apache.tsfile.utils.RamUsageEstimator;
 import org.apache.tsfile.utils.ReadWriteIOUtils;
 
 import java.io.DataOutputStream;
@@ -30,6 +31,10 @@
 import java.util.Objects;
 
 public class TemplateFilter extends SchemaFilter {
+
+  private static final long INSTANCE_SIZE =
+      RamUsageEstimator.shallowSizeOfInstance(TemplateFilter.class);
+
   private final String templateName;
   private final boolean isEqual;
 
@@ -89,4 +94,9 @@ public boolean equals(final Object o) {
   public int hashCode() {
     return Objects.hash(templateName, isEqual);
   }
+
+  @Override
+  public long ramBytesUsed() {
+    return INSTANCE_SIZE + RamUsageEstimator.sizeOf(templateName);
+  }
 }