srv0srv.h

Go to the documentation of this file.

/*****************************************************************************

Copyright (C) 1995, 2010, Innobase Oy. All Rights Reserved.
Copyright (C) 2008, 2009, Google Inc.
Copyright (C) 2009, Percona Inc.

Portions of this file contain modifications contributed and copyrighted by
Google, Inc. Those modifications are gratefully acknowledged and are described
briefly in the InnoDB documentation. The contributions by Google are
incorporated with their permission, and subject to the conditions contained in
the file COPYING.Google.

Portions of this file contain modifications contributed and copyrighted
by Percona Inc.. Those modifications are
gratefully acknowledged and are described briefly in the InnoDB
documentation. The contributions by Percona Inc. are incorporated with
their permission, and subject to the conditions contained in the file
COPYING.Percona.

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 the Free Software
Foundation; version 2 of the License.

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 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

*****************************************************************************/

/**************************************************/
#pragma once
#ifndef srv0srv_h
#define srv0srv_h

#include "univ.i"
#ifndef UNIV_HOTBACKUP
#include "sync0sync.h"
#include "os0sync.h"
#include "que0types.h"
#include "trx0types.h"

#include <string>

extern const char*  srv_main_thread_op_info;

static const std::string srv_mysql50_table_name_prefix("#mysql50#");

/* When this event is set the lock timeout and InnoDB monitor
thread starts running */
extern os_event_t srv_lock_timeout_thread_event;

/* The monitor thread waits on this event. */
extern os_event_t srv_monitor_event;

/* The lock timeout thread waits on this event. */
extern os_event_t srv_timeout_event;

/* The error monitor thread waits on this event. */
extern os_event_t srv_error_event;

/* If the last data file is auto-extended, we add this many pages to it
at a time */
#define SRV_AUTO_EXTEND_INCREMENT \
  (srv_auto_extend_increment * ((1024 * 1024) / UNIV_PAGE_SIZE))

/* This is set to TRUE if the MySQL user has set it in MySQL */
extern ibool  srv_lower_case_table_names;

/* Mutex for locking srv_monitor_file */
extern mutex_t  srv_monitor_file_mutex;
/* Temporary file for innodb monitor output */
extern FILE*  srv_monitor_file;
/* Mutex for locking srv_dict_tmpfile.
This mutex has a very high rank; threads reserving it should not
be holding any InnoDB latches. */
extern mutex_t  srv_dict_tmpfile_mutex;
/* Temporary file for output from the data dictionary */
extern FILE*  srv_dict_tmpfile;
/* Mutex for locking srv_misc_tmpfile.
This mutex has a very low rank; threads reserving it should not
acquire any further latches or sleep before releasing this one. */
extern mutex_t  srv_misc_tmpfile_mutex;
/* Temporary file for miscellanous diagnostic output */
extern FILE*  srv_misc_tmpfile;

/* Server parameters which are read from the initfile */

extern char*  srv_data_home;
#ifdef UNIV_LOG_ARCHIVE
extern char*  srv_arch_dir;
#endif /* UNIV_LOG_ARCHIVE */

#ifndef UNIV_HOTBACKUP
extern my_bool  srv_file_per_table;
#else
extern ibool  srv_file_per_table;
#endif /* UNIV_HOTBACKUP */

extern ulint  srv_file_format;
extern ulint  srv_max_file_format_at_startup;
extern ibool  srv_locks_unsafe_for_binlog;
#endif /* !UNIV_HOTBACKUP */

/* If this flag is TRUE, then we will use the native aio of the
OS (provided we compiled Innobase with it in), otherwise we will
use simulated aio we build below with threads.
Currently we support native aio on windows and linux */
extern my_bool  srv_use_native_aio;
#ifdef __WIN__
extern ibool  srv_use_native_conditions;
#endif
extern ulint  srv_n_data_files;
extern char** srv_data_file_names;
extern ulint* srv_data_file_sizes;
extern ulint* srv_data_file_is_raw_partition;

extern ibool  srv_auto_extend_last_data_file;
extern ulint  srv_last_file_size_max;
extern char** srv_log_group_home_dirs;
#ifndef UNIV_HOTBACKUP
extern unsigned int srv_auto_extend_increment;

extern ibool  srv_created_new_raw;

