Merge remote-tracking branch 'origin/v26'

Author: temeo

CONTRIBUTORS.txt

@@ -21,6 +21,7 @@ Authors from Codership Oy:
  * Alexey Yurchenko <[email protected]>, Codership Oy
  * Mario Karuza <[email protected]>, Codership Oy
  * Daniele Sciascia <[email protected]>, Codership Oy
+ * Jan Lindström <[email protected]>, Codership Oy
  [Codership employees, add name and email/username above this line, but leave this line intact]
 
 Other contributors:

wsrep_api.h

@@ -1,4 +1,4 @@
-/* Copyright (C) 2009-2013 Codership Oy <[email protected]>
+/* Copyright (C) 2009-2024 Codership Oy <[email protected]>
 
    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
@@ -1373,6 +1373,68 @@ int wsrep_load(const char* spec, wsrep_t** hptr, wsrep_log_cb_t log_cb);
  */
 void wsrep_unload(wsrep_t* hptr);
 
+/*!
+ * A callback struct to pass on calls which may be required to
+ * maintain sequential consistency enforced by the caller. The
+ * provider will call the callback once the sequential consistency
+ * is guaranteed.
+ */
+typedef struct wsrep_seq_cb {
+  /*! Pointer to caller defined context. */
+  void *ctx;
+  /*! Function which will be called by the provider once the sequential
+   * consistency is guaranteed.
+   *
+   * @param ctx Caller defined context.
+   */
+  void (*fn)(void *ctx);
+} wsrep_seq_cb_t;
+
+/*!
+ * @brief Certifies transaction with provider.
+ *
+ * Must be called before transaction commit. Returns success code, which
+ * caller must check.
+ *
+ * In case of WSREP_OK, transaction can proceed to commit.
+ * Otherwise transaction must rollback.
+ *
+ * In case of a failure there are two conceptually different situations:
+ * - the writeset was not ordered. In that case meta struct shall contain
+ *   undefined GTID: WSREP_UUID_UNDEFINED:WSREP_SEQNO_UNDEFINED.
+ * - the writeset was successfully ordered, but failed certification.
+ *   In this case meta struct shall contain a valid GTID.
+ *
+ * Regardless of the return code, if meta struct contains a valid GTID
+ * the commit order critical section must be entered with that GTID.
+ *
+ * This is an extension to the original certify() call with additional seq_cb
+ * parameter. The purpose of the seq_cb is to provide a callback to be
+ * called by the provider after the sequential consistency for the write set
+ * is guaranteed.
+ *
+ * @param wsrep      provider handle
+ * @param conn_id    connection ID
+ * @param ws_handle  writeset of committing transaction
+ * @param flags      fine tuning the replication WSREP_FLAG_*
+ * @param meta       transaction meta data
+ * @param seq_cb     callback for provider to call after ensuring sequential
+                     consistency
+ *
+ * @retval WSREP_OK         writeset successfully certified, can commit
+ * @retval WSREP_TRX_FAIL   must rollback transaction
+ * @retval WSREP_CONN_FAIL  must close client connection
+ * @retval WSREP_NODE_FAIL  must close all connections and reinit
+ */
+
+typedef wsrep_status_t (*wsrep_certify_fn_v1)(wsrep_t* wsrep,
+                                              wsrep_conn_id_t conn_id,
+                                              wsrep_ws_handle_t* ws_handle,
+                                              uint32_t flags,
+                                              wsrep_trx_meta_t* meta,
+                                              const wsrep_seq_cb_t* seq_cb);
+#define WSREP_CERTIFY_V1 "wsrep_certify_v1"
+
 #ifdef __cplusplus
 }
 #endif

wsrep_connection_monitor_service.h

