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