clickhouse-native 0.11.1 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dbc7f982fc96317d6b6721bc7162e22d01eac4f4fc9edb307443d24fdee59032
-  data.tar.gz: 824150b24641414bfc0ccc4a6e37aa521b768bb73423c1bda9c1bfbefc466044
+  metadata.gz: d4bbe836a1758637fb9dd0a157505037b8bc45d42d253d261b3a349cecaf9716
+  data.tar.gz: 7c0cd5bbea6944c2c0672780088d4342cdf207227bce2c52f388986e9b26bf15
 SHA512:
-  metadata.gz: 6cda8a41d58816d63aa064ae3008b20980d35be6f695ff04433bc760ec28c0a286b707bdeb725d5691ac8245533c05d90df4c9c5b3eb13af6b860a179d9349db
-  data.tar.gz: caf00f391e65eb920a2d917316fa05c1569b7aac7c89f83a122b149c3305a3b0b40b6dc02afa5bd1cebcd78f0897700d5a2f9fbafb2c0d327da973dd3bc542f6
+  metadata.gz: e3abc7862bbf8125ca8168d5a28337ebdf1e11c1f8a2965fff597ccaa4d27eaea70f2116d93b54d2822f6f6fd3fca237e8a864d1cf30e91c0195bb4e730f22be
+  data.tar.gz: 101b7ecc586641e3c0df0f14f0dbd977a450d578e029fbc220f1b86218d4e84ef4a22d5c29eaec1c1e463db96e5fdc9a2b26fb5efdfa0cf1c6780a40aee1d047

data/ext/clickhouse_native/client.cpp

@@ -804,6 +804,64 @@ static void apply_default_settings(Query& q, CHClient* c) {
     }
 }
 
+// ------------------------------------------------------------------
+// Connect / reconnect, off the GVL
+// ------------------------------------------------------------------
+
+namespace {
+struct ResetNoGVL {
+    Client* client;
+    std::exception_ptr err;
+    bool ran;
+};
+
+struct ConnectNoGVL {
+    const ClientOptions* opts;
+    std::unique_ptr<Client>* out;
+    std::exception_ptr err;
+};
+}  // namespace
+
+static void* connect_no_gvl(void* data) {
+    auto* a = static_cast<ConnectNoGVL*>(data);
+    try { *a->out = std::make_unique<Client>(*a->opts); }
+    catch (...) { a->err = std::current_exception(); }
+    return nullptr;
+}
+
+static void* reset_no_gvl(void* data) {
+    auto* a = static_cast<ResetNoGVL*>(data);
+    a->ran = true;
+    try { a->client->ResetConnection(); } catch (...) { a->err = std::current_exception(); }
+    return nullptr;
+}
+
+// ResetConnection() opens a fresh socket and re-handshakes, so it blocks on the
+// network exactly like a query does. Every error path calls it, which is when
+// the server is least likely to answer promptly - the worst moment to be
+// holding the GVL. No unblock function: there is no in-flight query to cancel,
+// and the half-built connection is this thread's.
+//
+// _gvl2, not the ordinary one: every caller is already reporting some other
+// error, and the ordinary variant checks pending interrupts as it retakes the
+// GVL and can longjmp out. That would jump between an rb_protect tag and the
+// rb_jump_tag meant to re-raise it, or out of the active catch handler in
+// insert_block, and would lose the error the caller came here to report.
+//
+// _gvl2 declines to run `func` at all when an interrupt is already pending,
+// though, so the reset is not guaranteed - and one caller needs it to happen:
+// the `break` out of query_each keeps its client, on the understanding that
+// the reset here left it clean (see Pool#discard_unless_clean). Falling back
+// to the plain call covers that. Holding the GVL for a reconnect is the lesser
+// evil against handing back a connection with a reply still draining into it.
+// Failures stay swallowed either way: the pool discards on every other path.
+static void reset_connection_no_gvl(Client* client) {
+    if (!client) return;
+    ResetNoGVL args{client, nullptr, false};
+    rb_thread_call_without_gvl2(reset_no_gvl, &args, nullptr, nullptr);
+    if (!args.ran) { try { client->ResetConnection(); } catch (...) {} }
+}
+
 // Client.new(host:, port:, database:, user:, password:)
 static VALUE ch_client_initialize(int argc, VALUE* argv, VALUE self) {
     VALUE kwargs = Qnil;
@@ -838,7 +896,7 @@ static VALUE ch_client_initialize(int argc, VALUE* argv, VALUE self) {
                         reinterpret_cast<VALUE>(&c->default_settings));
     }
 
