1 /*****************************************************************************
2
3 Copyright (c) 1995, 2020, Oracle and/or its affiliates. All Rights Reserved.
4 Copyright (c) 2008, Google Inc.
5
6 Portions of this file contain modifications contributed and copyrighted by
7 Google, Inc. Those modifications are gratefully acknowledged and are described
8 briefly in the InnoDB documentation. The contributions by Google are
9 incorporated with their permission, and subject to the conditions contained in
10 the file COPYING.Google.
11
12 This program is free software; you can redistribute it and/or modify
13 it under the terms of the GNU General Public License, version 2.0,
14 as published by the Free Software Foundation.
15
16 This program is also distributed with certain software (including
17 but not limited to OpenSSL) that is licensed under separate terms,
18 as designated in a particular file or component or in included license
19 documentation. The authors of MySQL hereby grant you an additional
20 permission to link the program and your derivative works with the
21 separately licensed software that they have included with MySQL.
22
23 This program is distributed in the hope that it will be useful,
24 but WITHOUT ANY WARRANTY; without even the implied warranty of
25 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
26 GNU General Public License, version 2.0, for more details.
27
28 You should have received a copy of the GNU General Public License along with
29 this program; if not, write to the Free Software Foundation, Inc.,
30 51 Franklin Street, Suite 500, Boston, MA 02110-1335 USA
31
32 *****************************************************************************/
33
34 /**************************************************//**
35 @file sync/sync0sync.cc
36 Mutex, the basic synchronization primitive
37
38 Created 9/5/1995 Heikki Tuuri
39 *******************************************************/
40
41 #include "univ.i"
42 #include "sync0rw.h"
43 #include "sync0sync.h"
44
45 #ifdef HAVE_PSI_INTERFACE
46 /** Keeps count of number of Performance Schema keys defined. */
47 unsigned int mysql_pfs_key_t::s_count;
48 #endif /* HAVE_PSI_INTERFACE */
49
50 #ifdef UNIV_PFS_MUTEX
51 /* Key to register autoinc_mutex with performance schema */
52 mysql_pfs_key_t autoinc_mutex_key;
53 # ifndef PFS_SKIP_BUFFER_MUTEX_RWLOCK
54 mysql_pfs_key_t buffer_block_mutex_key;
55 # endif /* !PFS_SKIP_BUFFER_MUTEX_RWLOCK */
56 mysql_pfs_key_t buf_pool_mutex_key;
57 mysql_pfs_key_t buf_pool_zip_mutex_key;
58 mysql_pfs_key_t cache_last_read_mutex_key;
59 mysql_pfs_key_t dict_foreign_err_mutex_key;
60 mysql_pfs_key_t dict_sys_mutex_key;
61 mysql_pfs_key_t file_format_max_mutex_key;
62 mysql_pfs_key_t fil_system_mutex_key;
63 mysql_pfs_key_t flush_list_mutex_key;
64 mysql_pfs_key_t fts_bg_threads_mutex_key;
65 mysql_pfs_key_t fts_delete_mutex_key;
66 mysql_pfs_key_t fts_optimize_mutex_key;
67 mysql_pfs_key_t fts_doc_id_mutex_key;
68 mysql_pfs_key_t fts_pll_tokenize_mutex_key;
69 mysql_pfs_key_t hash_table_mutex_key;
70 mysql_pfs_key_t ibuf_bitmap_mutex_key;
71 mysql_pfs_key_t ibuf_mutex_key;
72 mysql_pfs_key_t ibuf_pessimistic_insert_mutex_key;
73 mysql_pfs_key_t log_sys_mutex_key;
74 mysql_pfs_key_t log_sys_write_mutex_key;
75 mysql_pfs_key_t log_cmdq_mutex_key;
76 mysql_pfs_key_t log_flush_order_mutex_key;
77 mysql_pfs_key_t mutex_list_mutex_key;
78 mysql_pfs_key_t recalc_pool_mutex_key;
79 mysql_pfs_key_t page_cleaner_mutex_key;
80 mysql_pfs_key_t purge_sys_pq_mutex_key;
81 mysql_pfs_key_t recv_sys_mutex_key;
82 mysql_pfs_key_t recv_writer_mutex_key;
83 mysql_pfs_key_t redo_rseg_mutex_key;
84 mysql_pfs_key_t noredo_rseg_mutex_key;
85 mysql_pfs_key_t page_zip_stat_per_index_mutex_key;
86 # ifdef UNIV_DEBUG
87 mysql_pfs_key_t rw_lock_debug_mutex_key;
88 # endif /* UNIV_DEBUG */
89 mysql_pfs_key_t rtr_active_mutex_key;
90 mysql_pfs_key_t rtr_match_mutex_key;
91 mysql_pfs_key_t rtr_path_mutex_key;
92 mysql_pfs_key_t rtr_ssn_mutex_key;
93 mysql_pfs_key_t rw_lock_list_mutex_key;
94 mysql_pfs_key_t rw_lock_mutex_key;
95 mysql_pfs_key_t srv_dict_tmpfile_mutex_key;
96 mysql_pfs_key_t srv_innodb_monitor_mutex_key;
97 mysql_pfs_key_t srv_misc_tmpfile_mutex_key;
98 mysql_pfs_key_t srv_monitor_file_mutex_key;
99 # ifdef UNIV_DEBUG
100 mysql_pfs_key_t sync_thread_mutex_key;
101 # endif /* UNIV_DEBUG */
102 mysql_pfs_key_t buf_dblwr_mutex_key;
103 mysql_pfs_key_t trx_undo_mutex_key;
104 mysql_pfs_key_t trx_mutex_key;
105 mysql_pfs_key_t trx_pool_mutex_key;
106 mysql_pfs_key_t trx_pool_manager_mutex_key;
107 mysql_pfs_key_t lock_mutex_key;
108 mysql_pfs_key_t lock_wait_mutex_key;
109 mysql_pfs_key_t trx_sys_mutex_key;
110 mysql_pfs_key_t srv_sys_mutex_key;
111 mysql_pfs_key_t srv_threads_mutex_key;
112 # ifndef PFS_SKIP_EVENT_MUTEX
113 mysql_pfs_key_t event_mutex_key;
114 mysql_pfs_key_t event_manager_mutex_key;
115 # endif /* !PFS_SKIP_EVENT_MUTEX */
116 mysql_pfs_key_t sync_array_mutex_key;
117 mysql_pfs_key_t thread_mutex_key;
118 mysql_pfs_key_t zip_pad_mutex_key;
119 mysql_pfs_key_t row_drop_list_mutex_key;
120 mysql_pfs_key_t master_key_id_mutex_key;
121 mysql_pfs_key_t analyze_index_mutex_key;
122
123 #endif /* UNIV_PFS_MUTEX */
124
125 #ifdef UNIV_PFS_RWLOCK
126 mysql_pfs_key_t btr_search_latch_key;
127 # ifndef PFS_SKIP_BUFFER_MUTEX_RWLOCK
128 mysql_pfs_key_t buf_block_lock_key;
129 # endif /* !PFS_SKIP_BUFFER_MUTEX_RWLOCK */
130 # ifdef UNIV_DEBUG
131 mysql_pfs_key_t buf_block_debug_latch_key;
132 # endif /* UNIV_DEBUG */
133 mysql_pfs_key_t checkpoint_lock_key;
134 mysql_pfs_key_t dict_operation_lock_key;
135 mysql_pfs_key_t dict_table_stats_key;
136 mysql_pfs_key_t hash_table_locks_key;
137 mysql_pfs_key_t index_tree_rw_lock_key;
138 mysql_pfs_key_t index_online_log_key;
139 mysql_pfs_key_t fil_space_latch_key;
140 mysql_pfs_key_t fts_cache_rw_lock_key;
141 mysql_pfs_key_t fts_cache_init_rw_lock_key;
142 mysql_pfs_key_t trx_i_s_cache_lock_key;
143 mysql_pfs_key_t trx_purge_latch_key;
144 #endif /* UNIV_PFS_RWLOCK */
145
146 #ifdef HAVE_PSI_INTERFACE
147 /* There are mutexes/rwlocks that we want to exclude from instrumentation
148 even if their corresponding performance schema define is set. And this
149 PFS_NOT_INSTRUMENTED is used as the key value to identify those objects that
150 would be excluded from instrumentation.*/
151 mysql_pfs_key_t PFS_NOT_INSTRUMENTED(ULINT32_UNDEFINED);
152 #endif /* HAVE_PSI_INTERFACE */
153
154 /** For monitoring active mutexes */
155 MutexMonitor* mutex_monitor;
156
157 /**
158 Prints wait info of the sync system.
159 @param file - where to print */
160 static
161 void
sync_print_wait_info(FILE * file)162 sync_print_wait_info(FILE* file)
163 {
164 fprintf(file,
165 "RW-shared spins " UINT64PF ", rounds " UINT64PF ","
166 " OS waits " UINT64PF "\n"
167 "RW-excl spins " UINT64PF ", rounds " UINT64PF ","
168 " OS waits " UINT64PF "\n"
169 "RW-sx spins " UINT64PF ", rounds " UINT64PF ","
170 " OS waits " UINT64PF "\n",
171 (ib_uint64_t) rw_lock_stats.rw_s_spin_wait_count,
172 (ib_uint64_t) rw_lock_stats.rw_s_spin_round_count,
173 (ib_uint64_t) rw_lock_stats.rw_s_os_wait_count,
174 (ib_uint64_t) rw_lock_stats.rw_x_spin_wait_count,
175 (ib_uint64_t) rw_lock_stats.rw_x_spin_round_count,
176 (ib_uint64_t) rw_lock_stats.rw_x_os_wait_count,
177 (ib_uint64_t) rw_lock_stats.rw_sx_spin_wait_count,
178 (ib_uint64_t) rw_lock_stats.rw_sx_spin_round_count,
179 (ib_uint64_t) rw_lock_stats.rw_sx_os_wait_count);
180
181 fprintf(file,
182 "Spin rounds per wait: %.2f RW-shared,"
183 " %.2f RW-excl, %.2f RW-sx\n",
184 (double) rw_lock_stats.rw_s_spin_round_count /
185 (rw_lock_stats.rw_s_spin_wait_count
186 ? rw_lock_stats.rw_s_spin_wait_count : 1),
187 (double) rw_lock_stats.rw_x_spin_round_count /
188 (rw_lock_stats.rw_x_spin_wait_count
189 ? rw_lock_stats.rw_x_spin_wait_count : 1),
190 (double) rw_lock_stats.rw_sx_spin_round_count /
191 (rw_lock_stats.rw_sx_spin_wait_count
192 ? rw_lock_stats.rw_sx_spin_wait_count : 1));
193 }
194
195 /**
196 Prints info of the sync system.
197 @param file - where to print */
198 void
sync_print(FILE * file)199 sync_print(FILE* file)
200 {
201 #ifdef UNIV_DEBUG
202 rw_lock_list_print_info(file);
203 #endif /* UNIV_DEBUG */
204
205 sync_array_print(file);
206
207 sync_print_wait_info(file);
208 }
209
210 /** Print the filename "basename" e.g., p = "/a/b/c/d/e.cc" -> p = "e.cc"
211 @param[in] filename Name from where to extract the basename
212 @return the basename */
213 const char*
sync_basename(const char * filename)214 sync_basename(const char* filename)
215 {
216 const char* ptr = filename + strlen(filename) - 1;
217
218 while (ptr > filename && *ptr != '/' && *ptr != '\\') {
219 --ptr;
220 }
221
222 ++ptr;
223
224 return(ptr);
225 }
226
227 /** String representation of the filename and line number where the
228 latch was created
229 @param[in] id Latch ID
230 @param[in] created Filename and line number where it was crated
231 @return the string representation */
232 std::string
sync_mutex_to_string(latch_id_t id,const std::string & created)233 sync_mutex_to_string(
234 latch_id_t id,
235 const std::string& created)
236 {
237 std::ostringstream msg;
238
239 msg << "Mutex " << sync_latch_get_name(id) << " "
240 << "created " << created;
241
242 return(msg.str());
243 }
244
245 /** Enable the mutex monitoring */
246 void
enable()247 MutexMonitor::enable()
248 {
249 /** Note: We don't add any latch meta-data after startup. Therefore
250 there is no need to use a mutex here. */
251
252 LatchMetaData::iterator end = latch_meta.end();
253
254 for (LatchMetaData::iterator it = latch_meta.begin(); it != end; ++it) {
255
256 if (*it != NULL) {
257 (*it)->get_counter()->enable();
258 }
259 }
260 }
261
262 /** Disable the mutex monitoring */
263 void
disable()264 MutexMonitor::disable()
265 {
266 /** Note: We don't add any latch meta-data after startup. Therefore
267 there is no need to use a mutex here. */
268
269 LatchMetaData::iterator end = latch_meta.end();
270
271 for (LatchMetaData::iterator it = latch_meta.begin(); it != end; ++it) {
272
273 if (*it != NULL) {
274 (*it)->get_counter()->disable();
275 }
276 }
277 }
278
279 /** Reset the mutex monitoring counters */
280 void
reset()281 MutexMonitor::reset()
282 {
283 /** Note: We don't add any latch meta-data after startup. Therefore
284 there is no need to use a mutex here. */
285
286 LatchMetaData::iterator end = latch_meta.end();
287
288 for (LatchMetaData::iterator it = latch_meta.begin(); it != end; ++it) {
289
290 if (*it != NULL) {
291 (*it)->get_counter()->reset();
292 }
293 }
294
295 mutex_enter(&rw_lock_list_mutex);
296
297 for (rw_lock_t* rw_lock = UT_LIST_GET_FIRST(rw_lock_list);
298 rw_lock != NULL;
299 rw_lock = UT_LIST_GET_NEXT(list, rw_lock)) {
300
301 rw_lock->count_os_wait = 0;
302 }
303
304 mutex_exit(&rw_lock_list_mutex);
305 }
306