jenkins-promote-staging-trunk-libmemcached-16
[awesomized/libmemcached] / libtest / server.cc
1 /* vim:expandtab:shiftwidth=2:tabstop=2:smarttab:
2 *
3 * Data Differential YATL (i.e. libtest) library
4 *
5 * Copyright (C) 2012 Data Differential, http://datadifferential.com/
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions are
9 * met:
10 *
11 * * Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 *
14 * * Redistributions in binary form must reproduce the above
15 * copyright notice, this list of conditions and the following disclaimer
16 * in the documentation and/or other materials provided with the
17 * distribution.
18 *
19 * * The names of its contributors may not be used to endorse or
20 * promote products derived from this software without specific prior
21 * written permission.
22 *
23 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
24 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
25 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
26 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
27 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
28 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
29 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
30 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
31 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
32 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
33 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34 *
35 */
36
37 #include <config.h>
38 #include <libtest/common.h>
39
40 #include <cassert>
41 #include <cerrno>
42 #include <climits>
43 #include <cstdlib>
44 #include <iostream>
45
46 #include <algorithm>
47 #include <functional>
48 #include <locale>
49 #include <unistd.h>
50
51 // trim from end
52 static inline std::string &rtrim(std::string &s)
53 {
54 s.erase(std::find_if(s.rbegin(), s.rend(), std::not1(std::ptr_fun<int, int>(std::isspace))).base(), s.end());
55 return s;
56 }
57
58 #include <libtest/server.h>
59 #include <libtest/stream.h>
60 #include <libtest/killpid.h>
61
62 namespace libtest {
63
64 std::ostream& operator<<(std::ostream& output, const Server &arg)
65 {
66 if (arg.is_socket())
67 {
68 output << arg.hostname();
69 }
70 else
71 {
72 output << arg.hostname() << ":" << arg.port();
73 }
74
75 if (arg.has_pid())
76 {
77 output << " Pid:" << arg.pid();
78 }
79
80 if (arg.has_socket())
81 {
82 output << " Socket:" << arg.socket();
83 }
84
85 if (arg.running().empty() == false)
86 {
87 output << " Exec:" << arg.running();
88 }
89
90 return output; // for multiple << operators
91 }
92
93 #define MAGIC_MEMORY 123570
94
95 Server::Server(const std::string& host_arg, const in_port_t port_arg,
96 const std::string& executable, const bool _is_libtool,
97 bool is_socket_arg) :
98 _magic(MAGIC_MEMORY),
99 _is_socket(is_socket_arg),
100 _port(port_arg),
101 _hostname(host_arg),
102 _app(executable, _is_libtool)
103 {
104 }
105
106 Server::~Server()
107 {
108 }
109
110 bool Server::check()
111 {
112 _app.slurp();
113 _app.check();
114 return true;
115 }
116
117 bool Server::validate()
118 {
119 return _magic == MAGIC_MEMORY;
120 }
121
122 // If the server exists, kill it
123 bool Server::cycle()
124 {
125 uint32_t limit= 3;
126
127 // Try to ping, and kill the server #limit number of times
128 while (--limit and
129 is_pid_valid(_app.pid()))
130 {
131 if (kill())
132 {
133 Log << "Killed existing server," << *this;
134 dream(0, 50000);
135 continue;
136 }
137 }
138
139 // For whatever reason we could not kill it, and we reached limit
140 if (limit == 0)
141 {
142 Error << "Reached limit, could not kill server";
143 return false;
144 }
145
146 return true;
147 }
148
149 bool Server::wait_for_pidfile() const
150 {
151 Wait wait(pid_file(), 4);
152
153 return wait.successful();
154 }
155
156 bool Server::has_pid() const
157 {
158 return (_app.pid() > 1);
159 }
160
161
162 bool Server::start()
163 {
164 // If we find that we already have a pid then kill it.
165 if (has_pid() == true)
166 {
167 #if 0
168 fatal_message("has_pid() failed, programer error");
169 #endif
170 }
171
172 // This needs more work.
173 #if 0
174 if (gdb_is_caller())
175 {
176 _app.use_gdb();
177 }
178 #endif
179
180 if (getenv("YATL_PTRCHECK_SERVER"))
181 {
182 _app.use_ptrcheck();
183 }
184 else if (getenv("YATL_VALGRIND_SERVER"))
185 {
186 _app.use_valgrind();
187 }
188
189 if (args(_app) == false)
190 {
191 Error << "Could not build command()";
192 return false;
193 }
194
195 Application::error_t ret;
196 if (Application::SUCCESS != (ret= _app.run()))
197 {
198 Error << "Application::run() " << ret;
199 return false;
200 }
201 _running= _app.print();
202
203 if (valgrind_is_caller())
204 {
205 dream(5, 50000);
206 }
207
208 size_t repeat= 5;
209 _app.slurp();
210 while (--repeat)
211 {
212 if (pid_file().empty() == false)
213 {
214 Wait wait(pid_file(), 8);
215
216 if (wait.successful() == false)
217 {
218 if (_app.check())
219 {
220 _app.slurp();
221 continue;
222 }
223
224 char buf[PATH_MAX];
225 char *getcwd_buf= getcwd(buf, sizeof(buf));
226 throw libtest::fatal(LIBYATL_DEFAULT_PARAM,
227 "Unable to open pidfile in %s for: %s stderr:%s",
228 getcwd_buf ? getcwd_buf : "",
229 _running.c_str(),
230 _app.stderr_c_str());
231 }
232 }
233 }
234
235 uint32_t this_wait= 0;
236 bool pinged= false;
237 {
238 uint32_t timeout= 20; // This number should be high enough for valgrind startup (which is slow)
239 uint32_t waited;
240 uint32_t retry;
241
242 for (waited= 0, retry= 1; ; retry++, waited+= this_wait)
243 {
244 if ((pinged= ping()) == true)
245 {
246 break;
247 }
248 else if (waited >= timeout)
249 {
250 break;
251 }
252
253 this_wait= retry * retry / 3 + 1;
254 libtest::dream(this_wait, 0);
255 }
256 }
257
258 if (pinged == false)
259 {
260 // If we happen to have a pid file, lets try to kill it
261 if ((pid_file().empty() == false) and (access(pid_file().c_str(), R_OK) == 0))
262 {
263 _app.slurp();
264 if (kill_file(pid_file()) == false)
265 {
266 throw libtest::fatal(LIBYATL_DEFAULT_PARAM,
267 "Failed to kill off server, waited: %u after startup occurred, when pinging failed: %.*s stderr:%.*s",
268 this_wait,
269 int(_running.size()), _running.c_str(),
270 int(_app.stderr_result_length()), _app.stderr_c_str());
271 }
272
273 throw libtest::fatal(LIBYATL_DEFAULT_PARAM,
274 "Failed native ping(), pid: %d is alive: %s waited: %u server started, having pid_file. exec: %.*s stderr:%.*s",
275 int(_app.pid()),
276 _app.check() ? "true" : "false",
277 this_wait,
278 int(_running.size()), _running.c_str(),
279 int(_app.stderr_result_length()), _app.stderr_c_str());
280 }
281 else
282 {
283 throw libtest::fatal(LIBYATL_DEFAULT_PARAM,
284 "Failed native ping(), pid: %d is alive: %s waited: %u server started. exec: %.*s stderr:%.*s",
285 int(_app.pid()),
286 _app.check() ? "true" : "false",
287 this_wait,
288 int(_running.size()), _running.c_str(),
289 int(_app.stderr_result_length()), _app.stderr_c_str());
290 }
291 _running.clear();
292 return false;
293 }
294
295 return has_pid();
296 }
297
298 void Server::reset_pid()
299 {
300 _running.clear();
301 _pid_file.clear();
302 }
303
304 pid_t Server::pid() const
305 {
306 return _app.pid();
307 }
308
309 void Server::add_option(const std::string& arg)
310 {
311 _options.push_back(std::make_pair(arg, std::string()));
312 }
313
314 void Server::add_option(const std::string& name, const std::string& value)
315 {
316 _options.push_back(std::make_pair(name, value));
317 }
318
319 bool Server::set_socket_file()
320 {
321 char file_buffer[FILENAME_MAX];
322 file_buffer[0]= 0;
323
324 if (broken_pid_file())
325 {
326 snprintf(file_buffer, sizeof(file_buffer), "/tmp/%s.socketXXXXXX", name());
327 }
328 else
329 {
330 snprintf(file_buffer, sizeof(file_buffer), "var/run/%s.socketXXXXXX", name());
331 }
332
333 int fd;
334 if ((fd= mkstemp(file_buffer)) == -1)
335 {
336 perror(file_buffer);
337 return false;
338 }
339 close(fd);
340 unlink(file_buffer);
341
342 _socket= file_buffer;
343
344 return true;
345 }
346
347 bool Server::set_pid_file()
348 {
349 char file_buffer[FILENAME_MAX];
350 file_buffer[0]= 0;
351
352 if (broken_pid_file())
353 {
354 snprintf(file_buffer, sizeof(file_buffer), "/tmp/%s.pidXXXXXX", name());
355 }
356 else
357 {
358 snprintf(file_buffer, sizeof(file_buffer), "var/run/%s.pidXXXXXX", name());
359 }
360
361 int fd;
362 if ((fd= mkstemp(file_buffer)) == -1)
363 {
364 throw libtest::fatal(LIBYATL_DEFAULT_PARAM, "mkstemp() failed on %s with %s", file_buffer, strerror(errno));
365 }
366 close(fd);
367 unlink(file_buffer);
368
369 _pid_file= file_buffer;
370
371 return true;
372 }
373
374 bool Server::set_log_file()
375 {
376 char file_buffer[FILENAME_MAX];
377 file_buffer[0]= 0;
378
379 snprintf(file_buffer, sizeof(file_buffer), "var/log/%s.logXXXXXX", name());
380 int fd;
381 if ((fd= mkstemp(file_buffer)) == -1)
382 {
383 throw libtest::fatal(LIBYATL_DEFAULT_PARAM, "mkstemp() failed on %s with %s", file_buffer, strerror(errno));
384 }
385 close(fd);
386
387 _log_file= file_buffer;
388
389 return true;
390 }
391
392 bool Server::args(Application& app)
393 {
394
395 // Set a log file if it was requested (and we can)
396 if (has_log_file_option())
397 {
398 set_log_file();
399 log_file_option(app, _log_file);
400 }
401
402 if (getenv("LIBTEST_SYSLOG") and has_syslog())
403 {
404 app.add_option("--syslog");
405 }
406
407 // Update pid_file
408 {
409 if (_pid_file.empty() and set_pid_file() == false)
410 {
411 return false;
412 }
413
414 pid_file_option(app, pid_file());
415 }
416
417 if (has_socket_file_option())
418 {
419 if (set_socket_file() == false)
420 {
421 return false;
422 }
423
424 socket_file_option(app, _socket);
425 }
426
427 if (has_port_option())
428 {
429 port_option(app, _port);
430 }
431
432 for (Options::const_iterator iter= _options.begin(); iter != _options.end(); iter++)
433 {
434 if ((*iter).second.empty() == false)
435 {
436 app.add_option((*iter).first, (*iter).second);
437 }
438 else
439 {
440 app.add_option((*iter).first);
441 }
442 }
443
444 return true;
445 }
446
447 bool Server::kill()
448 {
449 if (check_pid(_app.pid())) // If we kill it, reset
450 {
451 _app.murder();
452 if (broken_pid_file() and pid_file().empty() == false)
453 {
454 unlink(pid_file().c_str());
455 }
456
457 if (broken_socket_cleanup() and has_socket() and not socket().empty())
458 {
459 unlink(socket().c_str());
460 }
461
462 reset_pid();
463
464 return true;
465 }
466
467 return false;
468 }
469
470 } // namespace libtest