git.m6w6.name Git - awesomized/libmemcached/blob - 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 "libtest/yatlcon.h"
  38
  39 #include <libtest/common.h>
  40
  41 #include <cassert>
  42 #include <cerrno>
  43 #include <climits>
  44 #include <cstdlib>
  45 #include <iostream>
  46
  47 #include <algorithm>
  48 #include <functional>
  49 #include <locale>
  50 #include <unistd.h>
  51
  52 // trim from end
  53 static inline std::string &rtrim(std::string &s)
  54 {
  55   s.erase(std::find_if(s.rbegin(), s.rend(), std::not1(std::ptr_fun<int, int>(std::isspace))).base(), s.end());
  56   return s;
  57 }
  58
  59 #include <libtest/server.h>
  60 #include <libtest/stream.h>
  61 #include <libtest/killpid.h>
  62
  63 namespace libtest {
  64
  65 std::ostream& operator<<(std::ostream& output, const Server &arg)
  66 {
  67   if (arg.is_socket())
  68   {
  69     output << arg.hostname();
  70   }
  71   else
  72   {
  73     output << arg.hostname() << ":" << arg.port();
  74   }
  75
  76   if (arg.has_pid())
  77   {
  78     output << " Pid:" <<  arg.pid();
  79   }
  80
  81   if (arg.has_socket())
  82   {
  83     output << " Socket:" <<  arg.socket();
  84   }
  85
  86   if (arg.running().empty() == false)
  87   {
  88     output << " Exec:" <<  arg.running();
  89   }
  90
  91   return output;  // for multiple << operators
  92 }
  93
  94 #ifdef __GLIBC__
  95 namespace {
  96
  97 class Buffer
  98 {
  99 public:
 100   Buffer(char *b) : b_(b) {}
 101    ~Buffer() { if (b_) free(b_); }
 102   char* buf() { return b_; }
 103 private:
 104   char *b_;
 105 };
 106
 107 }
 108 #endif // __GLIBC__
 109
 110 #define MAGIC_MEMORY 123570
 111
 112 Server::Server(const std::string& host_arg, const in_port_t port_arg,
 113                const std::string& executable, const bool _is_libtool,
 114                bool is_socket_arg) :
 115   _magic(MAGIC_MEMORY),
 116   _is_socket(is_socket_arg),
 117   _port(port_arg),
 118   _hostname(host_arg),
 119   _app(executable, _is_libtool),
 120   out_of_ban_killed_(false),
 121   _timeout(40)
 122 {
 123 }
 124
 125 Server::~Server()
 126 {
 127   kill();
 128 }
 129
 130 bool Server::check()
 131 {
 132   _app.slurp();
 133   _app.check();
 134   return true;
 135 }
 136
 137 bool Server::validate()
 138 {
 139   return _magic == MAGIC_MEMORY;
 140 }
 141
 142 // If the server exists, kill it
 143 bool Server::cycle()
 144 {
 145   uint32_t limit= 3;
 146
 147   // Try to ping, and kill the server #limit number of times
 148   while (--limit and
 149          is_pid_valid(_app.pid()))
 150   {
 151     if (kill())
 152     {
 153       Log << "Killed existing server," << *this;
 154       dream(0, 50000);
 155       continue;
 156     }
 157   }
 158
 159   // For whatever reason we could not kill it, and we reached limit
 160   if (limit == 0)
 161   {
 162     Error << "Reached limit, could not kill server";
 163     return false;
 164   }
 165
 166   return true;
 167 }
 168
 169 bool Server::wait_for_pidfile() const
 170 {
 171   Wait wait(pid_file(), 4);
 172
 173   return wait.successful();
 174 }
 175
 176 bool Server::has_pid() const
 177 {
 178   return (_app.pid() > 1);
 179 }
 180
 181
 182 bool Server::start()
 183 {
 184   // If we find that we already have a pid then kill it.
 185   if (has_pid() == true)
 186   {
 187 #if 0
 188     fatal_message("has_pid() failed, programer error");
 189 #endif
 190   }
 191
 192   if (getenv("YATL_GDB_SERVER"))
 193   {
 194     _app.use_gdb(true);
 195   }
 196
 197   if (port() == LIBTEST_FAIL_PORT)
 198   {
 199     throw libtest::disconnected(LIBYATL_DEFAULT_PARAM,
 200                                 hostname(), port(), "Called failure");
 201   }
 202
 203   if (getenv("YATL_PTRCHECK_SERVER"))
 204   {
 205     _app.use_ptrcheck(true);
 206   }
 207   else if (getenv("YATL_VALGRIND_SERVER"))
 208   {
 209     _app.use_valgrind(true);
 210   }
 211
 212   out_of_ban_killed(false);
 213   if (args(_app) == false)
 214   {
 215     throw libtest::disconnected(LIBYATL_DEFAULT_PARAM,
 216                                 hostname(), port(), "Could not build command()");
 217   }
 218
 219   libtest::release_port(_port);
 220
 221   Application::error_t ret;
 222   if (Application::SUCCESS !=  (ret= _app.run()))
 223   {
 224     throw libtest::disconnected(LIBYATL_DEFAULT_PARAM,
 225                                 hostname(), port(), "Application::run() %s", libtest::Application::toString(ret));
 226     return false;
 227   }
 228   _running= _app.print();
 229
 230   if (valgrind_is_caller())
 231   {
 232     dream(5, 50000);
 233   }
 234
 235   size_t repeat= 5;
 236   _app.slurp();
 237   while (--repeat)
 238   {
 239     if (pid_file().empty() == false)
 240     {
 241       Wait wait(pid_file(), 8);
 242
 243       if (wait.successful() == false)
 244       {
 245         if (_app.check())
 246         {
 247           _app.slurp();
 248           continue;
 249         }
 250
 251 #ifdef __GLIBC__
 252         Buffer buf( get_current_dir_name());
 253         char *getcwd_buf= buf.buf();
 254 #else
 255         libtest::vchar_t buf;
 256         buf.resize(PATH_MAX);
 257         char *getcwd_buf= getcwd(&buf[0], buf.size());
 258 #endif // __GLIBC__
 259         throw libtest::disconnected(LIBYATL_DEFAULT_PARAM,
 260                                     hostname(), port(),
 261                                     "Unable to open pidfile in %s for: %s stderr:%s",
 262                                     getcwd_buf ? getcwd_buf : "",
 263                                     _running.c_str(),
 264                                     _app.stderr_c_str());
 265       }
 266     }
 267   }
 268
 269   bool pinged= false;
 270   uint32_t this_wait= 0;
 271   {
 272     uint32_t waited;
 273     uint32_t retry;
 274
 275     for (waited= 0, retry= 1; ; retry++, waited+= this_wait)
 276     {
 277       if (_app.check() == false)
 278       {
 279         break;
 280       }
 281
 282       if ((pinged= ping()) == true)
 283       {
 284         break;
 285       }
 286       else if (waited >= _timeout)
 287       {
 288         break;
 289       }
 290
 291       this_wait= retry * retry / 3 + 1;
 292       libtest::dream(this_wait, 0);
 293     }
 294   }
 295
 296   if (pinged == false)
 297   {
 298 #if 0
 299     Error << "Failed to ping(" << _app.pid() << ") wait: " << this_wait << " " << hostname() << ":" << port() << " run:" << _running << " " << error();
 300 #endif
 301
 302     // If we happen to have a pid file, lets try to kill it
 303     if ((pid_file().empty() == false) and (access(pid_file().c_str(), R_OK) == 0))
 304     {
 305       _app.slurp();
 306       if (kill_file(pid_file()) == false)
 307       {
 308         throw libtest::disconnected(LIBYATL_DEFAULT_PARAM,
 309                                     hostname(), port(),
 310                                     "Failed to kill off server, waited: %u after startup occurred, when pinging failed: %.*s stderr:%.*s",
 311                                     this_wait,
 312                                     int(_running.size()), _running.c_str(),
 313                                     int(_app.stderr_result_length()), _app.stderr_c_str());
 314       }
 315       else
 316       {
 317         throw libtest::disconnected(LIBYATL_DEFAULT_PARAM,
 318                                     hostname(), port(),
 319                                     "Failed native ping(), pid: %d was alive: %s waited: %u server started, having pid_file. exec: %.*s stderr:%.*s",
 320                                     int(_app.pid()),
 321                                     _app.check() ? "true" : "false",
 322                                     this_wait,
 323                                     int(_running.size()), _running.c_str(),
 324                                     int(_app.stderr_result_length()), _app.stderr_c_str());
 325       }
 326     }
 327     else
 328     {
 329       throw libtest::disconnected(LIBYATL_DEFAULT_PARAM,
 330                                   hostname(), port(),
 331                                   "Failed native ping(), pid: %d is alive: %s waited: %u server started. exec: %.*s stderr:%.*s",
 332                                   int(_app.pid()),
 333                                   _app.check() ? "true" : "false",
 334                                   this_wait,
 335                                   int(_running.size()), _running.c_str(),
 336                                   int(_app.stderr_result_length()), _app.stderr_c_str());
 337     }
 338     _running.clear();
 339
 340     return false;
 341   }
 342
 343   return has_pid();
 344 }
 345
 346 void Server::reset_pid()
 347 {
 348   _running.clear();
 349   _pid_file.clear();
 350 }
 351
 352 pid_t Server::pid() const
 353 {
 354   return _app.pid();
 355 }
 356
 357 void Server::add_option(const std::string& arg)
 358 {
 359   _options.push_back(std::make_pair(arg, std::string()));
 360 }
 361
 362 void Server::add_option(const std::string& name_, const std::string& value_)
 363 {
 364   _options.push_back(std::make_pair(name_, value_));
 365 }
 366
 367 bool Server::set_socket_file()
 368 {
 369   libtest::vchar_t file_buffer;
 370   file_buffer.resize(FILENAME_MAX);
 371   file_buffer[0]= 0;
 372
 373   if (broken_pid_file())
 374   {
 375     snprintf(&file_buffer[0], file_buffer.size(), "/tmp/%s.socketXXXXXX", name());
 376   }
 377   else
 378   {
 379     snprintf(&file_buffer[0], file_buffer.size(), "var/run/%s.socketXXXXXX", name());
 380   }
 381
 382   int fd;
 383   if ((fd= mkstemp(&file_buffer[0])) == -1)
 384   {
 385     perror(&file_buffer[0]);
 386     return false;
 387   }
 388   close(fd);
 389   unlink(&file_buffer[0]);
 390
 391   _socket= &file_buffer[0];
 392
 393   return true;
 394 }
 395
 396 bool Server::set_pid_file()
 397 {
 398   libtest::vchar_t file_buffer;
 399   file_buffer.resize(FILENAME_MAX);
 400   file_buffer[0]= 0;
 401
 402   if (broken_pid_file())
 403   {
 404     snprintf(&file_buffer[0], file_buffer.size(), "/tmp/%s.pidXXXXXX", name());
 405   }
 406   else
 407   {
 408     snprintf(&file_buffer[0], file_buffer.size(), "var/run/%s.pidXXXXXX", name());
 409   }
 410
 411   int fd;
 412   if ((fd= mkstemp(&file_buffer[0])) == -1)
 413   {
 414     throw libtest::fatal(LIBYATL_DEFAULT_PARAM, "mkstemp() failed on %s with %s", &file_buffer[0], strerror(errno));
 415   }
 416   close(fd);
 417   unlink(&file_buffer[0]);
 418
 419   _pid_file= &file_buffer[0];
 420
 421   return true;
 422 }
 423
 424 bool Server::set_log_file()
 425 {
 426   libtest::vchar_t file_buffer;
 427   file_buffer.resize(FILENAME_MAX);
 428   file_buffer[0]= 0;
 429
 430   snprintf(&file_buffer[0], file_buffer.size(), "var/log/%s.logXXXXXX", name());
 431   int fd;
 432   if ((fd= mkstemp(&file_buffer[0])) == -1)
 433   {
 434     throw libtest::fatal(LIBYATL_DEFAULT_PARAM, "mkstemp() failed on %s with %s", &file_buffer[0], strerror(errno));
 435   }
 436   close(fd);
 437
 438   _log_file= &file_buffer[0];
 439
 440   return true;
 441 }
 442
 443 bool Server::args(Application& app)
 444 {
 445
 446   // Set a log file if it was requested (and we can)
 447   if (has_log_file_option())
 448   {
 449     set_log_file();
 450     log_file_option(app, _log_file);
 451   }
 452
 453   if (getenv("LIBTEST_SYSLOG") and has_syslog())
 454   {
 455     app.add_option("--syslog");
 456   }
 457
 458   // Update pid_file
 459   {
 460     if (_pid_file.empty() and set_pid_file() == false)
 461     {
 462       return false;
 463     }
 464
 465     pid_file_option(app, pid_file());
 466   }
 467
 468   if (has_socket_file_option())
 469   {
 470     if (set_socket_file() == false)
 471     {
 472       return false;
 473     }
 474
 475     socket_file_option(app, _socket);
 476   }
 477
 478   if (has_port_option())
 479   {
 480     port_option(app, _port);
 481   }
 482
 483   for (Options::const_iterator iter= _options.begin(); iter != _options.end(); ++iter)
 484   {
 485     if ((*iter).first.empty() == false)
 486     {
 487       if ((*iter).second.empty() == false)
 488       {
 489         app.add_option((*iter).first, (*iter).second);
 490       }
 491       else
 492       {
 493         app.add_option((*iter).first);
 494       }
 495     }
 496   }
 497
 498   return true;
 499 }
 500
 501 bool Server::kill()
 502 {
 503   if (check_pid(_app.pid())) // If we kill it, reset
 504   {
 505     _app.murder();
 506     if (broken_pid_file() and pid_file().empty() == false)
 507     {
 508       unlink(pid_file().c_str());
 509     }
 510
 511     if (broken_socket_cleanup() and has_socket() and not socket().empty())
 512     {
 513       unlink(socket().c_str());
 514     }
 515
 516     reset_pid();
 517
 518     return true;
 519   }
 520
 521   return false;
 522 }
 523
 524 } // namespace libtest