Follow Dimitry Sibiryakov's suggestion to unify get*Counters methods.

dyemanov · dyemanov · commit cfb27d144cc3 · 2025-11-29T11:18:33.000+03:00
diff --git a/doc/Using_OO_API.md b/doc/Using_OO_API.md
@@ -2124,8 +2124,14 @@ The returned pointer may be `nullptr` if the corresponding trace object is not i
 
 - ISC_UINT64 getElapsedTime() - returns the elapsed time, in milliseconds
 - ISC_UINT64 getFetchedRecords() - returns number of records fetched during execution
-- IPerformanceCounters* getPageCounters() - returns per-pagespace performance counters
-- IPerformanceCounters* getTableCounters() - returns per-table performance counters
+- IPerformanceCounters* getCounters(unsigned group) - returns the requested performance counters group
+
+The following groups of performance counters are currently supported:
+
+- COUNTER_GROUP_PAGES - per-pagespace counters
+- COUNTER_GROUP_TABLES - per-table counters
+
+If `getCounters()` is called with a counter group not supported by the implementation, `nullptr` is returned.
 
 <a name="PerformanceCounters"></a> PerformanceCounters interface:
 
diff --git a/src/include/firebird/FirebirdInterface.idl b/src/include/firebird/FirebirdInterface.idl
@@ -1932,10 +1932,12 @@ interface PerformanceCounters : Versioned
 
 interface PerformanceStats : Versioned
 {
+	const uint COUNTER_GROUP_PAGES = 0;
+	const uint COUNTER_GROUP_TABLES = 1;
+
 	uint64 getElapsedTime();	// in milliseconds
 	uint64 getFetchedRecords();
 
-	PerformanceCounters getPageCounters();
-	PerformanceCounters getTableCounters();
+	PerformanceCounters getCounters(uint group);
 }
 
diff --git a/src/include/firebird/IdlFbInterfaces.h b/src/include/firebird/IdlFbInterfaces.h
@@ -7693,8 +7693,7 @@ namespace Firebird
 		{
 			ISC_UINT64 (CLOOP_CARG *getElapsedTime)(IPerformanceStats* self) CLOOP_NOEXCEPT;
 			ISC_UINT64 (CLOOP_CARG *getFetchedRecords)(IPerformanceStats* self) CLOOP_NOEXCEPT;
-			IPerformanceCounters* (CLOOP_CARG *getPageCounters)(IPerformanceStats* self) CLOOP_NOEXCEPT;
-			IPerformanceCounters* (CLOOP_CARG *getTableCounters)(IPerformanceStats* self) CLOOP_NOEXCEPT;
+			IPerformanceCounters* (CLOOP_CARG *getCounters)(IPerformanceStats* self, unsigned group) CLOOP_NOEXCEPT;
 		};
 
 	protected:
@@ -7710,6 +7709,9 @@ namespace Firebird
 	public:
 		static CLOOP_CONSTEXPR unsigned VERSION = FIREBIRD_IPERFORMANCE_STATS_VERSION;
 
+		static CLOOP_CONSTEXPR unsigned COUNTER_GROUP_PAGES = 0;
+		static CLOOP_CONSTEXPR unsigned COUNTER_GROUP_TABLES = 1;
+
 		ISC_UINT64 getElapsedTime()
 		{
 			ISC_UINT64 ret = static_cast<VTable*>(this->cloopVTable)->getElapsedTime(this);
@@ -7722,15 +7724,9 @@ namespace Firebird
 			return ret;
 		}
 
-		IPerformanceCounters* getPageCounters()
-		{
-			IPerformanceCounters* ret = static_cast<VTable*>(this->cloopVTable)->getPageCounters(this);
-			return ret;
-		}
-
-		IPerformanceCounters* getTableCounters()
+		IPerformanceCounters* getCounters(unsigned group)
 		{
-			IPerformanceCounters* ret = static_cast<VTable*>(this->cloopVTable)->getTableCounters(this);
+			IPerformanceCounters* ret = static_cast<VTable*>(this->cloopVTable)->getCounters(this, group);
 			return ret;
 		}
 	};
@@ -22139,8 +22135,7 @@ namespace Firebird
 					this->version = Base::VERSION;
 					this->getElapsedTime = &Name::cloopgetElapsedTimeDispatcher;
 					this->getFetchedRecords = &Name::cloopgetFetchedRecordsDispatcher;
-					this->getPageCounters = &Name::cloopgetPageCountersDispatcher;
-					this->getTableCounters = &Name::cloopgetTableCountersDispatcher;
+					this->getCounters = &Name::cloopgetCountersDispatcher;
 				}
 			} vTable;
 
@@ -22173,24 +22168,11 @@ namespace Firebird
 			}
 		}
 
