git.m6w6.name Git - m6w6/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 <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   out_of_ban_killed_(false)
 104 {
 105 }
 106
 107 Server::~Server()
 108 {
 109 }
 110
 111 bool Server::check()
 112 {
 113   _app.slurp();
 114   _app.check();
 115   return true;
 116 }
 117
 118 bool Server::validate()
 119 {
 120   return _magic == MAGIC_MEMORY;
 121 }
 122
 123 // If the server exists, kill it
 124 bool Server::cycle()
 125 {
 126   uint32_t limit= 3;
 127
 128   // Try to ping, and kill the server #limit number of times
 129   while (--limit and
 130          is_pid_valid(_app.pid()))
 131   {
 132     if (kill())
 133     {
 134       Log << "Killed existing server," << *this;
 135       dream(0, 50000);
 136       continue;
 137     }
 138   }
 139
 140   // For whatever reason we could not kill it, and we reached limit
 141   if (limit == 0)
 142   {
 143     Error << "Reached limit, could not kill server";
 144     return false;
 145   }
 146
 147   return true;
 148 }
 149
 150 bool Server::wait_for_pidfile() const
 151 {
 152   Wait wait(pid_file(), 4);
 153
 154   return wait.successful();
 155 }
 156
 157 bool Server::has_pid() const
 158 {
 159   return (_app.pid() > 1);
 160 }
 161
 162
 163 bool Server::start()
 164 {
 165   // If we find that we already have a pid then kill it.
 166   if (has_pid() == true)
 167   {
 168 #if 0
 169     fatal_message("has_pid() failed, programer error");
 170 #endif
 171   }
 172
 173   // This needs more work.
 174 #if 0
 175   if (gdb_is_caller())
 176   {
 177     _app.use_gdb();
 178   }
 179 #endif
 180
 181   if (getenv("YATL_PTRCHECK_SERVER"))
 182   {
 183     _app.use_ptrcheck();
 184   }
 185   else if (getenv("YATL_VALGRIND_SERVER"))
 186   {
 187     _app.use_valgrind();
 188   }
 189
 190   if (args(_app) == false)
 191   {
 192     Error << "Could not build command()";
 193     return false;
 194   }
 195
 196   libtest::release_port(_port);
 197   Application::error_t ret;
 198   if (Application::SUCCESS !=  (ret= _app.run()))
 199   {
 200     Error << "Application::run() " << ret;
 201     return false;
 202   }
 203   _running= _app.print();
 204
 205   if (valgrind_is_caller())
 206   {
 207     dream(5, 50000);
 208   }
 209
 210   size_t repeat= 5;
 211   _app.slurp();
 212   while (--repeat)
 213   {
 214     if (pid_file().empty() == false)
 215     {
 216       Wait wait(pid_file(), 8);
 217
 218       if (wait.successful() == false)
 219       {
 220         if (_app.check())
 221         {
 222           _app.slurp();
 223           continue;
 224         }
 225
 226         char buf[PATH_MAX];
 227         char *getcwd_buf= getcwd(buf, sizeof(buf));
 228         throw libtest::fatal(LIBYATL_DEFAULT_PARAM,
 229                              "Unable to open pidfile in %s for: %s stderr:%s",
 230                              getcwd_buf ? getcwd_buf : "",
 231                              _running.c_str(),
 232                              _app.stderr_c_str());
 233       }
 234     }
 235   }
 236
 237   uint32_t this_wait= 0;
 238   bool pinged= false;
 239   {
 240     uint32_t timeout= 20; // This number should be high enough for valgrind startup (which is slow)
 241     uint32_t waited;
 242     uint32_t retry;
 243
 244     for (waited= 0, retry= 1; ; retry++, waited+= this_wait)
 245     {
 246       if ((pinged= ping()) == true)
 247       {
 248         break;
 249       }
 250       else if (waited >= timeout)
 251       {
 252         break;
 253       }
 254
 255       this_wait= retry * retry / 3 + 1;
 256       libtest::dream(this_wait, 0);
 257     }
 258   }
 259
 260   if (pinged == false)
 261   {
 262     // If we happen to have a pid file, lets try to kill it
 263     if ((pid_file().empty() == false) and (access(pid_file().c_str(), R_OK) == 0))
 264     {
 265       _app.slurp();
 266       if (kill_file(pid_file()) == false)
 267       {
 268         libtest::fatal err(LIBYATL_DEFAULT_PARAM,
 269                            "Failed to kill off server, waited: %u after startup occurred, when pinging failed: %.*s stderr:%.*s",
 270                            this_wait,
 271                            int(_running.size()), _running.c_str(),
 272                            int(_app.stderr_result_length()), _app.stderr_c_str());
 273
 274         stream::cerr(err.file(), err.line(), err.func()) << err.what();
 275       }
 276       else
 277       {
 278         libtest::fatal err(LIBYATL_DEFAULT_PARAM,
 279                            "Failed native ping(), pid: %d was alive: %s waited: %u server started, having pid_file. exec: %.*s stderr:%.*s",
 280                            int(_app.pid()),
 281                            _app.check() ? "true" : "false",
 282                            this_wait,
 283                            int(_running.size()), _running.c_str(),
 284                            int(_app.stderr_result_length()), _app.stderr_c_str());
 285
 286         stream::cerr(err.file(), err.line(), err.func()) << err.what();
 287       }
 288     }
 289     else
 290     {
 291       libtest::fatal err(LIBYATL_DEFAULT_PARAM,
 292                          "Failed native ping(), pid: %d is alive: %s waited: %u server started. exec: %.*s stderr:%.*s",
 293                          int(_app.pid()),
 294                          _app.check() ? "true" : "false",
 295                          this_wait,
 296                          int(_running.size()), _running.c_str(),
 297                          int(_app.stderr_result_length()), _app.stderr_c_str());
 298
 299       stream::cerr(err.file(), err.line(), err.func()) << err.what();
 300     }
 301     _running.clear();
 302     return false;
 303   }
 304
 305   return has_pid();
 306 }
 307
 308 void Server::reset_pid()
 309 {
 310   _running.clear();
 311   _pid_file.clear();
 312 }
 313
 314 pid_t Server::pid() const
 315 {
 316   return _app.pid();
 317 }
 318
 319 void Server::add_option(const std::string& arg)
 320 {
 321   _options.push_back(std::make_pair(arg, std::string()));
 322 }
 323
 324 void Server::add_option(const std::string& name, const std::string& value)
 325 {
 326   _options.push_back(std::make_pair(name, value));
 327 }
 328
 329 bool Server::set_socket_file()
 330 {
 331   char file_buffer[FILENAME_MAX];
 332   file_buffer[0]= 0;
 333
 334   if (broken_pid_file())
 335   {
 336     snprintf(file_buffer, sizeof(file_buffer), "/tmp/%s.socketXXXXXX", name());
 337   }
 338   else
 339   {
 340     snprintf(file_buffer, sizeof(file_buffer), "var/run/%s.socketXXXXXX", name());
 341   }
 342
 343   int fd;
 344   if ((fd= mkstemp(file_buffer)) == -1)
 345   {
 346     perror(file_buffer);
 347     return false;
 348   }
 349   close(fd);
 350   unlink(file_buffer);
 351
 352   _socket= file_buffer;
 353
 354   return true;
 355 }
 356
 357 bool Server::set_pid_file()
 358 {
 359   char file_buffer[FILENAME_MAX];
 360   file_buffer[0]= 0;
 361
 362   if (broken_pid_file())
 363   {
 364     snprintf(file_buffer, sizeof(file_buffer), "/tmp/%s.pidXXXXXX", name());
 365   }
 366   else
 367   {
 368     snprintf(file_buffer, sizeof(file_buffer), "var/run/%s.pidXXXXXX", name());
 369   }
 370
 371   int fd;
 372   if ((fd= mkstemp(file_buffer)) == -1)
 373   {
 374     throw libtest::fatal(LIBYATL_DEFAULT_PARAM, "mkstemp() failed on %s with %s", file_buffer, strerror(errno));
 375   }
 376   close(fd);
 377   unlink(file_buffer);
 378
 379   _pid_file= file_buffer;
 380
 381   return true;
 382 }
 383
 384 bool Server::set_log_file()
 385 {
 386   char file_buffer[FILENAME_MAX];
 387   file_buffer[0]= 0;
 388
 389   snprintf(file_buffer, sizeof(file_buffer), "var/log/%s.logXXXXXX", name());
 390   int fd;
 391   if ((fd= mkstemp(file_buffer)) == -1)
 392   {
 393     throw libtest::fatal(LIBYATL_DEFAULT_PARAM, "mkstemp() failed on %s with %s", file_buffer, strerror(errno));
 394   }
 395   close(fd);
 396
 397   _log_file= file_buffer;
 398
 399   return true;
 400 }
 401
 402 bool Server::args(Application& app)
 403 {
 404
 405   // Set a log file if it was requested (and we can)
 406   if (has_log_file_option())
 407   {
 408     set_log_file();
 409     log_file_option(app, _log_file);
 410   }
 411
 412   if (getenv("LIBTEST_SYSLOG") and has_syslog())
 413   {
 414     app.add_option("--syslog");
 415   }
 416
 417   // Update pid_file
 418   {
 419     if (_pid_file.empty() and set_pid_file() == false)
 420     {
 421       return false;
 422     }
 423
 424     pid_file_option(app, pid_file());
 425   }
 426
 427   if (has_socket_file_option())
 428   {
 429     if (set_socket_file() == false)
 430     {
 431       return false;
 432     }
 433
 434     socket_file_option(app, _socket);
 435   }
 436
 437   if (has_port_option())
 438   {
 439     port_option(app, _port);
 440   }
 441
 442   for (Options::const_iterator iter= _options.begin(); iter != _options.end(); ++iter)
 443   {
 444     if ((*iter).second.empty() == false)
 445     {
 446       app.add_option((*iter).first, (*iter).second);
 447     }
 448     else
 449     {
 450       app.add_option((*iter).first);
 451     }
 452   }
 453
 454   return true;
 455 }
 456
 457 bool Server::kill()
 458 {
 459   if (check_pid(_app.pid())) // If we kill it, reset
 460   {
 461     _app.murder();
 462     if (broken_pid_file() and pid_file().empty() == false)
 463     {
 464       unlink(pid_file().c_str());
 465     }
 466
 467     if (broken_socket_cleanup() and has_socket() and not socket().empty())
 468     {
 469       unlink(socket().c_str());
 470     }
 471
 472     reset_pid();
 473
 474     return true;
 475   }
 476
 477   return false;
 478 }
 479
 480 } // namespace libtest