extern ulint  srv_n_log_groups;
extern ulint  srv_n_log_files;
extern ulint  srv_log_file_size;
extern ulint  srv_log_buffer_size;
extern ulong  srv_flush_log_at_trx_commit;
extern bool srv_adaptive_flushing;


/* The sort order table of the MySQL latin1_swedish_ci character set
collation */
#if defined(BUILD_DRIZZLE)
extern const byte  srv_latin1_ordering[256];
extern bool srv_use_sys_malloc;
#else
extern const byte*     srv_latin1_ordering;
# ifndef UNIV_HOTBACKUP
extern my_bool srv_use_sys_malloc;
# else
extern ibool   srv_use_sys_malloc;
# endif /* UNIV_HOTBACKUP */
#endif /* BUILD_DRIZZLE */
extern ulint  srv_buf_pool_size;  
extern ulint    srv_buf_pool_instances; 
extern ulint  srv_buf_pool_old_size;  
extern ulint  srv_buf_pool_curr_size; 
extern ulint  srv_mem_pool_size;
extern ulint  srv_lock_table_size;

extern ulint  srv_n_file_io_threads;
extern ulong  srv_read_ahead_threshold;
extern ulint  srv_n_read_io_threads;
extern ulint  srv_n_write_io_threads;

/* Number of IO operations per second the server can do */
extern ulong    srv_io_capacity;
/* Returns the number of IO operations that is X percent of the
capacity. PCT_IO(5) -> returns the number of IO operations that
is 5% of the max where max is srv_io_capacity.  */
#define PCT_IO(p) ((ulong) (srv_io_capacity * ((double) p / 100.0)))

#ifdef UNIV_LOG_ARCHIVE
extern ibool    srv_log_archive_on;
extern ibool    srv_archive_recovery;
extern ib_uint64_t  srv_archive_recovery_limit_lsn;
#endif /* UNIV_LOG_ARCHIVE */

extern char*  srv_file_flush_method_str;
extern ulint  srv_unix_file_flush_method;
extern ulint  srv_win_file_flush_method;

extern ulint  srv_max_n_open_files;

extern ulint  srv_max_dirty_pages_pct;

extern ulint  srv_force_recovery;
extern ulong  srv_thread_concurrency;

extern ulint  srv_max_n_threads;

extern lint srv_conc_n_threads;

extern ulint  srv_fast_shutdown;   /* If this is 1, do not do a
           purge and index buffer merge.
           If this 2, do not even flush the
           buffer pool to data files at the
           shutdown: we effectively 'crash'
           InnoDB (but lose no committed
           transactions). */
extern ibool  srv_innodb_status;

extern ib_uint64_t  srv_stats_sample_pages;

extern ibool  srv_use_doublewrite_buf;
extern ibool  srv_use_checksums;

extern ulong  srv_max_buf_pool_modified_pct;
extern ulong  srv_max_purge_lag;

extern ulong  srv_replication_delay;

extern uint64_t srv_ibuf_max_size;
extern uint32_t srv_ibuf_active_contract;
extern uint32_t srv_ibuf_accel_rate;
extern uint32_t srv_checkpoint_age_target;
extern uint32_t srv_flush_neighbor_pages;
extern uint32_t srv_read_ahead;
extern uint32_t srv_adaptive_flushing_method;

extern ibool    srv_read_only;
extern ibool    srv_fake_write;
extern ibool    srv_apply_log_only;

/*-------------------------------------------*/

extern ulint  srv_n_rows_inserted;
extern ulint  srv_n_rows_updated;
extern ulint  srv_n_rows_deleted;
extern ulint  srv_n_rows_read;

extern ibool  srv_print_innodb_monitor;
extern ibool  srv_print_innodb_lock_monitor;
extern ibool  srv_print_innodb_tablespace_monitor;
extern ibool  srv_print_verbose_log;
extern ibool  srv_print_innodb_table_monitor;

extern ibool  srv_lock_timeout_active;
extern ibool  srv_monitor_active;
extern ibool  srv_error_monitor_active;

extern ulong  srv_n_spin_wait_rounds;
extern ulong  srv_n_free_tickets_to_enter;
extern ulong  srv_thread_sleep_delay;
extern ulong  srv_spin_wait_delay;
extern ibool  srv_priority_boost;

