Intermediate commit - just to make new files visible to bk in the new

tree


server-tools/instance-manager/Makefile.am:
  Fixed IM linking to avoid using both mysys and libmysql as the define the
  same symbols and therefore conflict
server-tools/instance-manager/listener.cc:
  Added ability to listen network ports
server-tools/instance-manager/listener.h:
  Various additions to the Listener_thread_args
server-tools/instance-manager/log.cc:
  merge
server-tools/instance-manager/log.h:
  merge
server-tools/instance-manager/manager.cc:
  Fixes and additions to enable guardian functionality
server-tools/instance-manager/manager.h:
  Changed manager() signature
server-tools/instance-manager/mysqlmanager.cc:
  Various fixes
server-tools/instance-manager/options.cc:
  Added handling of default values for new options in the Options struct. (such
  as default_user, default_password, monitoring_interval e.t.c)
server-tools/instance-manager/options.h:
  Added new options to the Options struct
sql/net_serv.cc:
  Added MYSQL_INSTANCE_MANAGER defines to enable alarm handling in the IM
server-tools/instance-manager/buffer.cc:
  Simple implementation of variable-length buffer
server-tools/instance-manager/command.cc:
  Abstract command. All commands are derived from Command class
server-tools/instance-manager/commands.h:
  Interfaces for all commands we have