-		static IPerformanceCounters* CLOOP_CARG cloopgetPageCountersDispatcher(IPerformanceStats* self) CLOOP_NOEXCEPT
-		{
-			try
-			{
-				return static_cast<Name*>(self)->Name::getPageCounters();
-			}
-			catch (...)
-			{
-				StatusType::catchException(0);
-				return static_cast<IPerformanceCounters*>(0);
-			}
-		}
-
-		static IPerformanceCounters* CLOOP_CARG cloopgetTableCountersDispatcher(IPerformanceStats* self) CLOOP_NOEXCEPT
+		static IPerformanceCounters* CLOOP_CARG cloopgetCountersDispatcher(IPerformanceStats* self, unsigned group) CLOOP_NOEXCEPT
 		{
 			try
 			{
-				return static_cast<Name*>(self)->Name::getTableCounters();
+				return static_cast<Name*>(self)->Name::getCounters(group);
 			}
 			catch (...)
 			{
@@ -22215,8 +22197,7 @@ namespace Firebird
 
 		virtual ISC_UINT64 getElapsedTime() = 0;
 		virtual ISC_UINT64 getFetchedRecords() = 0;
-		virtual IPerformanceCounters* getPageCounters() = 0;
-		virtual IPerformanceCounters* getTableCounters() = 0;
+		virtual IPerformanceCounters* getCounters(unsigned group) = 0;
 	};
 };
 
diff --git a/src/include/gen/Firebird.pas b/src/include/gen/Firebird.pas
@@ -785,8 +785,7 @@ 	ISC_TIMESTAMP_TZ_EX = record
 	IPerformanceCounters_getObjectCountersPtr = function(this: IPerformanceCounters; index: Cardinal): Int64Ptr; cdecl;
 	IPerformanceStats_getElapsedTimePtr = function(this: IPerformanceStats): QWord; cdecl;
 	IPerformanceStats_getFetchedRecordsPtr = function(this: IPerformanceStats): QWord; cdecl;
-	IPerformanceStats_getPageCountersPtr = function(this: IPerformanceStats): IPerformanceCounters; cdecl;
-	IPerformanceStats_getTableCountersPtr = function(this: IPerformanceStats): IPerformanceCounters; cdecl;
+	IPerformanceStats_getCountersPtr = function(this: IPerformanceStats; group: Cardinal): IPerformanceCounters; cdecl;
 
 	VersionedVTable = class
 		version: NativeInt;
@@ -4112,26 +4111,25 @@ 	IPerformanceCountersImpl = class(IPerformanceCounters)
 	PerformanceStatsVTable = class(VersionedVTable)
 		getElapsedTime: IPerformanceStats_getElapsedTimePtr;
 		getFetchedRecords: IPerformanceStats_getFetchedRecordsPtr;
-		getPageCounters: IPerformanceStats_getPageCountersPtr;
-		getTableCounters: IPerformanceStats_getTableCountersPtr;
+		getCounters: IPerformanceStats_getCountersPtr;
 	end;
 
 	IPerformanceStats = class(IVersioned)
 		const VERSION = 2;
+		const COUNTER_GROUP_PAGES = Cardinal(0);
+		const COUNTER_GROUP_TABLES = Cardinal(1);
 
 		function getElapsedTime(): QWord;
 		function getFetchedRecords(): QWord;
-		function getPageCounters(): IPerformanceCounters;
-		function getTableCounters(): IPerformanceCounters;
+		function getCounters(group: Cardinal): IPerformanceCounters;
 	end;
 
 	IPerformanceStatsImpl = class(IPerformanceStats)
 		constructor create;
 
 		function getElapsedTime(): QWord; virtual; abstract;
 		function getFetchedRecords(): QWord; virtual; abstract;
-		function getPageCounters(): IPerformanceCounters; virtual; abstract;
-		function getTableCounters(): IPerformanceCounters; virtual; abstract;
+		function getCounters(group: Cardinal): IPerformanceCounters; virtual; abstract;
 	end;
 
 {$IFNDEF NO_FBCLIENT}
@@ -10253,14 +10251,9 @@ function IPerformanceStats.getFetchedRecords(): QWord;
 	Result := PerformanceStatsVTable(vTable).getFetchedRecords(Self);
 end;
 
-function IPerformanceStats.getPageCounters(): IPerformanceCounters;
+function IPerformanceStats.getCounters(group: Cardinal): IPerformanceCounters;
 begin
-	Result := PerformanceStatsVTable(vTable).getPageCounters(Self);
-end;
-
-function IPerformanceStats.getTableCounters(): IPerformanceCounters;
-begin
-	Result := PerformanceStatsVTable(vTable).getTableCounters(Self);
+	Result := PerformanceStatsVTable(vTable).getCounters(Self, group);
 end;
 
 var