extern ulint  srv_truncated_status_writes;

#ifdef UNIV_DEBUG
extern  ibool srv_print_thread_releases;
extern  ibool srv_print_lock_waits;
extern  ibool srv_print_buf_io;
extern  ibool srv_print_log_io;
extern  ibool srv_print_latch_waits;
#else /* UNIV_DEBUG */
# define srv_print_thread_releases  FALSE
# define srv_print_lock_waits   FALSE
# define srv_print_buf_io   FALSE
# define srv_print_log_io   FALSE
# define srv_print_latch_waits    FALSE
#endif /* UNIV_DEBUG */

extern ulint  srv_activity_count;
extern ulint  srv_fatal_semaphore_wait_threshold;
extern ulint  srv_dml_needed_delay;

extern mutex_t* kernel_mutex_temp;/* mutex protecting the server, trx structs,
        query threads, and lock table: we allocate
        it from dynamic memory to get it to the
        same DRAM page as other hotspot semaphores */
extern mutex_t* commit_id_mutex_temp;

#define kernel_mutex (*kernel_mutex_temp)
#define commit_id_mutex (*commit_id_mutex_temp)

#define SRV_MAX_N_IO_THREADS  130

/* Array of English strings describing the current state of an
i/o handler thread */
extern const char* srv_io_thread_op_info[];
extern const char* srv_io_thread_function[];

/* the number of the log write requests done */
extern ulint srv_log_write_requests;

/* the number of physical writes to the log performed */
extern ulint srv_log_writes;

/* amount of data written to the log files in bytes */
extern ulint srv_os_log_written;

/* amount of writes being done to the log files */
extern ulint srv_os_log_pending_writes;

/* we increase this counter, when there we don't have enough space in the
log buffer and have to flush it */
extern ulint srv_log_waits;

/* the number of purge threads to use from the worker pool (currently 0 or 1) */
extern ulong srv_n_purge_threads;

/* the number of records to purge in one batch */
extern ulong srv_purge_batch_size;

/* variable that counts amount of data read in total (in bytes) */
extern ulint srv_data_read;

/* here we count the amount of data written in total (in bytes) */
extern ulint srv_data_written;

/* this variable counts the amount of times, when the doublewrite buffer
was flushed */
extern ulint srv_dblwr_writes;

/* here we store the number of pages that have been flushed to the
doublewrite buffer */
extern ulint srv_dblwr_pages_written;

/* in this variable we store the number of write requests issued */
extern ulint srv_buf_pool_write_requests;

/* here we store the number of times when we had to wait for a free page
in the buffer pool. It happens when the buffer pool is full and we need
to make a flush, in order to be able to read or create a page. */
extern ulint srv_buf_pool_wait_free;

/* variable to count the number of pages that were written from the
buffer pool to disk */
extern ulint srv_buf_pool_flushed;

extern ulint srv_buf_pool_reads;

extern uint32_t srv_auto_lru_dump;

typedef struct export_var_struct export_struc;

extern export_struc export_vars;

typedef struct srv_sys_struct srv_sys_t;

extern srv_sys_t* srv_sys;

# ifdef UNIV_PFS_THREAD
/* Keys to register InnoDB threads with performance schema */
extern mysql_pfs_key_t  trx_rollback_clean_thread_key;
extern mysql_pfs_key_t  io_handler_thread_key;
extern mysql_pfs_key_t  srv_lock_timeout_thread_key;
extern mysql_pfs_key_t  srv_error_monitor_thread_key;
extern mysql_pfs_key_t  srv_monitor_thread_key;
extern mysql_pfs_key_t  srv_master_thread_key;

/* This macro register the current thread and its key with performance
schema */
#  define pfs_register_thread(key)      \
do {                \
  if (PSI_server) {         \
    struct PSI_thread* psi = PSI_server->new_thread(key, NULL, 0);\
    if (psi) {          \
      PSI_server->set_thread(psi);    \
    }           \
  }             \
} while (0)

/* This macro delist the current thread from performance schema */
#  define pfs_delete_thread()       \
do {                \
  if (PSI_server) {         \
    PSI_server->delete_current_thread();    \
  }             \
} while (0)
# endif /* UNIV_PFS_THREAD */

#endif /* !UNIV_HOTBACKUP */

