File flashback.h¶

File List > cubrid > src > transaction > flashback.h
/*
 * Copyright 2008 Search Solution Corporation
 * Copyright 2016 CUBRID Corporation
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *
 */


/*
 * flashback.h
 *
 */

#ifndef _FLASHBACK_H_
#define _FLASHBACK_H_

#ident "$Id$"

#include <algorithm>
#include <map>
#include <unordered_map>
#include <unordered_set>
#include <queue>

#include "config.h"
#include "error_manager.h"
#include "file_io.h"
#include "log_lsa.hpp"
#include "thread_compat.hpp"
#include "oid.h"
#include "connection_defs.h"
#include "log_manager.h"

#define FLASHBACK_MAX_NUM_TRAN_TO_SUMMARY (prm_get_integer_value(PRM_ID_FLASHBACK_MAX_TRANSACTION))

#define FLASHBACK_CHECK_AND_GET_SUMMARY(summary_list, trid, summary_entry) \
  do \
    { \
      auto iter = (summary_list).find (trid); \
      if (iter != (summary_list).end ()) \
        { \
          summary_entry = &(iter->second); \
        } \
      else \
        { \
          summary_entry = NULL; \
        } \
    } \
  while (0)

/* flashback summary information for each transaction generated in server side */
typedef struct flashback_summary_entry
{
  TRANID trid;
  char user[DB_MAX_USER_LENGTH + 1];
  time_t start_time;
  time_t end_time;
  int num_insert;
  int num_update;
  int num_delete;
  LOG_LSA start_lsa;
  LOG_LSA end_lsa;
  // *INDENT-OFF*
  std::unordered_set<OID> classoid_set;
  // *INDENT-ON*
} FLASHBACK_SUMMARY_ENTRY;

#define OR_SUMMARY_ENTRY_SIZE_WITHOUT_CLASS   (OR_INT_SIZE \
                                              + DB_MAX_USER_LENGTH + MAX_ALIGNMENT \
                                              + OR_INT64_SIZE * 2 \
                                              + OR_INT_SIZE * 3 \
                                              + OR_LOG_LSA_SIZE * 2 \
                                              + OR_INT_SIZE)

/* context for making summary information */
typedef struct flashback_summary_context
{
  LOG_LSA start_lsa;
  LOG_LSA end_lsa;
  char *user;
  int num_summary;
  int num_class;
  // *INDENT-OFF*
  std::vector<OID> classoids;
  std::map <TRANID, FLASHBACK_SUMMARY_ENTRY> summary_list;
  // *INDENT-ON*
} FLASHBACK_SUMMARY_CONTEXT;

typedef struct flashback_loginfo_context
{
  TRANID trid;
  char *user;
  LOG_LSA start_lsa;
  LOG_LSA end_lsa;
  int num_class;
  int forward;
  int num_loginfo;
  int queue_size;
  OID invalid_class;
  // *INDENT-OFF*
  std::unordered_set<OID> classoid_set;
  std::queue<CDC_LOGINFO_ENTRY *> loginfo_queue;
  // *INDENT-ON*
} FLASHBACK_LOGINFO_CONTEXT;

extern int flashback_verify_time (THREAD_ENTRY * thread_p, time_t * start_time, time_t * end_time, LOG_LSA * start_lsa,
                  LOG_LSA * end_lsa);
extern char *flashback_pack_summary_entry (char *ptr, FLASHBACK_SUMMARY_CONTEXT context, int *num_summary);

extern int flashback_make_summary_list (THREAD_ENTRY * thread_p, FLASHBACK_SUMMARY_CONTEXT * context);

extern char *flashback_pack_loginfo (THREAD_ENTRY * thread_p, char *ptr, FLASHBACK_LOGINFO_CONTEXT context);
extern int flashback_initialize (THREAD_ENTRY * thread_p);

extern int flashback_make_loginfo (THREAD_ENTRY * thread_p, FLASHBACK_LOGINFO_CONTEXT * context);

extern LOG_PAGEID flashback_min_log_pageid_to_keep ();
extern bool flashback_is_needed_to_keep_archive ();
extern bool flashback_check_time_exceed_threshold (int *threshold);
extern bool flashback_is_loginfo_generation_finished (LOG_LSA * start_lsa, LOG_LSA * end_lsa);

extern void flashback_set_min_log_pageid_to_keep (LOG_LSA * lsa);
extern void flashback_set_request_done_time ();
extern void flashback_set_status_active ();
extern void flashback_set_status_inactive ();
extern void flashback_reset ();

#endif /* _FLASHBACK_H_ */