Skip to content

Commit 682bc7d

Browse files
phulakunphulakun
committed
WL11678 - Logging services: Add unique error-ids to the messages logged using error_log_printf()
Following methods logs their error message by using hook error_log_printf(), *) my_message_local *) my_getopt_error_reporter *) my_charset_error_reporter *) Query_log_table_intact::report_error *) Component_db_intact::report_error *) sql_plugin.cc: report_error() All the error messages logged with these methods get the same error ID "ER_LOG_PRINTF_MSG". As part of this WL, changes are made to log those error messages with the unique error ID. Error messages are added to errmsg-utf8.txt for the messages logged using Query_log_table_intact::report_error(), Component_db_intact::report_error() and sql_plugin.cc:report_error(). Logging API is used to log error messages with the error IDs. my_message_local, my_getopt_error_reporter, my_charset_error_reporter are part of the mysys library. mysys library is used by the MySQL server and clients. Error messages and their ids should be available to both client and server. Hence these error messages are added to the global error messages list. In MySQL server, these methods are logged using the Logging APIs. This patch also replaces of some the sql_print_error() usage with the new logging APIs. Change-Id: I067db339f7c27615a840c7442be557f2c24efe9f
1 parent e2eb4ef commit 682bc7d

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

59 files changed

+520
-323
lines changed

‎components/mysql_server/log_builtins.cc

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@ Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA */
3434
// connection_events_loop_aborted()
3535

3636
#include "my_dir.h"
37+
#include "mysys_err.h"
3738

