timescale · mkindahl · Aug 14, 2023 · Mar 22, 2023 · Aug 10, 2023 · akuzm
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -25,6 +25,7 @@ option(
   ENABLE_OPTIMIZER_DEBUG
   "Enable OPTIMIZER_DEBUG when building. Requires Postgres server to be built with OPTIMIZER_DEBUG."
   OFF)
+option(ENABLE_DEBUG_UTILS "Enable debug utilities for the extension." ON)
 
 # Option to enable assertions. Note that if we include headers from a PostgreSQL
 # build that has assertions enabled, we might inherit that setting without

diff --git a/cmake/ScriptFiles.cmake b/cmake/ScriptFiles.cmake
@@ -61,6 +61,10 @@ set(SOURCE_FILES
     cagg_migrate.sql
     job_error_log_retention.sql)
 
+if(ENABLE_DEBUG_UTILS AND CMAKE_BUILD_TYPE MATCHES Debug)
+  list(APPEND SOURCE_FILES debug_utils.sql)
+endif()
+
 if(USE_TELEMETRY)
   list(APPEND SOURCE_FILES with_telemetry.sql)
 else()

diff --git a/scripts/docker-build.sh b/scripts/docker-build.sh
@@ -79,7 +79,7 @@ build_timescaledb()
     if ! docker exec -u root ${BUILD_CONTAINER_NAME} /bin/bash -c " \
         cd /build/debug \
         && git config --global --add safe.directory /src \
-        && cmake -DGENERATE_DOWNGRADE_SCRIPT=${GENERATE_DOWNGRADE_SCRIPT} -DUSE_OPENSSL=${USE_OPENSSL} -DCMAKE_BUILD_TYPE=${BUILD_TYPE} /src \
+        && cmake -DGENERATE_DOWNGRADE_SCRIPT=${GENERATE_DOWNGRADE_SCRIPT} -DENABLE_DEBUG_UTILS=off -DUSE_OPENSSL=${USE_OPENSSL} -DCMAKE_BUILD_TYPE=${BUILD_TYPE} /src \
         && make && make install \
         && echo \"shared_preload_libraries = 'timescaledb'\" >> /usr/local/share/postgresql/postgresql.conf.sample \
         && echo \"timescaledb.telemetry_level=off\" >> /usr/local/share/postgresql/postgresql.conf.sample \