-    try {
+    {
         ClientOptions opts;
         opts.SetHost(host).SetPort(port)
             .SetDefaultDatabase(database).SetUser(user).SetPassword(password)
@@ -846,9 +904,17 @@ static VALUE ch_client_initialize(int argc, VALUE* argv, VALUE self) {
             .SetPingBeforeQuery(ping_before_query)
             .TcpKeepAlive(tcp_keepalive)
             .SetRetryTimeout(std::chrono::seconds(retry_timeout));
-        c->client = std::make_unique<Client>(opts);
-    } catch (const std::exception& e) {
-        raise_mapped_ex(e);
+        // The constructor connects and handshakes, and retries for
+        // SetRetryTimeout seconds against an unreachable host - long enough to
+        // freeze every other thread if it ran under the GVL. No unblock
+        // function: there is no in-flight query to cancel, and the socket being
+        // built belongs to this thread.
+        ConnectNoGVL args{&opts, &c->client, nullptr};
+        rb_thread_call_without_gvl(connect_no_gvl, &args, nullptr, nullptr);
+        if (args.err) {
+            try { std::rethrow_exception(args.err); }
+            catch (const std::exception& e) { raise_mapped_ex(e); }
+        }
     }
 
     rb_ivar_set(self, rb_intern("@host"), rb_utf8_str_new(host.data(), host.size()));
@@ -922,7 +988,7 @@ static VALUE ch_client_execute(int argc, VALUE* argv, VALUE self) {
         // so this covers what is left: an unblock function that fires without a
         // longjmp behind it, from a trap handler that does not raise or an
         // interrupt Thread.handle_interrupt has deferred.
-        if (!args.cancelled) { try { c->client->ResetConnection(); } catch (...) {} }
+        if (!args.cancelled) reset_connection_no_gvl(c->client.get());
         try { std::rethrow_exception(args.err); }
         catch (const std::exception& e) { raise_mapped_ex(e); }
     }
@@ -930,82 +996,171 @@ static VALUE ch_client_execute(int argc, VALUE* argv, VALUE self) {
 }
 
 // ------------------------------------------------------------------
-// query() — buffers all rows into an array; GVL is held for the duration.
-// See query_each below for a streaming, GVL-releasing variant.
+// query() / query_value() — buffer the result, releasing the GVL while the
+// server streams. The data callback is the only part that needs Ruby, so it
+// takes the GVL back per block (as query_each does) rather than the whole
+// call holding it: a multi-second read otherwise stops every other thread in
+// the process, which starves timers and lock heartbeats.
 // ------------------------------------------------------------------
 
-static VALUE ch_client_query(int argc, VALUE* argv, VALUE self) {
-    VALUE rb_sql, kwargs = Qnil;
-    rb_scan_args(argc, argv, "1:", &rb_sql, &kwargs);
-    Check_Type(rb_sql, T_STRING);
-    CHClient* c = as_client(self);
-    if (!c->client) rb_raise(err_connection, "clickhouse-native: client is closed");
+namespace {
+struct CollectState {
+    VALUE rows;              // Qnil for query_value, which keeps `out` instead
+    VALUE out;
+    bool first_only;
+    bool seen;
+    std::vector<ID> col_ids;
+    int exc_tag;
+    std::exception_ptr cpp_err;
+    bool aborted;
+};
+
+struct CollectBlockArgs {
+    const Block* block;
+    CollectState* state;
+};
+
+struct QueryNoGVL {
+    Client* client;
+    const Query* query;
+    CollectState* state;
+    std::exception_ptr err;
+    bool cancelled;
+};
+}  // namespace
+
+// The decode throw is caught here, inside the frame rb_protect calls, so it
+// never unwinds through rb_protect itself - doing that walks a setjmp frame
+// whose epilogue never runs and takes the interpreter down. Carried out via
+// state instead; run_buffered_query rethrows it after the no-GVL region.
+static VALUE collect_rows_body(VALUE arg) {
+    auto* args = reinterpret_cast<CollectBlockArgs*>(arg);
+    const Block& block = *args->block;
+    auto* state = args->state;
 
-    VALUE rows = rb_ary_new();
     try {
-        std::vector<ID> col_ids;
-        Query q(std::string(RSTRING_PTR(rb_sql), RSTRING_LEN(rb_sql)));
-        apply_default_settings(q, c);
-        apply_read_settings(q, kwargs);
-        q.OnData([&](const Block& block) {
-            size_t ncols = block.GetColumnCount();
-            size_t nrows = block.GetRowCount();
-            if (nrows == 0) return;
-            if (col_ids.empty()) {
-                col_ids.reserve(ncols);
-                for (size_t i = 0; i < ncols; i++) {
-                    const std::string& name = block.GetColumnName(i);
-                    col_ids.push_back(rb_intern2(name.data(), name.size()));
-                }
+        size_t ncols = block.GetColumnCount();
+        size_t nrows = block.GetRowCount();
+        if (nrows == 0 || ncols == 0) return Qnil;
+
+        if (state->first_only) {
+            if (!state->seen) {
+                state->out = value_at(block[0], 0, block.GetColumnType(0));
+                state->seen = true;
             }
-            for (size_t r = 0; r < nrows; r++) {
-                VALUE h = rb_hash_new();
-                for (size_t cc = 0; cc < ncols; cc++) {
-                    rb_hash_aset(h, ID2SYM(col_ids[cc]),
-                                 value_at(block[cc], r, block.GetColumnType(cc)));
-                }
-                rb_ary_push(rows, h);
+            return Qnil;
+        }
+
+        if (state->col_ids.empty()) {
+            state->col_ids.reserve(ncols);
+            for (size_t i = 0; i < ncols; i++) {
+                const std::string& name = block.GetColumnName(i);
+                state->col_ids.push_back(rb_intern2(name.data(), name.size()));
             }
-        });
-        c->client->Execute(q);
-        return rows;
-    } catch (const std::exception& e) {
-        try { c->client->ResetConnection(); } catch (...) {}
-        raise_mapped_ex(e);
+        }
+        for (size_t r = 0; r < nrows; r++) {
+            VALUE h = rb_hash_new();
+            for (size_t cc = 0; cc < ncols; cc++) {
+                rb_hash_aset(h, ID2SYM(state->col_ids[cc]),
+                             value_at(block[cc], r, block.GetColumnType(cc)));
+            }
+            rb_ary_push(state->rows, h);
+        }
+    } catch (...) {
+        state->cpp_err = std::current_exception();
+        state->aborted = true;
     }
     return Qnil;
 }
 
-// ------------------------------------------------------------------
-// query_value — returns the first cell of the first row, or nil
-// ------------------------------------------------------------------
+static void* with_gvl_collect(void* data) {
+    auto* args = static_cast<CollectBlockArgs*>(data);
+    int tag = 0;
+    rb_protect(collect_rows_body, reinterpret_cast<VALUE>(args), &tag);
+    if (tag != 0) {
+        args->state->exc_tag = tag;
+        args->state->aborted = true;
+    }
+    return nullptr;
+}
 
-static VALUE ch_client_query_value(int argc, VALUE* argv, VALUE self) {
+static void* query_no_gvl(void* data) {
+    auto* a = static_cast<QueryNoGVL*>(data);
+    try {
+        a->client->Execute(*a->query);
+    } catch (...) {
+        a->err = std::current_exception();
+    }
+    return nullptr;
+}
+
+// See execute_unblock: cancel the in-flight query, never tear the streams down
+// from another thread.
+static void query_unblock(void* data) {
+    auto* a = static_cast<QueryNoGVL*>(data);
+    a->state->aborted = true;
+    a->cancelled = true;
+    try { a->client->CancelInFlight(); } catch (...) {}
+}
+
+static VALUE run_buffered_query(VALUE self, int argc, VALUE* argv, bool first_only) {
     VALUE rb_sql, kwargs = Qnil;
     rb_scan_args(argc, argv, "1:", &rb_sql, &kwargs);
     Check_Type(rb_sql, T_STRING);
     CHClient* c = as_client(self);
     if (!c->client) rb_raise(err_connection, "clickhouse-native: client is closed");
 
-    try {
-        VALUE out = Qnil;
-        bool seen = false;
-        Query q(std::string(RSTRING_PTR(rb_sql), RSTRING_LEN(rb_sql)));
-        apply_default_settings(q, c);
-        apply_read_settings(q, kwargs);
-        q.OnData([&](const Block& block) {
-            if (seen) return;
-            if (block.GetRowCount() == 0 || block.GetColumnCount() == 0) return;
-            out = value_at(block[0], 0, block.GetColumnType(0));
-            seen = true;
-        });
-        c->client->Execute(q);
-        return out;
-    } catch (const std::exception& e) {
-        try { c->client->ResetConnection(); } catch (...) {}
-        raise_mapped_ex(e);
+    // `state` lives on this thread's machine stack, and that is what marks
+    // state.rows and state.out while the GVL is dropped below: the GC scans the
+    // stack conservatively, and the context saved at the release covers the
+    // no-GVL window. Moving CollectState off the stack would remove the only
+    // thing keeping the result alive.
+    CollectState state{first_only ? Qnil : rb_ary_new(), Qnil,
+                       first_only, false, {}, 0, nullptr, false};
+    Query q(std::string(RSTRING_PTR(rb_sql), RSTRING_LEN(rb_sql)));
+    apply_default_settings(q, c);
+    apply_read_settings(q, kwargs);
+    q.OnDataCancelable([&state](const Block& block) -> bool {
+        if (state.aborted) return false;
+        // query_value keeps reading to leave the connection clean, but has
+        // nothing left to do once it holds its cell - taking the GVL per block
+        // to discard it costs a round trip each time on a large result.
+        if (state.first_only && state.seen) return true;
+        CollectBlockArgs ca{&block, &state};
+        rb_thread_call_with_gvl(with_gvl_collect, &ca);
+        return !state.aborted;
+    });
+    QueryNoGVL args{c->client.get(), &q, &state, nullptr, false};
+
+    rb_thread_call_without_gvl(query_no_gvl, &args, query_unblock, &args);
+
+    // A decode throw caught in the data callback is the real error; the read
+    // that follows it only reports the abort, so this is checked first.
+    if (state.cpp_err) {
+        reset_connection_no_gvl(c->client.get());
+        try { std::rethrow_exception(state.cpp_err); }
+        catch (const std::exception& e) { raise_mapped_ex(e); }
     }
-    return Qnil;
+    if (args.err) {
+        if (!args.cancelled) reset_connection_no_gvl(c->client.get());
+        if (state.exc_tag) rb_jump_tag(state.exc_tag);
+        try { std::rethrow_exception(args.err); }
+        catch (const std::exception& e) { raise_mapped_ex(e); }
+    }
+    if (state.exc_tag) {
+        reset_connection_no_gvl(c->client.get());
+        rb_jump_tag(state.exc_tag);
+    }
+
+    return first_only ? state.out : state.rows;
+}
+
+static VALUE ch_client_query(int argc, VALUE* argv, VALUE self) {
+    return run_buffered_query(self, argc, argv, false);
+}
+
+static VALUE ch_client_query_value(int argc, VALUE* argv, VALUE self) {
+    return run_buffered_query(self, argc, argv, true);
 }
 
 // ------------------------------------------------------------------
@@ -1096,12 +1251,12 @@ static VALUE ch_client_insert_block(VALUE self, VALUE rb_table, VALUE rb_columns
         InsertNoGVL args{c->client.get(), &table, &block, &c->default_settings, nullptr, false};
         rb_thread_call_without_gvl(insert_no_gvl, &args, insert_unblock, &args);
         if (args.err) {
-            if (!args.cancelled) { try { c->client->ResetConnection(); } catch (...) {} }
+            if (!args.cancelled) reset_connection_no_gvl(c->client.get());
             try { std::rethrow_exception(args.err); }
             catch (const std::exception& e) { raise_mapped_ex(e); }
         }
     } catch (const std::exception& e) {
-        try { c->client->ResetConnection(); } catch (...) {}
+        reset_connection_no_gvl(c->client.get());
         raise_mapped_ex(e);
     }
     return LONG2NUM(nrows);
@@ -1116,6 +1271,7 @@ struct QueryEachState {
     VALUE user_proc;
     std::vector<ID> col_ids;
     int exc_tag;
+    std::exception_ptr cpp_err;
     bool aborted;
 };
 
@@ -1133,27 +1289,35 @@ struct QueryEachNoGVL {
 };
 }  // namespace
 
+// See collect_rows_body: the decode throw is caught inside this frame so it
+// never unwinds through rb_protect.
 static VALUE yield_rows_body(VALUE arg) {
     auto* args = reinterpret_cast<YieldBlockArgs*>(arg);
     const Block& block = *args->block;
     auto* state = args->state;
-    size_t ncols = block.GetColumnCount();
-    size_t nrows = block.GetRowCount();
-    if (nrows == 0) return Qnil;
-    if (state->col_ids.empty() && ncols > 0) {
-        state->col_ids.reserve(ncols);
-        for (size_t i = 0; i < ncols; i++) {
-            const std::string& name = block.GetColumnName(i);
-            state->col_ids.push_back(rb_intern2(name.data(), name.size()));
+
+    try {
+        size_t ncols = block.GetColumnCount();
+        size_t nrows = block.GetRowCount();
+        if (nrows == 0) return Qnil;
+        if (state->col_ids.empty() && ncols > 0) {
+            state->col_ids.reserve(ncols);
+            for (size_t i = 0; i < ncols; i++) {
+                const std::string& name = block.GetColumnName(i);
+                state->col_ids.push_back(rb_intern2(name.data(), name.size()));
+            }
         }
-    }
-    for (size_t r = 0; r < nrows; r++) {
-        VALUE h = rb_hash_new();
-        for (size_t cc = 0; cc < ncols; cc++) {
-            rb_hash_aset(h, ID2SYM(state->col_ids[cc]),
-                         value_at(block[cc], r, block.GetColumnType(cc)));
+        for (size_t r = 0; r < nrows; r++) {
+            VALUE h = rb_hash_new();
+            for (size_t cc = 0; cc < ncols; cc++) {
+                rb_hash_aset(h, ID2SYM(state->col_ids[cc]),
+                             value_at(block[cc], r, block.GetColumnType(cc)));
+            }
+            rb_funcall(state->user_proc, rb_intern("call"), 1, h);
         }
-        rb_funcall(state->user_proc, rb_intern("call"), 1, h);
+    } catch (...) {
+        state->cpp_err = std::current_exception();
+        state->aborted = true;
     }
     return Qnil;
 }
@@ -1194,7 +1358,7 @@ static VALUE ch_client_query_each(int argc, VALUE* argv, VALUE self) {
     CHClient* c = as_client(self);
     if (!c->client) rb_raise(err_connection, "clickhouse-native: client is closed");
 
-    QueryEachState state{rb_block_proc(), {}, 0, false};
+    QueryEachState state{rb_block_proc(), {}, 0, nullptr, false};
     Query q(std::string(RSTRING_PTR(rb_sql), RSTRING_LEN(rb_sql)));
     apply_default_settings(q, c);
     apply_read_settings(q, kwargs);
@@ -1208,14 +1372,21 @@ static VALUE ch_client_query_each(int argc, VALUE* argv, VALUE self) {
 
     rb_thread_call_without_gvl(query_each_no_gvl, &args, query_each_unblock, &args);
 
+    // A decode throw caught in the data callback is the real error; the read
+    // that follows it only reports the abort, so this is checked first.
+    if (state.cpp_err) {
+        reset_connection_no_gvl(c->client.get());
+        try { std::rethrow_exception(state.cpp_err); }
+        catch (const std::exception& e) { raise_mapped_ex(e); }
+    }
     if (args.err) {
-        if (!args.cancelled) { try { c->client->ResetConnection(); } catch (...) {} }
+        if (!args.cancelled) reset_connection_no_gvl(c->client.get());
         if (state.exc_tag) rb_jump_tag(state.exc_tag);
         try { std::rethrow_exception(args.err); }
         catch (const std::exception& e) { raise_mapped_ex(e); }
     }
     if (state.exc_tag) {
-        try { c->client->ResetConnection(); } catch (...) {}
+        reset_connection_no_gvl(c->client.get());
         rb_jump_tag(state.exc_tag);
     }
     return self;
@@ -1270,7 +1441,7 @@ static VALUE ch_client_server_version(VALUE self) {
 static VALUE ch_client_reset_connection(VALUE self) {
     CHClient* c = as_client(self);
     if (!c->client) return Qnil;
-    try { c->client->ResetConnection(); } catch (...) {}
+    reset_connection_no_gvl(c->client.get());
     return Qtrue;
 }
 

data/lib/clickhouse_native/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ClickhouseNative
-  VERSION = "0.11.1"
+  VERSION = "0.12.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: clickhouse-native
 version: !ruby/object:Gem::Version
-  version: 0.11.1
+  version: 0.12.0
 platform: ruby
 authors:
 - Yuri Smirnov