server-tools/instance-manager/factory.cc:
  Commands factory. This class hides command instantiation. The idea is to
  handle various protocols this way. (different commands for different
  protocols
server-tools/instance-manager/guardian.cc:
  Guardian thread implementation (monitor and restart instances in case of a
  failure
server-tools/instance-manager/guardian.h:
  Guardian_thread and Guardian_thread_args class interface. The
  Guardian_thread is responsible for monitoring and restarting instances
server-tools/instance-manager/instance.cc:
  Instance class contains methods and data to manage a single instance
server-tools/instance-manager/instance.h:
  This file contains class an instance class interface. The class is
  responsible for starting/stopping an instance
server-tools/instance-manager/instance_map.cc:
  The instance repository. This class is also responsible for initialization
  of Instance class objects.
server-tools/instance-manager/instance_options.cc:
  The Instance_options class contains all methods to get and  handle options
  of an instance
server-tools/instance-manager/mysql_connection.cc:
  The class responsible for handling MySQL client/server protocol connections
server-tools/instance-manager/mysql_manager_error.h:
  The list of Instance Manger-specific errors
server-tools/instance-manager/parse.cc:
  Simple query parser
server-tools/instance-manager/parse.h:
  Parser interface
server-tools/instance-manager/protocol.cc:
  Here implemented functions used to handle mysql client/server protocol
server-tools/instance-manager/protocol.h:
  Interface for MySQL client/server protocol
server-tools/instance-manager/thread_registry.cc:
  Thread registry stores information about every thread. It's main function is
  to provide graceful shutdown for all threads.
server-tools/instance-manager/user_map.h:
  User map contains hash with user names and passwords

1 files changed, 388 insertions, 0 deletions

diff --git a/server-tools/instance-manager/mysql_connection.cc b/server-tools/instance-manager/mysql_connection.cc
new file mode 100644
index 00000000000..2a617675c26
--- /dev/null
+++ b/server-tools/instance-manager/mysql_connection.cc
@@ -0,0 +1,388 @@
+/* Copyright (C) 2003 MySQL AB & MySQL Finland AB & TCX DataKonsult 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; either version 2 of the License, or
+   (at your option) any later version.
+
+   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 */
+
+#ifdef __GNUC__
+#pragma interface
+#endif
+
+#include "mysql_connection.h"
+#include "priv.h"
+
+#include <mysql.h>
+#include <violite.h>
+#include <mysql_com.h>
+#include <m_string.h>
+#include <my_sys.h>
+
+#include "thread_registry.h"
+#include "log.h"
+#include "user_map.h"
+#include "protocol.h"
+#include "messages.h"
+#include "command.h"
+#include "factory.h"
+#include "parse.h"
+
+Command *parse_command(Command_factory * factory, const char *text);
+
+
+/*
+  MySQL connection - handle one connection with mysql command line client
+  See also comments in mysqlmanager.cc to picture general Instance Manager
+  architecture.
+  We use conventional technique to work with classes without exceptions:
+  class acquires all vital resource in init(); Thus if init() succeed, 
+  a user must call cleanup(). All other methods are valid only between
+  init() and cleanup().
+*/
+
+class Mysql_connection_thread: public Mysql_connection_thread_args
+{
+public:
+  Mysql_connection_thread(const Mysql_connection_thread_args &args);
+
+  int init();
+  void cleanup();
+
+  void run();
+
+  ~Mysql_connection_thread();
+private:
+  Thread_info thread_info;
+  NET net;
+  struct rand_struct rand_st;
+  char scramble[SCRAMBLE_LENGTH + 1];
+  uint status;
+  ulong client_capabilities;
+private:
+  /* Names are conventionally the same as in mysqld */
+  int check_connection();
+  int check_user(const char *user, const char *password);
+  int do_command();
+  int dispatch_command(enum enum_server_command command,
+                       const char *text, uint len);
+};
+
+
+Mysql_connection_thread::Mysql_connection_thread(
+                                   const Mysql_connection_thread_args &args) :
+  Mysql_connection_thread_args(args.vio,
+                               args.thread_registry,
+                               args.user_map,
+                               args.connection_id,
+                               args.instance_map)
+  ,thread_info(pthread_self())
+{
+  thread_registry.register_thread(&thread_info);
+}
+
+
+/*
+  NET subsystem requieres its user to provide my_net_local_init extern
+  C function (exactly as declared below). my_net_local_init is called by
+  my_net_init and is supposed to set NET controlling variables.
+  See also priv.h for variables description.
+*/
+
+C_MODE_START
+
+void my_net_local_init(NET *net)
+{
+  net->max_packet= net_buffer_length;
+  net->read_timeout= net_read_timeout;
+  net->write_timeout= net_write_timeout;
+  net->retry_count= net_retry_count;
+  net->max_packet_size= max_allowed_packet;
+}
+
+C_MODE_END
+
+
+/*
+  Every resource, which we can fail to acquire, is allocated in init().
+  This function is complementary to cleanup().
+*/
+
+int Mysql_connection_thread::init()
+{
+  /* Allocate buffers for network I/O */
+  if (my_net_init(&net, vio))
+    return 1;
+  net.return_status= &status;
+  /* Initialize random number generator */
+  {
+    ulong seed1= (ulong) &rand_st + rand();
+    ulong seed2= rand() + time(0);
+    randominit(&rand_st, seed1, seed2);
+  }
+  /* Fill scramble - server's random message used for handshake */
+  create_random_string(scramble, SCRAMBLE_LENGTH, &rand_st);
+  /* We don't support transactions, every query is atomic */
+  status= SERVER_STATUS_AUTOCOMMIT;
+  return 0;
+}
+
+
+void Mysql_connection_thread::cleanup()
+{
+  net_end(&net);
+}
+
+
+Mysql_connection_thread::~Mysql_connection_thread()
+{
+  /* vio_delete closes the socket if necessary */
+  vio_delete(vio);
+  thread_registry.unregister_thread(&thread_info);
+}
+
+
+void Mysql_connection_thread::run()
+{
+  log_info("accepted mysql connection %d", connection_id);
+
+  my_thread_init();
+
+  if (check_connection())
+  {
+    my_thread_end();
+    return;
+  }
+
+  log_info("connection %d is checked successfully", connection_id);
+
+  vio_keepalive(vio, TRUE);
+
+  while (!net.error && net.vio && !thread_registry.is_shutdown())
+  {
+    if (do_command())
+      break;
+  }
+
+  my_thread_end();
+}
+
+
+int Mysql_connection_thread::check_connection()
+{
+  ulong pkt_len=0;                              // to hold client reply length
+
+  /* buffer for the first packet */             /* packet contains: */
+  char buff[mysqlmanager_version_length + 1 +   // server version, 0-ended
+            4 +                                 // connection id
+            SCRAMBLE_LENGTH + 2 +               // scramble (in 2 pieces)
+            18];                                // server variables: flags,
+                                                // charset number, status,
+  char *pos= buff;
+  ulong server_flags;
+
+  memcpy(pos, mysqlmanager_version, mysqlmanager_version_length + 1);
+  pos+= mysqlmanager_version_length + 1;
+
+  int4store((uchar*) pos, connection_id);
+  pos+= 4;
+
+  /*
+    Old clients does not understand long scrambles, but can ignore packet
+    tail: that's why first part of the scramble is placed here, and second
+    part at the end of packet (even though we don't support old clients,
+    we must follow standard packet format.)
+  */
+  memcpy(pos, scramble, SCRAMBLE_LENGTH_323);
+  pos+= SCRAMBLE_LENGTH_323;
+  *pos++= '\0';
+
+  server_flags= CLIENT_LONG_FLAG | CLIENT_PROTOCOL_41 |
+                CLIENT_SECURE_CONNECTION;
+
+  /*
+    18-bytes long section for various flags/variables
+
+    Every flag occupies a bit in first half of ulong; int2store will
+    gracefully pick up all flags.
+  */
+  int2store(pos, server_flags);
+  pos+= 2;
+  *pos++= (char) default_charset_info->number;  // global mysys variable
+  int2store(pos, status);                       // connection status
+  pos+= 2;
+  bzero(pos, 13);                               // not used now
+  pos+= 13;
+
+  /* second part of the scramble, null-terminated */
+  memcpy(pos, scramble + SCRAMBLE_LENGTH_323,
+         SCRAMBLE_LENGTH - SCRAMBLE_LENGTH_323 + 1);
+  pos+= SCRAMBLE_LENGTH - SCRAMBLE_LENGTH_323 + 1;
+
+  /* write connection message and read reply */
+  enum { MIN_HANDSHAKE_SIZE= 2 };
+  if (net_write_command(&net, protocol_version, "", 0, buff, pos - buff) ||
+     (pkt_len= my_net_read(&net)) == packet_error ||
+      pkt_len < MIN_HANDSHAKE_SIZE)
+  {
+    net_send_error(&net, ER_HANDSHAKE_ERROR);
+    return 1;
+  }
+
+  client_capabilities= uint2korr(net.read_pos);
+  if (!(client_capabilities & CLIENT_PROTOCOL_41))
+  {
+    net_send_error_323(&net, ER_NOT_SUPPORTED_AUTH_MODE);
+    return 1;
+  }
+  client_capabilities|= ((ulong) uint2korr(net.read_pos + 2)) << 16;
+
+  pos= (char *) net.read_pos + 32;
+
+  /* At least one byte for username and one byte for password */
+  if (pos >= (char *) net.read_pos + pkt_len + 2)
+  {
+    /*TODO add user and password handling in error messages*/
+    net_send_error(&net, ER_HANDSHAKE_ERROR);
+    return 1;
+  }
+
+  const char *user= pos;
+  const char *password= strend(user)+1;
+  ulong password_len= *password++;
+  if (password_len != SCRAMBLE_LENGTH)
+  {
+    net_send_error(&net, ER_ACCESS_DENIED_ERROR);
+    return 1;
+  }
+  if (user_map.authenticate(user, password-user-2, password, scramble))
+  {
+    net_send_error(&net, ER_ACCESS_DENIED_ERROR);
+    return 1;
+  }
+  net_send_ok(&net, connection_id);
+  return 0;
+}
+
+
+int Mysql_connection_thread::check_user(const char *user, const char *password)
+{
+  return 0;
+}
+
+
+int Mysql_connection_thread::do_command()
+{
+  char *packet;
+  uint old_timeout;
+  ulong packet_length;
+
+  /* We start to count packets from 0 for each new command */
+  net.pkt_nr= 0;
+
+  if ((packet_length=my_net_read(&net)) == packet_error)
+  {
+    /* Check if we can continue without closing the connection */
+    if (net.error != 3) // what is 3 - find out
+    {
+      return 1;
+    }
+    if (thread_registry.is_shutdown())
+      return 1;
+    net_send_error(&net, net.last_errno);
+    net.error= 0;
+    return 0;
+  }
+  else
+  {
+    if (thread_registry.is_shutdown())
+      return 1;
+    packet= (char*) net.read_pos;
+    enum enum_server_command command= (enum enum_server_command)
+                                      (uchar) *packet;
+    log_info("connection %d: packet_length=%d, command=%d", 
+             connection_id, packet_length, command);
+    return dispatch_command(command, packet + 1, packet_length - 1);
+  }
+}
+
+int Mysql_connection_thread::dispatch_command(enum enum_server_command command,
+                                              const char *packet, uint len)
+{
+  switch (command) {
+  case COM_QUIT:                                // client exit
+    log_info("query for connection %d received quit command",connection_id);
+    return 1;
+  case COM_PING:
+    log_info("query for connection %d received ping command",connection_id);
+    net_send_ok(&net, connection_id);
+    break;
+  case COM_QUERY:
+  {
+    log_info("query for connection %d : ----\n%s\n-------------------------",
+	     connection_id,packet);
+    Command_factory commands_factory(instance_map);
+    if (Command *command= parse_command(&commands_factory, packet))
+    {
+      int res= 0;
+      log_info("query for connection %d successefully parsed",connection_id);
+      res= command->execute(&net, connection_id);
+      delete command;
+      if (!res)
+      {
+	log_info("query for connection %d executed ok",connection_id);
+      }
+      else
+      {
+	log_info("query for connection %d executed err=%d",connection_id,res);
+	net_send_error(&net, res);
+	return 0;
+      }
+    }
+    else
+    {
+      net_send_error(&net,ER_OUT_OF_RESOURCES);
+      return 0;
+    }
+    break;
+  }
+  default:
+    log_info("query for connection %d received unknown command",connection_id);
+    net_send_error(&net, ER_UNKNOWN_COM_ERROR);
+    break;
+  }
+  return 0;
+}
+
+
+C_MODE_START
+
+pthread_handler_decl(mysql_connection, arg)
+{
+  Mysql_connection_thread_args *args= (Mysql_connection_thread_args *) arg;
+  Mysql_connection_thread mysql_connection_thread(*args);
+  delete args;
+  if (mysql_connection_thread.init())
+    log_info("mysql_connection(): error initializing thread");
+  else
+  {
+    mysql_connection_thread.run();
+    mysql_connection_thread.cleanup();
+  }
+  return 0;
+}
+
+C_MODE_END
+
+
+/*
+  vim: fdm=marker 
+*/