diff --git a/sql/debug_utils.sql b/sql/debug_utils.sql
@@ -0,0 +1,15 @@
+-- This file and its contents are licensed under the Apache License 2.0.
+-- Please see the included NOTICE for copyright information and
+-- LICENSE-APACHE for a copy of the license.
+
+-- This file contains utility functions that are only used in debug
+-- builds for debugging and testing.
+
+CREATE OR REPLACE FUNCTION debug_waitpoint_enable(TEXT) RETURNS VOID LANGUAGE C VOLATILE STRICT
+AS '@MODULE_PATHNAME@', 'ts_debug_point_enable';
+
+CREATE OR REPLACE FUNCTION debug_waitpoint_release(TEXT) RETURNS VOID LANGUAGE C VOLATILE STRICT
+AS '@MODULE_PATHNAME@', 'ts_debug_point_release';
+
+CREATE OR REPLACE FUNCTION debug_waitpoint_id(TEXT) RETURNS BIGINT LANGUAGE C VOLATILE STRICT
+AS '@MODULE_PATHNAME@', 'ts_debug_point_id';
diff --git a/test/expected/test_utils.out b/test/expected/test_utils.out
@@ -27,34 +27,26 @@ ERROR:  TestFailure | (big_double == small_double) [923423478.324200 == 324.3000
 --
 \set ECHO all
 \c :TEST_DBNAME :ROLE_SUPERUSER
-CREATE OR REPLACE FUNCTION debug_point_enable(TEXT)
-RETURNS VOID
-AS :MODULE_PATHNAME, 'ts_debug_point_enable'
-LANGUAGE C VOLATILE STRICT;
-CREATE OR REPLACE FUNCTION debug_point_release(TEXT)
-RETURNS VOID
-AS :MODULE_PATHNAME, 'ts_debug_point_release'
-LANGUAGE C VOLATILE STRICT;
 -- debug point already enabled
-SELECT debug_point_enable('test_debug_point');
- debug_point_enable 
---------------------
+SELECT debug_waitpoint_enable('test_debug_point');
+ debug_waitpoint_enable 
+------------------------
 
 (1 row)
 
 \set ON_ERROR_STOP 0
-SELECT debug_point_enable('test_debug_point');
+SELECT debug_waitpoint_enable('test_debug_point');
 ERROR:  debug point "test_debug_point" already enabled
 \set ON_ERROR_STOP 1
-SELECT debug_point_release('test_debug_point');
- debug_point_release 
----------------------
+SELECT debug_waitpoint_release('test_debug_point');
+ debug_waitpoint_release 
+-------------------------
 
 (1 row)
 
 -- debug point not enabled
 \set ON_ERROR_STOP 0
-SELECT debug_point_release('test_debug_point');
+SELECT debug_waitpoint_release('test_debug_point');
 WARNING:  you don't own a lock of type ExclusiveLock
 ERROR:  cannot release debug point "test_debug_point"
 \set ON_ERROR_STOP 1
@@ -71,19 +63,19 @@ SELECT test_error_injection('test_error');
 
 (1 row)
 
-SELECT debug_point_enable('test_error');
- debug_point_enable 
---------------------
+SELECT debug_waitpoint_enable('test_error');
+ debug_waitpoint_enable 
+------------------------
 
 (1 row)
 
 \set ON_ERROR_STOP 0
 SELECT test_error_injection('test_error');
 ERROR:  error injected at debug point 'test_error'
 \set ON_ERROR_STOP 1
-SELECT debug_point_release('test_error');
- debug_point_release 
----------------------
+SELECT debug_waitpoint_release('test_error');
+ debug_waitpoint_release 
+-------------------------
 
 (1 row)
 

diff --git a/test/isolation/specs/CMakeLists.txt b/test/isolation/specs/CMakeLists.txt
@@ -12,21 +12,12 @@ file(REMOVE ${ISOLATION_TEST_SCHEDULE})
 
 set(TEST_TEMPLATES)
 
-set(TEST_TEMPLATES_DEBUG
-    dropchunks_race.spec.in multi_transaction_indexing.spec.in
-    concurrent_query_and_drop_chunks.spec.in concurrent_add_dimension.spec.in)
-
 if(CMAKE_BUILD_TYPE MATCHES Debug)
-  list(APPEND TEST_TEMPLATES ${TEST_TEMPLATES_DEBUG})
+  list(APPEND TEST_FILES concurrent_add_dimension.spec
+       concurrent_query_and_drop_chunks.spec dropchunks_race.spec
+       multi_transaction_indexing.spec)
 endif(CMAKE_BUILD_TYPE MATCHES Debug)
 
-foreach(TEMPLATE_FILE ${TEST_TEMPLATES})
-  get_filename_component(TEMPLATE ${TEMPLATE_FILE} NAME_WE)
-  set(TEST_FILE ${TEMPLATE}.spec)
-  configure_file(${TEMPLATE_FILE} ${TEST_FILE})
-  list(APPEND TEST_FILES "${TEST_FILE}")
-endforeach(TEMPLATE_FILE)
-
 foreach(TEST_FILE ${TEST_FILES})
   string(REGEX REPLACE "(.+)\.spec" "\\1" TESTS_TO_RUN ${TEST_FILE})
   file(APPEND ${ISOLATION_TEST_SCHEDULE} "test: ${TESTS_TO_RUN}\n")

diff --git a/...on/specs/concurrent_add_dimension.spec.in → ...ation/specs/concurrent_add_dimension.spec b/...on/specs/concurrent_add_dimension.spec.in → ...ation/specs/concurrent_add_dimension.spec
@@ -3,12 +3,6 @@
 # LICENSE-APACHE for a copy of the license.
 
 setup {
-  CREATE OR REPLACE FUNCTION debug_waitpoint_enable(TEXT) RETURNS VOID LANGUAGE C VOLATILE STRICT
-  AS '@TS_MODULE_PATHNAME@', 'ts_debug_point_enable';
-
-  CREATE OR REPLACE FUNCTION debug_waitpoint_release(TEXT) RETURNS VOID LANGUAGE C VOLATILE STRICT
-  AS '@TS_MODULE_PATHNAME@', 'ts_debug_point_release';
-
   DROP TABLE IF EXISTS dim_test;
   CREATE TABLE dim_test(time TIMESTAMPTZ, device int, device2 int);
   SELECT table_name FROM create_hypertable('dim_test', 'time', chunk_time_interval => INTERVAL '1 day');

diff --git a/.../concurrent_query_and_drop_chunks.spec.in → ...ecs/concurrent_query_and_drop_chunks.spec b/.../concurrent_query_and_drop_chunks.spec.in → ...ecs/concurrent_query_and_drop_chunks.spec
@@ -7,12 +7,6 @@ setup {
   CREATE TABLE measurements (time timestamptz, device int, temp float);
   SELECT create_hypertable('measurements', 'time', 'device', 2);
   INSERT INTO measurements VALUES ('2020-01-03 10:30', 1, 1.0), ('2021-01-03 10:30', 2, 2.0);
-
-  CREATE OR REPLACE FUNCTION debug_waitpoint_enable(TEXT) RETURNS VOID LANGUAGE C VOLATILE STRICT
-  AS '@TS_MODULE_PATHNAME@', 'ts_debug_point_enable';
-
-  CREATE OR REPLACE FUNCTION debug_waitpoint_release(TEXT) RETURNS VOID LANGUAGE C VOLATILE STRICT
-  AS '@TS_MODULE_PATHNAME@', 'ts_debug_point_release';
 }
 
 teardown {

diff --git a/test/isolation/specs/dropchunks_race.spec.in → test/isolation/specs/dropchunks_race.spec b/test/isolation/specs/dropchunks_race.spec.in → test/isolation/specs/dropchunks_race.spec
@@ -7,12 +7,6 @@ setup {
   CREATE TABLE dropchunks_race_t1 (time timestamptz, device int, temp float);
   SELECT create_hypertable('dropchunks_race_t1', 'time', 'device', 2);
   INSERT INTO dropchunks_race_t1 VALUES ('2020-01-03 10:30', 1, 32.2);
-
-  CREATE OR REPLACE FUNCTION debug_waitpoint_enable(TEXT) RETURNS VOID LANGUAGE C VOLATILE STRICT
-  AS '@TS_MODULE_PATHNAME@', 'ts_debug_point_enable';
-
-  CREATE OR REPLACE FUNCTION debug_waitpoint_release(TEXT) RETURNS VOID LANGUAGE C VOLATILE STRICT
-  AS '@TS_MODULE_PATHNAME@', 'ts_debug_point_release';
 }
 
 teardown {

diff --git a/.../specs/multi_transaction_indexing.spec.in → ...ion/specs/multi_transaction_indexing.spec b/.../specs/multi_transaction_indexing.spec.in → ...ion/specs/multi_transaction_indexing.spec
@@ -10,12 +10,6 @@ setup {
         (21, 19.5, 3);
 
     CREATE TABLE barrier(i INTEGER);
-
-    CREATE OR REPLACE FUNCTION debug_waitpoint_enable(TEXT) RETURNS VOID LANGUAGE C VOLATILE STRICT
-    AS '@TS_MODULE_PATHNAME@', 'ts_debug_point_enable';
-
-    CREATE OR REPLACE FUNCTION debug_waitpoint_release(TEXT) RETURNS VOID LANGUAGE C VOLATILE STRICT
-    AS '@TS_MODULE_PATHNAME@', 'ts_debug_point_release';
 }
 
 teardown {

diff --git a/test/sql/test_utils.sql b/test/sql/test_utils.sql
@@ -27,26 +27,16 @@ SELECT test.double_eq();
 \set ECHO all
 
 \c :TEST_DBNAME :ROLE_SUPERUSER
-CREATE OR REPLACE FUNCTION debug_point_enable(TEXT)
-RETURNS VOID
-AS :MODULE_PATHNAME, 'ts_debug_point_enable'
-LANGUAGE C VOLATILE STRICT;
-
-CREATE OR REPLACE FUNCTION debug_point_release(TEXT)
-RETURNS VOID
-AS :MODULE_PATHNAME, 'ts_debug_point_release'
-LANGUAGE C VOLATILE STRICT;
-
 -- debug point already enabled
-SELECT debug_point_enable('test_debug_point');
+SELECT debug_waitpoint_enable('test_debug_point');
 \set ON_ERROR_STOP 0
-SELECT debug_point_enable('test_debug_point');
+SELECT debug_waitpoint_enable('test_debug_point');
 \set ON_ERROR_STOP 1
-SELECT debug_point_release('test_debug_point');
+SELECT debug_waitpoint_release('test_debug_point');
 
 -- debug point not enabled
 \set ON_ERROR_STOP 0
-SELECT debug_point_release('test_debug_point');
+SELECT debug_waitpoint_release('test_debug_point');
 \set ON_ERROR_STOP 1
 
 -- error injections
@@ -59,12 +49,12 @@ SET ROLE :ROLE_DEFAULT_PERM_USER;
 
 SELECT test_error_injection('test_error');
 
-SELECT debug_point_enable('test_error');
+SELECT debug_waitpoint_enable('test_error');
 \set ON_ERROR_STOP 0
 SELECT test_error_injection('test_error');
 \set ON_ERROR_STOP 1
 
-SELECT debug_point_release('test_error');
+SELECT debug_waitpoint_release('test_error');
 SELECT test_error_injection('test_error');
 
 -- Test Scanner

diff --git a/tsl/test/expected/remote_txn.out b/tsl/test/expected/remote_txn.out
@@ -40,14 +40,6 @@ LANGUAGE C;
 -- Don't forget to release lock via debug_waitpoint_release on the access node
 -- since it's a session level advisory lock
 --
-CREATE OR REPLACE FUNCTION debug_waitpoint_enable(TEXT)
-RETURNS VOID
-AS :MODULE_PATHNAME, 'ts_debug_point_enable'
-LANGUAGE C VOLATILE STRICT;
-CREATE OR REPLACE FUNCTION debug_waitpoint_release(TEXT)
-RETURNS VOID
-AS :MODULE_PATHNAME, 'ts_debug_point_release'
-LANGUAGE C VOLATILE STRICT;
 CREATE OR REPLACE FUNCTION add_loopback_server(
     server_name            NAME,
     host                   TEXT = 'localhost',

diff --git a/tsl/test/isolation/expected/telemetry_iso.out b/tsl/test/isolation/expected/telemetry_iso.out
diff --git a/tsl/test/isolation/specs/CMakeLists.txt b/tsl/test/isolation/specs/CMakeLists.txt
@@ -3,33 +3,9 @@ set(TEST_TEMPLATES_MODULE reorder_deadlock.spec.in
                           reorder_vs_insert_other_chunk.spec.in)
 
 set(TEST_TEMPLATES_MODULE_DEBUG
-    reorder_vs_insert.spec.in
-    reorder_vs_select.spec.in
-    remote_create_chunk.spec.in
-    dist_su_copy_chunk.spec.in
-    dist_ha_chunk_drop.spec.in
-    dist_restore_point.spec.in
-    dist_cmd_exec.spec.in
-    cagg_drop_chunks_iso.spec.in
-    telemetry_iso.spec.in
-    compression_chunk_race.spec.in
-    compression_merge_race.spec.in
-    decompression_chunk_and_parallel_query.in
-    decompression_chunk_and_parallel_query_wo_idx.in)
-
-# These tests are using markers for the isolation tests (to avoid race
-# conditions causing differing output), which were added after 12.7, 13.3, and
-# 14.0.
-if(PG_VERSION VERSION_GREATER "12.7"
-   OR PG_VERSION VERSION_GREATER "13.3"
-   OR PG_VERSION VERSION_GREATER_EQUAL "14.0")
-  list(APPEND TEST_TEMPLATES_MODULE_DEBUG deadlock_recompress_chunk.spec.in)
-endif()
-
-if(PG_VERSION VERSION_GREATER_EQUAL "14.0")
-  list(APPEND TEST_TEMPLATES_MODULE_DEBUG freeze_chunk.spec.in
-       compression_dml_iso.spec)
-endif()
+    reorder_vs_insert.spec.in reorder_vs_select.spec.in
+    dist_su_copy_chunk.spec.in dist_cmd_exec.spec.in
+    decompression_chunk_and_parallel_query.in)
 
 list(
   APPEND
@@ -44,7 +20,30 @@ list(
 
 if(CMAKE_BUILD_TYPE MATCHES Debug)
   list(APPEND TEST_TEMPLATES_MODULE ${TEST_TEMPLATES_MODULE_DEBUG})
-  list(APPEND TEST_FILES cagg_multi_dist_ht.spec)
+  list(
+    APPEND
+    TEST_FILES
+    cagg_drop_chunks_iso.spec
+    cagg_multi_dist_ht.spec
+    compression_chunk_race.spec
+    compression_merge_race.spec
+    decompression_chunk_and_parallel_query_wo_idx.spec
+    dist_ha_chunk_drop.spec
+    dist_ha_chunk_drop.spec
+    dist_restore_point.spec
+    remote_create_chunk.spec)
+  if(PG_VERSION VERSION_GREATER_EQUAL "14.0")
+    list(APPEND TEST_FILES freeze_chunk.spec compression_dml_iso.spec)
+  endif()
+  # These tests are using markers for the isolation tests (to avoid race
+  # conditions causing differing output), which were added after 12.7, 13.3, and
+  # 14.0.
+  if(PG_VERSION VERSION_GREATER "12.7"
+     OR PG_VERSION VERSION_GREATER "13.3"
+     OR PG_VERSION VERSION_GREATER_EQUAL "14.0")
+    list(APPEND TEST_FILES deadlock_recompress_chunk.spec)
+  endif()
+
 endif(CMAKE_BUILD_TYPE MATCHES Debug)
 
 # need to generate MODULE name for the .spec files

diff --git a/...lation/specs/cagg_drop_chunks_iso.spec.in → ...isolation/specs/cagg_drop_chunks_iso.spec b/...lation/specs/cagg_drop_chunks_iso.spec.in → ...isolation/specs/cagg_drop_chunks_iso.spec
@@ -3,12 +3,6 @@
 # LICENSE-TIMESCALE for a copy of the license.
 
 setup {
-    CREATE OR REPLACE FUNCTION debug_waitpoint_enable(TEXT) RETURNS VOID LANGUAGE C VOLATILE STRICT
-    AS '@TS_MODULE_PATHNAME@', 'ts_debug_point_enable';
-
-    CREATE OR REPLACE FUNCTION debug_waitpoint_release(TEXT) RETURNS VOID LANGUAGE C VOLATILE STRICT
-    AS '@TS_MODULE_PATHNAME@', 'ts_debug_point_release';
-
     CREATE TABLE conditions("time" timestamptz, temp float);
 }
 

diff --git a/...tion/specs/compression_chunk_race.spec.in → ...olation/specs/compression_chunk_race.spec b/...tion/specs/compression_chunk_race.spec.in → ...olation/specs/compression_chunk_race.spec
@@ -7,12 +7,6 @@
 ###
 
 setup {
-   CREATE OR REPLACE FUNCTION debug_waitpoint_enable(TEXT) RETURNS VOID LANGUAGE C VOLATILE STRICT
-     AS '@TS_MODULE_PATHNAME@', 'ts_debug_point_enable';
-
-   CREATE OR REPLACE FUNCTION debug_waitpoint_release(TEXT) RETURNS VOID LANGUAGE C VOLATILE STRICT
-     AS '@TS_MODULE_PATHNAME@', 'ts_debug_point_release';
-
    CREATE TABLE sensor_data (
    time timestamptz not null,
    sensor_id integer not null,

diff --git a/...tion/specs/compression_merge_race.spec.in → ...olation/specs/compression_merge_race.spec b/...tion/specs/compression_merge_race.spec.in → ...olation/specs/compression_merge_race.spec
@@ -7,13 +7,6 @@
 ###
 
 setup {
-   CREATE OR REPLACE FUNCTION debug_waitpoint_enable(TEXT) RETURNS VOID LANGUAGE C VOLATILE STRICT
-     AS '@TS_MODULE_PATHNAME@', 'ts_debug_point_enable';
-
-   CREATE OR REPLACE FUNCTION debug_waitpoint_release(TEXT) RETURNS VOID LANGUAGE C VOLATILE STRICT
-     AS '@TS_MODULE_PATHNAME@', 'ts_debug_point_release';
-
-
    -- Compressing a lot of chunks from a single hypertable in a single transaction can
    -- cause deadlocks due to locking the compressed hypertable when creating compressed chunks.
    -- Hence we compress them in their individual transactions, similar how the compression

diff --git a/...n/specs/deadlock_recompress_chunk.spec.in → ...tion/specs/deadlock_recompress_chunk.spec b/...n/specs/deadlock_recompress_chunk.spec.in → ...tion/specs/deadlock_recompress_chunk.spec
diff --git a/...ession_chunk_and_parallel_query_wo_idx.in → ...sion_chunk_and_parallel_query_wo_idx.spec b/...ession_chunk_and_parallel_query_wo_idx.in → ...sion_chunk_and_parallel_query_wo_idx.spec
@@ -10,12 +10,6 @@
 ###
 
 setup {
-   CREATE OR REPLACE FUNCTION debug_waitpoint_enable(TEXT) RETURNS VOID LANGUAGE C VOLATILE STRICT
-     AS '@TS_MODULE_PATHNAME@', 'ts_debug_point_enable';
-
-   CREATE OR REPLACE FUNCTION debug_waitpoint_release(TEXT) RETURNS VOID LANGUAGE C VOLATILE STRICT
-     AS '@TS_MODULE_PATHNAME@', 'ts_debug_point_release';
-
    CREATE TABLE sensor_data (
    time timestamptz not null,
    sensor_id integer not null,