@@ -0,0 +1,134 @@
+/*
+ * Copyright (C) 2024-2025 Codership Oy <[email protected]>
+ *
+ * This file is part of wsrep-API.
+ *
+ * Wsrep-API is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * Wsrep-API is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with wsrep-API.  If not, see <https://www.gnu.org/licenses/>.
+ */
+
+/** @file wsrep_connection_monitor_service.h
+ *
+ * This file defines interface for connection monitor service
+ *
+ * The provider which is capable of using the service interface v1 must
+ * export the following functions.
+ *
+ * int wsrep_init_connection_monitor_service_v1(wsrep_connection_monitor_service_v1_t*)
+ * void wsrep_deinit_connection_monitor_service_v1()
+ *
+ * which can be probed by the application.
+ *
+ * The application must initialize the service via above init function
+ * before the provider is initialized via wsrep->init(). The deinit
+ * function must be called after the provider side resources have been
+ * released via wsrep->free().
+ */
+
+#ifndef WSREP_CONNECTION_MONITOR_SERVICE_H
+#define WSREP_CONNECTION_MONITOR_SERVICE_H
+
+#include "wsrep_api.h"
+
+#ifdef __cplusplus
+extern "C"
+{
+#endif /* __cplusplus */
+
+/**
+ * Type tag for application defined connection monitoring processing context.
+ *
+ * Application may pass pointer to the context when initializing
+ * the connection monitor service. This pointer is passed a first parameter for
+ * each service call.
+ */
+typedef struct wsrep_connection_monitor_context wsrep_connection_monitor_context_t;
+
+typedef const void* wsrep_connection_key_t;
+
+/*
+ * Connection monitor connection update callbacks.
+ *
+ */
+
+/*
+ * Connection connect callback.
+ *
+ * @param id connection identifier
+ * @param scheme connection scheme (tcp, ssl)
+ * @param local_address local address string
+ * @param remote_address remote address string
+ */
+typedef void (*wsrep_connection_monitor_connect_cb_t)(
+    wsrep_connection_monitor_context_t*,
+    wsrep_connection_key_t id,
+    const wsrep_buf_t* scheme,
+    const wsrep_buf_t* local_address,
+    const wsrep_buf_t* remote_address);
+
+/*
+ * Connection disconnect callback.
+ *
+ * @param id connection identifier
+ */
+typedef void (*wsrep_connection_monitor_disconnect_cb_t)(
+    wsrep_connection_monitor_context_t*,
+    wsrep_connection_key_t id);
+
+/*
+ * Connection SSL/TLS info callback.
+ *
+ * @param id connection identifier
+ * @param cipher cipher suite name
+ * @param certificate_subject certificate subject name
+ * @param certificate_issuer certificate issuer name
+ * @param version SSL/TLS version string
+ */
+typedef void (*wsrep_connection_monitor_ssl_info_cb_t)(
+    wsrep_connection_monitor_context_t*,
+    wsrep_connection_key_t id,
+    const wsrep_buf_t* cipher,
+    const wsrep_buf_t* certificate_subject,
+    const wsrep_buf_t* certificate_issuer,
+    const wsrep_buf_t* version);
+
+/**
+ * Connection monitor service struct.
+ *
+ * A pointer to this struct must be passed to the call to
+ * wsrep_init_connection_monitor_service_v1.
+ *
+ * The application must provide implementation to all functions defined
+ * in this struct.
+ */
+typedef struct wsrep_connection_monitor_service_v1_st
+{
+    /* Connection monitor connect callback */
+    wsrep_connection_monitor_connect_cb_t connection_monitor_connect_cb;
+    /* Connection monitor disconnect callback */
+    wsrep_connection_monitor_disconnect_cb_t connection_monitor_disconnect_cb;
+    /* Connection monitor ssl info callback */
+    wsrep_connection_monitor_ssl_info_cb_t connection_monitor_ssl_info_cb;
+    /* Pointer to application defined connection monitor context. */
+    wsrep_connection_monitor_context_t* context;
+} wsrep_connection_monitor_service_v1_t;
+
+#ifdef __cplusplus
+}
+#endif /* __cplusplus */
+
+
+#define WSREP_CONNECTION_MONITOR_SERVICE_INIT_FUNC_V1 "wsrep_init_connection_monitor_service_v1"
+#define WSREP_CONNECTION_MONITOR_SERVICE_DEINIT_FUNC_V1 "wsrep_deinit_connection_monitor_service_v1"
+
+#endif /* WSREP_CONNECTION_MONITOR_SERVICE_H */