3839
#include <mysql/components/services/log_service.h>
3940
#include <mysql/components/services/log_shared.h> // data types
@@ -1538,7 +1539,8 @@ int log_line_submit(log_line *ll) {
15381539

15391540
#if !defined(DBUG_OFF)
15401541
/*
1541-
Assert that we're not given anything but server error-log codes.
1542+
Assert that we're not given anything but server error-log codes
1543+
or global error codes (shared between MySQL server and clients).
15421544
If your code bombs out here, check whether you're trying to log
15431545
using an error-code in the range intended for messages that are
15441546
sent to the client, not the error-log, (< ER_SERVER_RANGE_START).
@@ -1547,7 +1549,8 @@ int log_line_submit(log_line *ll) {
15471549
int n = log_line_index_by_type(ll, LOG_ITEM_SQL_ERRCODE);
15481550
if (n >= 0) {
15491551
int ec = (int)ll->item[n].data.data_integer;
1550-
DBUG_ASSERT((ec < 1) || (ec >= ER_SERVER_RANGE_START));
1552+
DBUG_ASSERT((ec < 1) || (ec >= EE_ERROR_FIRST && ec <= EE_ERROR_LAST) ||
1553+
(ec >= ER_SERVER_RANGE_START));
15511554
}
15521555
}
15531556
#endif

‎include/m_ctype.h

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -170,13 +170,13 @@ typedef struct CHARSET_INFO CHARSET_INFO;
170170
extern MYSQL_PLUGIN_IMPORT CHARSET_INFO *system_charset_info;
171171

172172
typedef struct MY_CHARSET_LOADER {
173-
char error[192];
173+
uint errcode;
174+
char errarg[192];
174175
void *(*once_alloc)(size_t);
175176
void *(*mem_malloc)(size_t);
176177
void *(*mem_realloc)(void *, size_t);
177178
void (*mem_free)(void *);
178-
void (*reporter)(enum loglevel, const char *format, ...)
179-
MY_ATTRIBUTE((format(printf, 2, 3)));
179+
void (*reporter)(enum loglevel, uint errcode, ...);
180180
int (*add_collation)(CHARSET_INFO *cs);
181181
} MY_CHARSET_LOADER;
182182

‎include/my_sys.h

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -222,8 +222,7 @@ extern const char *my_progname; /* program-name (printed in errors) */
222222
extern void (*error_handler_hook)(uint my_err, const char *str, myf MyFlags);
223223
extern void (*fatal_error_handler_hook)(uint my_err, const char *str,
224224
myf MyFlags);
225-
extern void (*local_message_hook)(enum loglevel ll, const char *format,
226-
va_list args);
225+
extern void (*local_message_hook)(enum loglevel ll, uint ecode, va_list args);
227226
extern uint my_file_limit;
228227
extern MYSQL_PLUGIN_IMPORT ulong my_thread_stack_size;
229228

@@ -487,8 +486,7 @@ struct ST_FILE_ID {
487486
ino_t st_ino;
488487
};
489488

490-
typedef void (*my_error_reporter)(enum loglevel level, const char *format, ...)
491-
MY_ATTRIBUTE((format(printf, 2, 3)));
489+
typedef void (*my_error_reporter)(enum loglevel level, uint ecode, ...);
492490

493491
extern my_error_reporter my_charset_error_reporter;
494492

@@ -673,9 +671,8 @@ extern int my_error_register(const char *(*get_errmsg)(int), int first,
673671
extern bool my_error_unregister(int first, int last);
674672
extern void my_message(uint my_err, const char *str, myf MyFlags);
675673
extern void my_message_stderr(uint my_err, const char *str, myf MyFlags);
676-
void my_message_local_stderr(enum loglevel ll, const char *format, va_list args)
677-
MY_ATTRIBUTE((format(printf, 2, 0)));
678-
extern void my_message_local(enum loglevel ll, const char *format, ...);
674+
void my_message_local_stderr(enum loglevel, uint ecode, va_list args);
675+
extern void my_message_local(enum loglevel ll, uint ecode, ...);
679676
extern bool my_init(void);
680677
extern void my_end(int infoflag);
681678
extern char *my_filename(File fd);

‎include/mysql/components/services/log_builtins.h

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1207,6 +1207,23 @@ class LogEvent {
12071207
return *this;
12081208
}
12091209

1210+
/**
1211+
Find an error message by its MySQL error code. Substitute the % in that
1212+
message with the given arguments list, then add the result as the event's
1213+
message.
1214+
1215+
@param errcode MySQL error code for the message in question,
1216+
e.g. ER_STARTUP
1217+
@param args varargs to satisfy any % in the message
1218+
1219+
@retval the LogEvent, for easy fluent-style chaining.
1220+
*/
1221+
LogEvent &lookupv(longlong errcode, va_list args) {
1222+
set_message_by_errcode(errcode, args);
1223+
1224+
return *this;
1225+
}
1226+
12101227
LogEvent &lookup_quoted(longlong errcode, const char *tag, ...) {
12111228
msg_tag = tag;
12121229

‎include/mysys_err.h

Lines changed: 58 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
/* Copyright (c) 2000, 2017, Oracle and/or its affiliates. All rights reserved.
1+
/* Copyright (c) 2000, 2018, Oracle and/or its affiliates. All rights reserved.
22
33
This program is free software; you can redistribute it and/or modify
44
it under the terms of the GNU General Public License, version 2.0,
@@ -76,7 +76,63 @@ extern const char *globerrs[]; /* my_error_messages is here */
7676
#define EE_CHANGE_PERMISSIONS 32
7777
#define EE_CANT_SEEK 33
7878
#define EE_CAPACITY_EXCEEDED 34
79-
#define EE_ERROR_LAST 34 /* Copy last error nr */
79+
#define EE_DISK_FULL_WITH_RETRY_MSG 35
80+
#define EE_FAILED_TO_CREATE_TIMER 36
81+
#define EE_FAILED_TO_DELETE_TIMER 37
82+
#define EE_FAILED_TO_CREATE_TIMER_QUEUE 38
83+
#define EE_FAILED_TO_START_TIMER_NOTIFY_THREAD 39
84+
#define EE_FAILED_TO_CREATE_TIMER_NOTIFY_THREAD_INTERRUPT_EVENT 40
85+
#define EE_EXITING_TIMER_NOTIFY_THREAD 41
86+
#define EE_WIN_LIBRARY_LOAD_FAILED 42
87+
#define EE_WIN_RUN_TIME_ERROR_CHECK 43
88+
#define EE_FAILED_TO_DETERMINE_LARGE_PAGE_SIZE 44
89+
#define EE_FAILED_TO_KILL_ALL_THREADS 45
90+
#define EE_FAILED_TO_CREATE_IO_COMPLETION_PORT 46
91+
#define EE_FAILED_TO_OPEN_DEFAULTS_FILE 47
92+
#define EE_FAILED_TO_HANDLE_DEFAULTS_FILE 48
93+
#define EE_WRONG_DIRECTIVE_IN_CONFIG_FILE 49
94+
#define EE_SKIPPING_DIRECTIVE_DUE_TO_MAX_INCLUDE_RECURSION 50
95+
#define EE_INCORRECT_GRP_DEFINITION_IN_CONFIG_FILE 51
96+
#define EE_OPTION_WITHOUT_GRP_IN_CONFIG_FILE 52
97+
#define EE_CONFIG_FILE_PERMISSION_ERROR 53
98+
#define EE_IGNORE_WORLD_WRITABLE_CONFIG_FILE 54
99+
#define EE_USING_DISABLED_OPTION 55
100+
#define EE_USING_DISABLED_SHORT_OPTION 56
101+
#define EE_USING_PASSWORD_ON_CLI_IS_INSECURE 57
102+
#define EE_UNKNOWN_SUFFIX_FOR_VARIABLE 58
103+
#define EE_SSL_ERROR_FROM_FILE 59
104+
#define EE_SSL_ERROR 60
105+
#define EE_NET_SEND_ERROR_IN_BOOTSTRAP 61
106+
#define EE_PACKETS_OUT_OF_ORDER 62
107+
#define EE_UNKNOWN_PROTOCOL_OPTION 63
108+
#define EE_FAILED_TO_LOCATE_SERVER_PUBLIC_KEY 64
109+
#define EE_PUBLIC_KEY_NOT_IN_PEM_FORMAT 65
110+
#define EE_DEBUG_INFO 66
111+
#define EE_UNKNOWN_VARIABLE 67
112+
#define EE_UNKNOWN_OPTION 68
113+
#define EE_UNKNOWN_SHORT_OPTION 69
114+
#define EE_OPTION_WITHOUT_ARGUMENT 70
115+
#define EE_OPTION_REQUIRES_ARGUMENT 71
116+
#define EE_SHORT_OPTION_REQUIRES_ARGUMENT 72
117+
#define EE_OPTION_IGNORED_DUE_TO_INVALID_VALUE 73
118+
#define EE_OPTION_WITH_EMPTY_VALUE 74
119+
#define EE_FAILED_TO_ASSIGN_MAX_VALUE_TO_OPTION 75
120+
#define EE_INCORRECT_BOOLEAN_VALUE_FOR_OPTION 76
121+
#define EE_FAILED_TO_SET_OPTION_VALUE 77
122+
#define EE_INCORRECT_INT_VALUE_FOR_OPTION 78
123+
#define EE_INCORRECT_UINT_VALUE_FOR_OPTION 79
124+
#define EE_ADJUSTED_SIGNED_VALUE_FOR_OPTION 80
125+
#define EE_ADJUSTED_UNSIGNED_VALUE_FOR_OPTION 81
126+
#define EE_ADJUSTED_ULONGLONG_VALUE_FOR_OPTION 82
127+
#define EE_ADJUSTED_DOUBLE_VALUE_FOR_OPTION 83
128+
#define EE_INVALID_DECIMAL_VALUE_FOR_OPTION 84
129+
#define EE_COLLATION_PARSER_ERROR 85
130+
#define EE_FAILED_TO_RESET_BEFORE_PRIMARY_IGNORABLE_CHAR 86
131+
#define EE_FAILED_TO_RESET_BEFORE_TERTIARY_IGNORABLE_CHAR 87
132+
#define EE_SHIFT_CHAR_OUT_OF_RANGE 88
133+
#define EE_RESET_CHAR_OUT_OF_RANGE 89
134+
#define EE_UNKNOWN_LDML_TAG 90
135+
#define EE_ERROR_LAST 90 /* Copy last error nr */
80136
/* Add error numbers before EE_ERROR_LAST and change it accordingly. */
81137

82138
/* Exit codes for option processing. When exiting from server use the

‎mysql-test/r/ctype_ldml.result

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -889,7 +889,7 @@ SHOW WARNINGS;
889889
Level Code Message
890890
Warning 3719 'utf8' is currently an alias for the character set UTF8MB3, which will be replaced by UTF8MB4 in a future release. Please consider using UTF8MB4 in order to be unambiguous.
891891
Error 1273 Unknown collation: 'utf8_5624_2'
892-
Warning 1273 Syntax error at '[strength tertiary]' for COLLATION : utf8_5624_2
892+
Warning 1273 Syntax error at '[strength tertiary]' for COLLATION : utf8_5624_2.
893893
#
894894
# WL#5624, reset before primary ignorable
895895
#
@@ -899,7 +899,7 @@ SHOW WARNINGS;
899899
Level Code Message
900900
Warning 3719 'utf8' is currently an alias for the character set UTF8MB3, which will be replaced by UTF8MB4 in a future release. Please consider using UTF8MB4 in order to be unambiguous.
901901
Error 1273 Unknown collation: 'utf8_5624_3'
902-
Warning 1273 Can't reset before a primary ignorable character U+A48C
902+
Warning 1273 Failed to reset before a primary ignorable character U+A48C.
903903
#
904904
# WL#5624, \u without hex digits is equal to {'\', 'u'}
905905
#

‎mysql-test/r/mysql.result

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -520,8 +520,8 @@ ERROR 1243 (HY000) at line 15: Unknown prepared statement handler (x) given to E
520520
#
521521
# Bug #16102788: INDETERMINATE BEHAVIOR DUE TO EMPTY OPTION VALUES
522522
#
523-
mysql: [ERROR] mysql: Empty value for 'port' specified
524-
mysql: [ERROR] mysql: Empty value for 'port' specified
523+
mysql: [ERROR] mysql: Empty value for 'port' specified.
524+
mysql: [ERROR] mysql: Empty value for 'port' specified.
525525
#
526526
# Bug #21464621: MYSQL CLI SHOULD SUGGEST CONNECT-EXPIRED-PASSWORD WHEN ERROR 1862 OCCURS
527527
#

‎mysql-test/r/mysql_upgrade_options.result

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -193,7 +193,7 @@ mtr.global_suppressions OK
193193
mtr.test_suppressions OK
194194
sys.sys_config OK
195195
# Running mysql_upgrade with --max-allowed-packet=4095..
196-
mysql_upgrade: [Warning] option 'max_allowed_packet': unsigned value 4095 adjusted to 4096
196+
mysql_upgrade: [Warning] option 'max_allowed_packet': unsigned value 4095 adjusted to 4096.
197197
mysql.columns_priv OK
198198
mysql.component OK
199199
mysql.db OK
@@ -231,7 +231,7 @@ mtr.global_suppressions OK
231231
mtr.test_suppressions OK
232232
sys.sys_config OK
233233
# Running mysql_upgrade with --max-allowed-packet=1000..
234-
mysql_upgrade: [Warning] option 'max_allowed_packet': unsigned value 1000 adjusted to 4096
234+
mysql_upgrade: [Warning] option 'max_allowed_packet': unsigned value 1000 adjusted to 4096.
235235
mysql.columns_priv OK
236236
mysql.component OK
237237
mysql.db OK
@@ -269,7 +269,7 @@ mtr.global_suppressions OK
269269
mtr.test_suppressions OK
270270
sys.sys_config OK
271271
# Running mysql_upgrade with --max-allowed-packet=2147483649..
272-
mysql_upgrade: [Warning] option 'max_allowed_packet': unsigned value 2147483649 adjusted to 2147483648
272+
mysql_upgrade: [Warning] option 'max_allowed_packet': unsigned value 2147483649 adjusted to 2147483648.
273273
mysql.columns_priv OK
274274
mysql.component OK
275275
mysql.db OK
@@ -307,7 +307,7 @@ mtr.global_suppressions OK
307307
mtr.test_suppressions OK
308308
sys.sys_config OK
309309
# Running mysql_upgrade with --max-allowed-packet=21474836480..
310-
mysql_upgrade: [Warning] option 'max_allowed_packet': unsigned value 2147484652 adjusted to 2147483648
310+
mysql_upgrade: [Warning] option 'max_allowed_packet': unsigned value 2147484652 adjusted to 2147483648.
311311
mysql.columns_priv OK
312312
mysql.component OK
313313
mysql.db OK
@@ -419,7 +419,7 @@ mtr.global_suppressions OK
419419
mtr.test_suppressions OK
420420
sys.sys_config OK
421421
# Running mysql_upgrade with --net-buffer-length=4095..
422-
mysql_upgrade: [Warning] option 'net_buffer_length': unsigned value 4095 adjusted to 4096
422+
mysql_upgrade: [Warning] option 'net_buffer_length': unsigned value 4095 adjusted to 4096.
423423
mysql.columns_priv OK
424424
mysql.component OK
425425
mysql.db OK
@@ -457,7 +457,7 @@ mtr.global_suppressions OK
457457
mtr.test_suppressions OK
458458
sys.sys_config OK
459459
# Running mysql_upgrade with --net-buffer-length=1024..
460-
mysql_upgrade: [Warning] option 'net_buffer_length': unsigned value 1024 adjusted to 4096
460+
mysql_upgrade: [Warning] option 'net_buffer_length': unsigned value 1024 adjusted to 4096.
461461
mysql.columns_priv OK
462462
mysql.component OK
463463
mysql.db OK
@@ -495,7 +495,7 @@ mtr.global_suppressions OK
495495
mtr.test_suppressions OK
496496
sys.sys_config OK
497497
# Running mysql_upgrade with --net-buffer-length=16777217..
498-
mysql_upgrade: [Warning] option 'net_buffer_length': unsigned value 16777217 adjusted to 16777216
498+
mysql_upgrade: [Warning] option 'net_buffer_length': unsigned value 16777217 adjusted to 16777216.
499499
mysql.columns_priv OK
500500
mysql.component OK
501501
mysql.db OK
@@ -533,7 +533,7 @@ mtr.global_suppressions OK
533533
mtr.test_suppressions OK
534534
sys.sys_config OK
535535
# Running mysql_upgrade with --net-buffer-length=167772160..
536-
mysql_upgrade: [Warning] option 'net_buffer_length': unsigned value 167772160 adjusted to 16777216
536+
mysql_upgrade: [Warning] option 'net_buffer_length': unsigned value 167772160 adjusted to 16777216.
537537
mysql.columns_priv OK
538538
mysql.component OK
539539
mysql.db OK
@@ -805,15 +805,15 @@ sys.sys_config OK
805805
# from mysql_upgrade
806806
#
807807
Run mysql_upgrade with --datadir : should fail
808-
mysql_upgrade: [ERROR] unknown variable 'datadir=somedir'
808+
mysql_upgrade: [ERROR] unknown variable 'datadir=somedir'.
809809
Upgrade process encountered error and will not continue.
810810
Run mysql_upgrade with --basedir : should fail
811-
mysql_upgrade: [ERROR] unknown variable 'basedir=somedir'
811+
mysql_upgrade: [ERROR] unknown variable 'basedir=somedir'.
812812
Upgrade process encountered error and will not continue.
813813
# Running mysql_upgrade with invalid/incorrect options
814-
mysql_upgrade: [ERROR] mysql_upgrade: unknown option '-c'
814+
mysql_upgrade: [ERROR] mysql_upgrade: unknown option '-c'.
815815
Upgrade process encountered error and will not continue.
816-
mysql_upgrade: [ERROR] mysql_upgrade: unknown option '-t'
816+
mysql_upgrade: [ERROR] mysql_upgrade: unknown option '-t'.
817817
Upgrade process encountered error and will not continue.
818818
Unknown option to protocol: AAA
819819
Alternatives are: 'TCP','SOCKET','PIPE','MEMORY'

‎mysql-test/r/mysqladmin.result

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
mysqladmin: [Warning] Using a password on the command line interface can be insecure.
22
mysqld is alive
3-
mysqladmin: [ERROR] unknown variable 'database=db1'
4-
mysqladmin: [Warning] unknown variable 'loose-database=db2'
3+
mysqladmin: [ERROR] unknown variable 'database=db1'.
4+
mysqladmin: [Warning] unknown variable 'loose-database=db2'.
55
mysqladmin: [Warning] Using a password on the command line interface can be insecure.
66
mysqld is alive
77
mysqld is alive

‎mysql-test/r/mysqld--defaults-file.result

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
mysqld: [ERROR] Could not open required defaults file: /path/with/no/extension
1+
mysqld: [ERROR] Failed to open required defaults file: /path/with/no/extension
22
mysqld: [ERROR] Fatal error in defaults handling. Program aborted!
3-
mysqld: [ERROR] Could not open required defaults file: /path/with.ext
3+
mysqld: [ERROR] Failed to open required defaults file: /path/with.ext
44
mysqld: [ERROR] Fatal error in defaults handling. Program aborted!
5-
mysqld: [ERROR] Could not open required defaults file: MYSQL_TEST_DIR/relative/path/with.ext
5+
mysqld: [ERROR] Failed to open required defaults file: MYSQL_TEST_DIR/relative/path/with.ext
66
mysqld: [ERROR] Fatal error in defaults handling. Program aborted!
7-
mysqld: [ERROR] Could not open required defaults file: MYSQL_TEST_DIR/relative/path/without/extension
7+
mysqld: [ERROR] Failed to open required defaults file: MYSQL_TEST_DIR/relative/path/without/extension
88
mysqld: [ERROR] Fatal error in defaults handling. Program aborted!
9-
mysqld: [ERROR] Could not open required defaults file: MYSQL_TEST_DIR/with.ext
9+
mysqld: [ERROR] Failed to open required defaults file: MYSQL_TEST_DIR/with.ext
1010
mysqld: [ERROR] Fatal error in defaults handling. Program aborted!
11-
mysqld: [ERROR] Could not open required defaults file: MYSQL_TEST_DIR/no_extension
11+
mysqld: [ERROR] Failed to open required defaults file: MYSQL_TEST_DIR/no_extension
1212
mysqld: [ERROR] Fatal error in defaults handling. Program aborted!

0 commit comments

Comments
 (0)