enum {
  SRV_NOT_RAW = 0,  
  SRV_NEW_RAW,    
  SRV_OLD_RAW   
};

enum {
  SRV_UNIX_FSYNC = 1, 
  SRV_UNIX_O_DSYNC, 
  SRV_UNIX_LITTLESYNC,  
  SRV_UNIX_NOSYNC,  
  SRV_UNIX_O_DIRECT,  
  SRV_UNIX_ALL_O_DIRECT 
};

enum {
  SRV_WIN_IO_NORMAL = 1,  
  SRV_WIN_IO_UNBUFFERED 
};

enum {
  SRV_FORCE_IGNORE_CORRUPT = 1, 
  SRV_FORCE_NO_BACKGROUND = 2,  
  SRV_FORCE_NO_TRX_UNDO = 3,  
  SRV_FORCE_NO_IBUF_MERGE = 4,  
  SRV_FORCE_NO_UNDO_LOG_SCAN = 5, 
  SRV_FORCE_NO_LOG_REDO = 6 
};

#ifndef UNIV_HOTBACKUP

enum srv_thread_type {
  SRV_COM = 1,  
  SRV_CONSOLE,  
  SRV_WORKER, 
#if 0
  /* Utility threads */
  SRV_BUFFER, 
  SRV_RECOVERY, 
  SRV_INSERT, 
#endif
  SRV_MASTER  
};

/*********************************************************************/
UNIV_INTERN
ulint
srv_boot(void);
/*==========*/
/*********************************************************************/
UNIV_INTERN
void
srv_init(void);
/*==========*/
/*********************************************************************/
UNIV_INTERN
void
srv_free(void);
/*==========*/
/*********************************************************************/
UNIV_INTERN
void
srv_general_init(void);
/*==================*/
/*********************************************************************/
UNIV_INTERN
ulint
srv_get_n_threads(void);
/*===================*/
/*********************************************************************/
enum srv_thread_type
srv_get_thread_type(void);
/*=====================*/
/*********************************************************************/
UNIV_INTERN
void
srv_set_io_thread_op_info(
/*======================*/
  ulint   i,  
  const char* str); 
/*********************************************************************/
UNIV_INTERN
ulint
srv_release_threads(
/*================*/
  enum srv_thread_type  type, 
  ulint     n); 
/*********************************************************************/
UNIV_INTERN
os_thread_ret_t
srv_master_thread(
/*==============*/
  void* arg); 
/*******************************************************************/
UNIV_INTERN
void
srv_wake_purge_thread(void);
/*=======================*/
/*******************************************************************/
UNIV_INTERN
void
srv_active_wake_master_thread(void);
/*===============================*/
/*******************************************************************/
UNIV_INTERN
void
srv_wake_master_thread(void);
/*========================*/
/*******************************************************************/
UNIV_INTERN
void
srv_wake_purge_thread_if_not_active(void);
/*=====================================*/
/*********************************************************************/
UNIV_INTERN
void
srv_conc_enter_innodb(
/*==================*/
  trx_t*  trx); 
/*********************************************************************/
UNIV_INTERN
void
srv_conc_force_enter_innodb(
/*========================*/
  trx_t*  trx); 
/*********************************************************************/
UNIV_INTERN
void
srv_conc_force_exit_innodb(
/*=======================*/
  trx_t*  trx); 
/*********************************************************************/
UNIV_INTERN
void
srv_conc_exit_innodb(
/*=================*/
  trx_t*  trx); 
/***************************************************************/
UNIV_INTERN
void
srv_suspend_mysql_thread(
/*=====================*/
  que_thr_t*  thr); 
/********************************************************************/
UNIV_INTERN
void
srv_release_mysql_thread_if_suspended(
/*==================================*/
  que_thr_t*  thr); 
/*********************************************************************/
UNIV_INTERN
os_thread_ret_t
srv_lock_timeout_thread(
/*====================*/
  void* arg); 
/*********************************************************************/
UNIV_INTERN
os_thread_ret_t
srv_monitor_thread(
/*===============*/
  void* arg); 
/*************************************************************************
A thread which prints warnings about semaphore waits which have lasted
too long. These can be used to track bugs which cause hangs.
@return a dummy parameter */
UNIV_INTERN
os_thread_ret_t
srv_error_monitor_thread(
/*=====================*/
  void* arg); 
