/* Copyright (c) 2014, 2025, Oracle and/or its affiliates.

   This program is free software; you can redistribute it and/or modify
   it under the terms of the GNU General Public License, version 2.0,
   as published by the Free Software Foundation.

   This program is designed to work with certain software (including
   but not limited to OpenSSL) that is licensed under separate terms,
   as designated in a particular file or component or in included license
   documentation.  The authors of MySQL hereby grant you an additional
   permission to link the program and your derivative works with the
   separately licensed software that they have either included with
   the program or referenced in the documentation.

   This program 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, version 2.0, for more details.

   You should have received a copy of the GNU General Public License
   along with this program; if not, write to the Free Software
   Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301  USA */

#ifndef MYSQL_SERVICE_TRANSACTION_WRITE_SET_INCLUDED

/**
  @file include/mysql/service_rpl_transaction_write_set.h
  This service provides a function for plugins to get the write set of a given
  transaction.

  SYNOPSIS
  get_transaction_write_set()
    This service is used to fetch the write_set extracted for the currently
    executing transaction by passing the thread_id as an input parameter for
    the method.

    @param [in] - thread_id - It is the thread identifier of the currently
                              executing thread.

    In the current implementation it is being called during RUN_HOOK macro,
    on which we know that thread is on plugin context.

  Cleanup :
    The service caller must take of the memory allocated during the service
    call to prevent memory leaks.
*/

#ifndef MYSQL_ABI_CHECK
#include <stdlib.h>
#endif

/**
  This structure is used to keep the list of the hash values of the records
  changed in the transaction.
*/
struct Transaction_write_set {
  unsigned int m_flags;           // reserved
  unsigned long write_set_size;   // Size of the PKE set of the transaction.
  unsigned long long *write_set;  // A pointer to the PKE set.
};

extern "C" struct transaction_write_set_service_st {
  Transaction_write_set *(*get_transaction_write_set)(
      unsigned long m_thread_id);
  void (*require_full_write_set)(bool requires_ws);
  void (*set_write_set_memory_size_limit)(uint64 size_limit);
  void (*update_write_set_memory_size_limit)(uint64 size_limit);
} *transaction_write_set_service;

#ifdef MYSQL_DYNAMIC_PLUGIN

#define get_transaction_write_set(m_thread_id) \
  transaction_write_set_service->get_transaction_write_set(m_thread_id)
#define require_full_write_set(requires_ws) \
  transaction_write_set_service->require_full_write_set(requires_ws)
#define set_write_set_memory_size_limit(size_limit) \
  transaction_write_set_service->set_write_set_memory_size_limit(size_limit)
#define update_write_set_memory_size_limit(size_limit) \
  transaction_write_set_service->update_write_set_memory_size_limit(size_limit)

#else

Transaction_write_set *get_transaction_write_set(unsigned long m_thread_id);

void require_full_write_set(bool requires_ws);

void set_write_set_memory_size_limit(uint64 size_limit);

void update_write_set_memory_size_limit(uint64 size_limit);

#endif

#define MYSQL_SERVICE_TRANSACTION_WRITE_SET_INCLUDED
#endif