@@ -17915,21 +17908,11 @@ function IPerformanceStatsImpl_getFetchedRecordsDispatcher(this: IPerformanceSta
 	end
 end;
 
-function IPerformanceStatsImpl_getPageCountersDispatcher(this: IPerformanceStats): IPerformanceCounters; cdecl;
-begin
-	Result := nil;
-	try
-		Result := IPerformanceStatsImpl(this).getPageCounters();
-	except
-		on e: Exception do FbException.catchException(nil, e);
-	end
-end;
-
-function IPerformanceStatsImpl_getTableCountersDispatcher(this: IPerformanceStats): IPerformanceCounters; cdecl;
+function IPerformanceStatsImpl_getCountersDispatcher(this: IPerformanceStats; group: Cardinal): IPerformanceCounters; cdecl;
 begin
 	Result := nil;
 	try
-		Result := IPerformanceStatsImpl(this).getTableCounters();
+		Result := IPerformanceStatsImpl(this).getCounters(group);
 	except
 		on e: Exception do FbException.catchException(nil, e);
 	end
@@ -19020,8 +19003,7 @@ initialization
 	IPerformanceStatsImpl_vTable.version := 2;
 	IPerformanceStatsImpl_vTable.getElapsedTime := @IPerformanceStatsImpl_getElapsedTimeDispatcher;
 	IPerformanceStatsImpl_vTable.getFetchedRecords := @IPerformanceStatsImpl_getFetchedRecordsDispatcher;
-	IPerformanceStatsImpl_vTable.getPageCounters := @IPerformanceStatsImpl_getPageCountersDispatcher;
-	IPerformanceStatsImpl_vTable.getTableCounters := @IPerformanceStatsImpl_getTableCountersDispatcher;
+	IPerformanceStatsImpl_vTable.getCounters := @IPerformanceStatsImpl_getCountersDispatcher;
 
 finalization
 	IVersionedImpl_vTable.destroy;
diff --git a/src/jrd/trace/TraceObjects.h b/src/jrd/trace/TraceObjects.h
@@ -182,14 +182,25 @@ class TraceRuntimeStats :
 		return m_info.pin_records_fetched;
 	}
 
-	Firebird::IPerformanceCounters* getPageCounters()
+	Firebird::IPerformanceCounters* getCounters(unsigned group)
 	{
-		return &m_pageCounters;
-	}
+		Firebird::IPerformanceCounters* counters = nullptr;
 
-	Firebird::IPerformanceCounters* getTableCounters()
-	{
-		return &m_tableCounters;
+		switch (group)
+		{
+			case IPerformanceStats::COUNTER_GROUP_PAGES:
+				counters = &m_pageCounters;
+				break;
+
+			case IPerformanceStats::COUNTER_GROUP_TABLES:
+				counters = &m_tableCounters;
+				break;
+
+			default:
+				fb_assert(false);
+		}
+
+		return counters;
 	}
 
 	Firebird::PerformanceInfo* getInfo()
diff --git a/src/utilities/ntrace/TracePluginImpl.cpp b/src/utilities/ntrace/TracePluginImpl.cpp
@@ -636,7 +636,8 @@ void TracePluginImpl::appendGlobalCounts(IPerformanceStats* stats)
 	temp.printf("%7" QUADFORMAT"d ms", stats->getElapsedTime());
 	record.append(temp);
 
-	const auto pageCounters = stats->getPageCounters();
+	const auto pageCounters = stats->getCounters(IPerformanceStats::COUNTER_GROUP_PAGES);
+	fb_assert(pageCounters);
 
 	if (const auto count = pageCounters->getObjectCount())
 	{
@@ -681,10 +682,14 @@ void TracePluginImpl::appendGlobalCounts(IPerformanceStats* stats)
 
 void TracePluginImpl::appendTableCounts(IPerformanceStats* stats)
 {
-	const auto tableCounters = stats->getTableCounters();
-	const auto count = tableCounters->getObjectCount();
+	if (!config.print_perf)
+		return;
 
-	if (!config.print_perf || !count)
+	const auto tableCounters = stats->getCounters(IPerformanceStats::COUNTER_GROUP_TABLES);
+	fb_assert(tableCounters);
+
+	const auto count = tableCounters->getObjectCount();
+	if (!count)
 		return;
 
 	FB_SIZE_T max_len = 0;

Original file line number	Diff line number	Diff line change
`@@ -1932,10 +1932,12 @@ interface PerformanceCounters : Versioned`
`1932`	`1932`
`1933`	`1933`	`interface PerformanceStats : Versioned`
`1934`	`1934`	`{`
	`1935`	`+ const uint COUNTER_GROUP_PAGES = 0;`
	`1936`	`+ const uint COUNTER_GROUP_TABLES = 1;`
	`1937`	`+`
`1935`	`1938`	`uint64 getElapsedTime(); // in milliseconds`
`1936`	`1939`	`uint64 getFetchedRecords();`
`1937`	`1940`
`1938`		`- PerformanceCounters getPageCounters();`
`1939`		`- PerformanceCounters getTableCounters();`
	`1941`	`+ PerformanceCounters getCounters(uint group);`
`1940`	`1942`	`}`
`1941`	`1943`