/*********************************************************************/
UNIV_INTERN
os_thread_ret_t
srv_LRU_dump_restore_thread(
/*====================*/
  void* arg); 
/******************************************************************/
UNIV_INTERN
ibool
srv_printf_innodb_monitor(
/*======================*/
  FILE* file,   
  ibool nowait,   
  ulint*  trx_start,  
  ulint*  trx_end); 
/******************************************************************/
UNIV_INTERN
void
srv_export_innodb_status(void);
/*==========================*/

/******************************************************************/
UNIV_INTERN
void
srv_inc_activity_count(void);
/*=========================*/

/*********************************************************************/
UNIV_INTERN
os_thread_ret_t
srv_purge_thread(
/*=============*/
  void* /*arg __attribute__((unused))*/); 
/**********************************************************************/
UNIV_INTERN
void
srv_que_task_enqueue_low(
/*=====================*/
  que_thr_t*  thr); 
/**********************************************************************/
UNIV_INTERN
ibool
srv_is_any_background_thread_active(void);
/*======================================*/

struct export_var_struct{
  ulint innodb_data_pending_reads;  
  ulint innodb_data_pending_writes; 
  ulint innodb_data_pending_fsyncs; 
  ulint innodb_data_fsyncs;   
  ulint innodb_data_read;     
  ulint innodb_data_writes;   
  ulint innodb_data_written;    
  ulint innodb_data_reads;    
  ulint innodb_buffer_pool_pages_total; 
  ulint innodb_buffer_pool_pages_data;  
  ulint innodb_buffer_pool_pages_dirty; 
  ulint innodb_buffer_pool_pages_misc;  
  ulint innodb_buffer_pool_pages_free;  
#ifdef UNIV_DEBUG
  ulint innodb_buffer_pool_pages_latched; 
#endif /* UNIV_DEBUG */
  ulint innodb_buffer_pool_read_requests; 
  ulint innodb_buffer_pool_reads;   
  ulint innodb_buffer_pool_wait_free; 
  ulint innodb_buffer_pool_pages_flushed; 
  ulint innodb_buffer_pool_write_requests;
  ulint innodb_buffer_pool_read_ahead;  
  ulint innodb_buffer_pool_read_ahead_evicted;
  ulint innodb_dblwr_pages_written; 
  ulint innodb_dblwr_writes;    
  ibool innodb_have_atomic_builtins;  
  ulint innodb_log_waits;     
  ulint innodb_log_write_requests;  
  ulint innodb_log_writes;    
  ulint innodb_os_log_written;    
  ulint innodb_os_log_fsyncs;   
  ulint innodb_os_log_pending_writes; 
  ulint innodb_os_log_pending_fsyncs; 
  ulint innodb_page_size;     
  ulint innodb_pages_created;   
  ulint innodb_pages_read;    
  ulint innodb_pages_written;   
  ulint innodb_row_lock_waits;    
  ulint innodb_row_lock_current_waits;  
  ib_int64_t innodb_row_lock_time;  
  ulint innodb_row_lock_time_avg;   
  ulint innodb_row_lock_time_max;   
  ulint innodb_rows_read;     
  ulint innodb_rows_inserted;   
  ulint innodb_rows_updated;    
  ulint innodb_rows_deleted;    
  ulint innodb_truncated_status_writes; 
};

typedef struct srv_slot_struct  srv_slot_t;

typedef srv_slot_t  srv_table_t;

struct srv_sys_struct{
  srv_table_t*  threads;  
  UT_LIST_BASE_NODE_T(que_thr_t)
      tasks;    
};

extern ulint  srv_n_threads_active[];
#else /* !UNIV_HOTBACKUP */
# define srv_use_adaptive_hash_indexes    FALSE
# define srv_use_checksums      TRUE
# define srv_use_native_aio     FALSE
# define srv_force_recovery     0UL
# define srv_set_io_thread_op_info(t,info)  ((void) 0)
# define srv_is_being_started     0
# define srv_win_file_flush_method    SRV_WIN_IO_UNBUFFERED
# define srv_unix_file_flush_method   SRV_UNIX_O_DSYNC
# define srv_start_raw_disk_in_use    0
# define srv_file_per_table     1
#endif /* !UNIV_HOTBACKUP */


#endif