1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
|
/* Copyright (C) 2010 Monty Program Ab
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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */
/*
mysql_upgrade_service upgrades mysql service on Windows.
It changes service definition to point to the new mysqld.exe, restarts the
server and runs mysql_upgrade
*/
#define DONT_DEFINE_VOID
#include <process.h>
#include <my_global.h>
#include <my_getopt.h>
#include <my_sys.h>
#include <m_string.h>
#include <mysql_version.h>
#include <winservice.h>
#include <stdlib.h>
#include <stdio.h>
#include <windows.h>
/* We're using version APIs */
#pragma comment(lib, "version")
#define USAGETEXT \
"mysql_upgrade_service.exe Ver 1.42 for Windows\n" \
"This software comes with ABSOLUTELY NO WARRANTY. This is free software,\n" \
"and you are welcome to modify and redistribute it under the GPL v2 license\n" \
"Usage: mysql_upgrade_service.exe [OPTIONS]\n" \
"OPTIONS:"
static char mysqld_path[MAX_PATH];
static char mysqladmin_path[MAX_PATH];
static char mysqlupgrade_path[MAX_PATH];
static char defaults_file_param[MAX_PATH + 16]; /*--defaults-file=<path> */
static char logfile_path[MAX_PATH];
static char *opt_service;
static SC_HANDLE service;
static SC_HANDLE scm;
HANDLE mysqld_process; // mysqld.exe started for upgrade
DWORD initial_service_state= -1; // initial state of the service
HANDLE logfile_handle;
/*
Startup and shutdown timeouts, in seconds.
Maybe,they can be made parameters
*/
static unsigned int startup_timeout= 60;
static unsigned int shutdown_timeout= 60;
static struct my_option my_long_options[]=
{
{"help", '?', "Display this help message and exit.", 0, 0, 0, GET_NO_ARG,
NO_ARG, 0, 0, 0, 0, 0, 0},
{"service", 's', "Name of the existing Windows service",
&opt_service, &opt_service, 0, GET_STR, REQUIRED_ARG, 0, 0, 0, 0, 0, 0},
};
static my_bool
get_one_option(int optid,
const struct my_option *opt __attribute__ ((unused)),
char *argument __attribute__ ((unused)))
{
DBUG_ENTER("get_one_option");
switch (optid) {
case '?':
printf("%s\n", USAGETEXT);
my_print_help(my_long_options);
exit(0);
break;
}
DBUG_RETURN(0);
}
static void log(const char *fmt, ...)
{
va_list args;
char buf[4096];
/* Print the error message */
va_start(args, fmt);
if (fmt)
{
vsprintf_s(buf, fmt, args);
fprintf(stdout, "%s\n", buf);
}
va_end(args);
my_end(0);
}
static void die(const char *fmt, ...)
{
va_list args;
DBUG_ENTER("die");
char buf[4096];
/* Print the error message */
va_start(args, fmt);
if (fmt)
{
fprintf(stderr, "FATAL ERROR: ");
int count= vsprintf_s(buf, fmt, args);
fprintf(stderr, "%s.", buf);
if(logfile_path[0])
{
fprintf(stderr, "Additional information can be found in the log file %s",
logfile_path);
}
}
va_end(args);
/* Cleanup */
if(service && initial_service_state != -1)
{
/* Stop service if it was not running */
if(initial_service_state != SERVICE_RUNNING)
{
SERVICE_STATUS service_status;
ControlService(service, SERVICE_CONTROL_STOP, &service_status);
}
CloseServiceHandle(service);
}
if(scm)
CloseServiceHandle(scm);
/* Stop mysqld.exe if it was started for upgrade */
if(mysqld_process)
TerminateProcess(mysqld_process, 3);
if(logfile_handle)
CloseHandle(logfile_handle);
my_end(0);
exit(1);
}
/*
spawn-like function to run subprocesses.
We also redirect the full output to the log file.
Typical usage could be something like
run_tool(P_NOWAIT, "cmd.exe", "/c" , "echo", "foo", NULL)
@param wait_flag (P_WAIT or P_NOWAIT)
@program program to run
Rest of the parameters is NULL terminated strings building command line.
@return intptr containing either process handle, if P_NOWAIT is used
or return code of the process (if P_WAIT is used)
*/
static intptr_t run_tool(int wait_flag, const char *program,...)
{
static char cmdline[32*1024];
va_list args;
va_start(args, program);
if(!program)
die("Invalid call to run_tool");
strcpy_s(cmdline, "\"");
strcat_s(cmdline, program);
strcat_s(cmdline, "\"");
for(;;)
{
char *param= va_arg(args,char *);
if(!param)
break;
strcat_s(cmdline, " \"");
strcat_s(cmdline, param);
strcat_s(cmdline, "\"");
}
va_end(args);
/* Create output file if not alredy done */
if(!logfile_handle)
{
char tmpdir[FN_REFLEN];
GetTempPath(FN_REFLEN, tmpdir);
sprintf_s(logfile_path, "%s\\mysql_upgrade_service.%s.log", tmpdir,
opt_service);
logfile_handle = CreateFile(logfile_path, GENERIC_WRITE, FILE_SHARE_READ,
NULL, TRUNCATE_EXISTING, 0, NULL);
if(!logfile_handle)
die("Cannot open log file %s", logfile_path);
}
/* Start child process */
STARTUPINFO si={0};
si.cb= sizeof(si);
si.hStdInput= GetStdHandle(STD_INPUT_HANDLE);
si.hStdError= logfile_handle;
si.hStdOutput= logfile_handle;
si.dwFlags= STARTF_USESTDHANDLES;
PROCESS_INFORMATION pi;
if (!CreateProcess(NULL, cmdline, NULL,
NULL, TRUE, NULL, NULL, NULL, &si, &pi))
{
die("CreateProcess failed (commandline %s)", cmdline);
}
CloseHandle(pi.hThread);
if(wait_flag == P_NOWAIT)
{
/* Do not wait for process to complete, return handle */
return (intptr_t)pi.hProcess;
}
/* Eait for process to complete */
if (WaitForSingleObject(pi.hProcess, INFINITE) != WAIT_OBJECT_0)
{
die("WaitForSingleObject() failed");
}
DWORD exit_code;
if (!GetExitCodeProcess(pi.hProcess, &exit_code))
{
die("GetExitCodeProcess() failed");
}
return (intptr_t)exit_code;
}
void stop_mysqld_service()
{
DWORD needed;
SERVICE_STATUS_PROCESS ssp;
int timeout= shutdown_timeout*1000;
for(;;)
{
if (!QueryServiceStatusEx(service, SC_STATUS_PROCESS_INFO,
(LPBYTE)&ssp,
sizeof(SERVICE_STATUS_PROCESS),
&needed))
{
die("QueryServiceStatusEx failed (%d)\n", GetLastError());
}
/*
Remeber initial state of the service, we will restore it on
exit.
*/
if(initial_service_state == -1)
initial_service_state =ssp.dwCurrentState;
switch(ssp.dwCurrentState)
{
case SERVICE_STOPPED:
return;
case SERVICE_RUNNING:
if(!ControlService(service, SERVICE_CONTROL_STOP,
(SERVICE_STATUS *)&ssp))
die("ControlService failed, error %d\n", GetLastError());
case SERVICE_START_PENDING:
case SERVICE_STOP_PENDING:
if(timeout < 0)
die("Service does not stop after 1 minute timeout");
Sleep(100);
break;
default:
die("Unexpected service state %d",ssp.dwCurrentState);
}
}
}
/* Helper routine. Used to prevent downgrades by mysql_upgrade_service */
void get_file_version(const wchar_t *path, int *major, int *minor)
{
*major= *minor=0;
DWORD version_handle;
char *ver= 0;
VS_FIXEDFILEINFO info;
UINT len;
void *p;
DWORD size = GetFileVersionInfoSizeW(path, &version_handle);
if (size == 0)
return;
ver = new char[size];
if(!GetFileVersionInfoW(path, version_handle, size, ver))
goto end;
if(!VerQueryValue(ver,"\\",&p,&len))
goto end;
memcpy(&info,p ,sizeof(VS_FIXEDFILEINFO));
*major = (info.dwFileVersionMS & 0xFFFF0000) >> 16;
*minor = (info.dwFileVersionMS & 0x0000FFFF);
end:
delete []ver;
}
/*
Shutdown mysql server. Not using mysqladmin, since
our --skip-grant-tables do not work anymore after mysql_upgrade
that does "flush privileges". Instead, the shutdown event is set.
*/
void initiate_mysqld_shutdown()
{
char event_name[32];
DWORD pid= GetProcessId(mysqld_process);
sprintf_s(event_name, "MySQLShutdown%d", pid);
HANDLE shutdown_handle= OpenEvent(EVENT_MODIFY_STATE, FALSE, event_name);
if(!shutdown_handle)
{
die("OpenEvent() failed for shutdown event");
}
if(!SetEvent(shutdown_handle))
{
die("SetEvent() failed");
}
}
/*
Change service configuration (binPath) to point to mysqld from
this installation.
*/
static void change_service_config()
{
char defaults_file[MAX_PATH];
char default_character_set[64];
scm = OpenSCManager(NULL, NULL, SC_MANAGER_ALL_ACCESS);
if(!scm)
die("OpenSCManager failed with %d", GetLastError());
service= OpenService(scm, opt_service, SERVICE_ALL_ACCESS);
if (!service)
die("OpenService failed with %d", GetLastError());
BYTE config_buffer[8*1024];
LPQUERY_SERVICE_CONFIGW config= (LPQUERY_SERVICE_CONFIGW)config_buffer;
DWORD size=sizeof(config_buffer);
DWORD needed;
if (!QueryServiceConfigW(service, config, size, &needed))
die("QueryServiceConfig failed with %d\n", GetLastError());
mysqld_service_properties props;
if (get_mysql_service_properties(config->lpBinaryPathName, &props))
{
die("Not a valid MySQL service");
}
int my_major= MYSQL_VERSION_ID/10000;
int my_minor= (MYSQL_VERSION_ID - 10000*my_major)/100;
if(my_major < props.version_major ||
(my_major == props.version_minor && my_minor < props.version_patch))
{
die("Can not downgrade, the service is currently running as version %d.%d"
", my version is %d.%d", props.version_major, props.version_minor,
my_major, my_minor);
}
if(props.inifile[0] == 0)
{
/*
Weird case, no --defaults-file in service definition, need to create one.
*/
char buf[MAX_PATH];
int i;
sprintf_s(props.inifile, MAX_PATH, "%s\\my.ini", props.datadir);
/*
Write datadir to my.ini, after converting backslashes to
unix style slashes.
*/
strcpy_s(buf, MAX_PATH, props.datadir);
for(i=0; buf[i]; i++)
{
if (buf[i] == '\\')
buf[i]= '/';
}
WritePrivateProfileString("mysqld", "datadir",buf, props.inifile);
}
/*
Remove basedir from defaults file, otherwise the service wont come up in
the new version, and will complain about mismatched message file.
*/
WritePrivateProfileString("mysqld", "basedir",NULL, props.inifile);
#ifdef _WIN64
/* Currently, pbxt is non-functional on x64 */
WritePrivateProfileString("mysqld", "loose-skip-pbxt","1", props.inifile);
#endif
/*
Replace default-character-set with character-set-server, to avoid
"default-character-set is deprecated and will be replaced ..."
message.
*/
default_character_set[0]=0;
GetPrivateProfileString("mysqld", "default-character-set", NULL,
default_character_set, sizeof(default_character_set), defaults_file);
if(default_character_set[0])
{
WritePrivateProfileString("mysqld", "default-character-set", NULL,
defaults_file);
WritePrivateProfileString("mysqld", "character-set-server",
default_character_set, defaults_file);
}
sprintf(defaults_file_param,"--defaults-file=%s", props.inifile);
char commandline[3*MAX_PATH + 19];
sprintf_s(commandline, "\"%s\" \"%s\" \"%s\"", mysqld_path,
defaults_file_param, opt_service);
if (!ChangeServiceConfig(service, SERVICE_NO_CHANGE, SERVICE_NO_CHANGE,
SERVICE_NO_CHANGE, commandline, NULL, NULL, NULL, NULL, NULL, NULL))
{
die("ChangeServiceConfigW failed with %d", GetLastError());
}
}
int main(int argc, char **argv)
{
int error;
MY_INIT(argv[0]);
char bindir[FN_REFLEN];
char *p;
/* Parse options */
if ((error= handle_options(&argc, &argv, my_long_options, get_one_option)))
die("");
if(!opt_service)
die("service parameter is mandatory");
/*
Get full path to mysqld, we need it when changing service configuration.
Assume installation layout, i.e mysqld.exe, mysqladmin.exe, mysqlupgrade.exe
and mysql_upgrade_service.exe are in the same directory.
*/
GetModuleFileName(NULL, bindir, FN_REFLEN);
p = strrchr(bindir, FN_LIBCHAR);
if(p)
{
*p=0;
}
sprintf_s(mysqld_path, "%s\\mysqld.exe", bindir);
sprintf_s(mysqladmin_path, "%s\\mysqladmin.exe", bindir);
sprintf_s(mysqlupgrade_path, "%s\\mysql_upgrade.exe", bindir);
char *paths[]= {mysqld_path, mysqladmin_path, mysqlupgrade_path};
for(int i=0; i< 3;i++)
{
if(GetFileAttributes(paths[i]) == INVALID_FILE_ATTRIBUTES)
die("File %s does not exist", paths[i]);
}
/*
Messages written on stdout should not be buffered, GUI upgrade program
read them from pipe and uses as progress indicator.
*/
setvbuf(stdout, NULL, _IONBF, 0);
log("Phase 1/8: Changing service configuration");
change_service_config();
log("Phase 2/8: Stopping service");
stop_mysqld_service();
/*
Start mysqld.exe as non-service skipping privileges (so we do not
care about the password). But disable networking and enable pipe
for communication, for security reasons.
*/
char socket_param[FN_REFLEN];
sprintf_s(socket_param,"--socket=mysql_upgrade_service_%d",
GetCurrentProcessId());
log("Phase 3/8: Starting mysqld for upgrade");
mysqld_process= (HANDLE)run_tool(P_NOWAIT, mysqld_path,
defaults_file_param, "--skip-networking", "--skip-grant-tables",
"--enable-named-pipe", socket_param, NULL);
if(mysqld_process == INVALID_HANDLE_VALUE)
{
die("Cannot start mysqld.exe process, errno=%d", errno);
}
log("Phase 4/8: Waiting for startup to complete");
DWORD start_duration_ms= 0;
for (int i=0; ; i++)
{
if (WaitForSingleObject(mysqld_process, 0) != WAIT_TIMEOUT)
die("mysqld.exe did not start");
if (run_tool(P_WAIT, mysqladmin_path, "--protocol=pipe",
socket_param, "ping", NULL) == 0)
{
break;
}
if (start_duration_ms > startup_timeout*1000)
die("Server did not come up in %d seconds",startup_timeout);
Sleep(500);
start_duration_ms+= 500;
}
log("Phase 5/8: Running mysql_upgrade");
int upgrade_err = (int) run_tool(P_WAIT, mysqlupgrade_path,
"--protocol=pipe", "--force", socket_param,
NULL);
log("Phase 6/8: Initiating server shutdown");
initiate_mysqld_shutdown();
log("Phase 7/8: Waiting for shutdown to complete");
if (WaitForSingleObject(mysqld_process, shutdown_timeout*1000)
!= WAIT_OBJECT_0)
{
/* Shutdown takes too long */
die("mysqld does not shutdown.");
}
CloseHandle(mysqld_process);
mysqld_process= NULL;
log("Phase 8/8: Starting service%s",
(initial_service_state == SERVICE_RUNNING)?"":" (skipped)");
if (initial_service_state == SERVICE_RUNNING)
{
StartService(service, NULL, NULL);
}
log("Service '%s' successfully upgraded.\nLog file is written to %s",
opt_service, logfile_path);
CloseServiceHandle(service);
CloseServiceHandle(scm);
if(logfile_handle)
CloseHandle(logfile_handle);
my_end(0);
exit(0);
}
|