summaryrefslogtreecommitdiffstats
path: root/storage/innobase/include/sync0arr.h
diff options
context:
space:
mode:
Diffstat (limited to 'storage/innobase/include/sync0arr.h')
-rw-r--r--storage/innobase/include/sync0arr.h129
1 files changed, 129 insertions, 0 deletions
diff --git a/storage/innobase/include/sync0arr.h b/storage/innobase/include/sync0arr.h
new file mode 100644
index 00000000..f9f923f9
--- /dev/null
+++ b/storage/innobase/include/sync0arr.h
@@ -0,0 +1,129 @@
+/*****************************************************************************
+
+Copyright (c) 1995, 2016, Oracle and/or its affiliates. All Rights Reserved.
+Copyright (c) 2015, 2020, MariaDB Corporation.
+
+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 Street, Fifth Floor, Boston, MA 02110-1335 USA
+
+*****************************************************************************/
+
+/**************************************************//**
+@file include/sync0arr.h
+The wait array used in synchronization primitives
+
+Created 9/5/1995 Heikki Tuuri
+*******************************************************/
+
+#ifndef sync0arr_h
+#define sync0arr_h
+
+#include "univ.i"
+
+/** Synchronization wait array cell */
+struct sync_cell_t;
+
+/** Synchronization wait array */
+struct sync_array_t;
+
+/******************************************************************//**
+Get an instance of the sync wait array and reserve a wait array cell
+in the instance for waiting for an object. The event of the cell is
+reset to nonsignalled state.
+If reserving cell of the instance fails, try to get another new
+instance until we can reserve an empty cell of it.
+@return the sync array found, never NULL. */
+UNIV_INLINE
+sync_array_t*
+sync_array_get_and_reserve_cell(
+ void* object, /*!< in: pointer to the object to wait for */
+ ulint type, /*!< in: lock request type */
+ const char* file, /*!< in: file where requested */
+ unsigned line, /*!< in: line where requested */
+ sync_cell_t** cell); /*!< out: the cell reserved, never NULL */
+/******************************************************************//**
+Reserves a wait array cell for waiting for an object.
+The event of the cell is reset to nonsignalled state. */
+sync_cell_t*
+sync_array_reserve_cell(
+ sync_array_t* arr, /*!< in: wait array */
+ void* object, /*!< in: pointer to the object to wait for */
+ ulint type, /*!< in: lock request type */
+ const char* file, /*!< in: file where requested */
+ unsigned line); /*!< in: line where requested */
+
+/******************************************************************//**
+This function should be called when a thread starts to wait on
+a wait array cell. In the debug version this function checks
+if the wait for a semaphore will result in a deadlock, in which
+case prints info and asserts. */
+void
+sync_array_wait_event(
+ sync_array_t* arr, /*!< in: wait array */
+ sync_cell_t*& cell); /*!< in: the reserved cell */
+
+/******************************************************************//**
+Frees the cell. NOTE! sync_array_wait_event frees the cell
+automatically! */
+void
+sync_array_free_cell(
+ sync_array_t* arr, /*!< in: wait array */
+ sync_cell_t*& cell); /*!< in: the reserved cell */
+
+/** count of how many times an object has been signalled */
+extern ulint sg_count;
+#define sync_array_object_signalled() ++sg_count
+
+/**********************************************************************//**
+Prints warnings of long semaphore waits to stderr.
+@return TRUE if fatal semaphore wait threshold was exceeded */
+ibool
+sync_array_print_long_waits(
+ os_thread_id_t* waiter, /*!< out: longest waiting thread */
+ const void** sema); /*!< out: longest-waited-for semaphore */
+
+/**********************************************************************//**
+Prints info of the wait array. */
+void
+sync_array_print(
+ FILE* file); /*!< in: file where to print */
+
+/** Create the primary system wait arrays */
+void sync_array_init();
+
+/** Destroy the sync array wait sub-system. */
+void sync_array_close();
+
+/**********************************************************************//**
+Get an instance of the sync wait array. */
+UNIV_INLINE
+sync_array_t*
+sync_array_get();
+/**********************************************************************//**
+Prints info of the wait array without using any mutexes/semaphores. */
+UNIV_INTERN
+void
+sync_array_print_innodb(void);
+
+/*****************************************************************//**
+Gets the nth cell in array.
+@return cell */
+UNIV_INTERN
+sync_cell_t*
+sync_array_get_nth_cell(
+/*====================*/
+ sync_array_t* arr, /*!< in: sync array */
+ ulint n); /*!< in: index */
+
+#include "sync0arr.ic"
+
+#endif /* sync0arr_h */