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