Fix server messages (clean up errors in general).
[m6w6/libmemcached] / libmemcached / server.cc
index 1eb50ee4632a4ab655e301175e3b5189d2534b73..8aba7576e60e4fa661b9ff1aaba75eede009984b 100644 (file)
@@ -1,11 +1,37 @@
-/* LibMemcached
- * Copyright (C) 2006-2009 Brian Aker
- * All rights reserved.
+/*  vim:expandtab:shiftwidth=2:tabstop=2:smarttab:
+ * 
+ *  Libmemcached library
  *
- * Use and distribution licensed under the BSD license.  See
- * the COPYING file in the parent directory for full text.
+ *  Copyright (C) 2011 Data Differential, http://datadifferential.com/
+ *  Copyright (C) 2006-2009 Brian Aker All rights reserved.
  *
- * Summary: String structure used for libmemcached.
+ *  Redistribution and use in source and binary forms, with or without
+ *  modification, are permitted provided that the following conditions are
+ *  met:
+ *
+ *      * Redistributions of source code must retain the above copyright
+ *  notice, this list of conditions and the following disclaimer.
+ *
+ *      * Redistributions in binary form must reproduce the above
+ *  copyright notice, this list of conditions and the following disclaimer
+ *  in the documentation and/or other materials provided with the
+ *  distribution.
+ *
+ *      * The names of its contributors may not be used to endorse or
+ *  promote products derived from this software without specific prior
+ *  written permission.
+ *
+ *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ *  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ *  OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ *  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ *  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ *  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ *  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ *  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ *  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  *
  */
 
@@ -14,8 +40,9 @@
 */
 #include <libmemcached/common.h>
 
-static inline void _server_init(memcached_server_st *self, const memcached_st *root,
-                                const char *hostname, in_port_t port,
+static inline void _server_init(memcached_server_st *self, memcached_st *root,
+                                const memcached_string_t& hostname,
+                                in_port_t port,
                                 uint32_t weight, memcached_connection_t type)
 {
   self->options.is_shutting_down= false;
@@ -23,59 +50,54 @@ static inline void _server_init(memcached_server_st *self, const memcached_st *r
   self->number_of_hosts= 0;
   self->cursor_active= 0;
   self->port= port;
-  self->cached_errno= 0;
-  self->fd= -1;
+  self->fd= INVALID_SOCKET;
   self->io_bytes_sent= 0;
   self->server_failure_counter= 0;
+  self->server_failure_counter_query_id= 0;
   self->weight= weight ? weight : 1; // 1 is the default weight value
-  WATCHPOINT_SET(self->io_wait_count.read= 0);
-  WATCHPOINT_SET(self->io_wait_count.write= 0);
+  self->io_wait_count.read= 0;
+  self->io_wait_count.write= 0;
+  self->io_wait_count.timeouts= 0;
+  self->io_wait_count._bytes_read= 0;
   self->major_version= UINT8_MAX;
   self->micro_version= UINT8_MAX;
   self->minor_version= UINT8_MAX;
   self->type= type;
+  self->error_messages= NULL;
   self->read_ptr= self->read_buffer;
-  self->cached_server_error= NULL;
   self->read_buffer_length= 0;
   self->read_data_length= 0;
   self->write_buffer_offset= 0;
   self->address_info= NULL;
   self->address_info_next= NULL;
 
-  if (root)
-  {
-    self->next_retry= root->retry_timeout;
-  }
-  else
-  {
-    self->next_retry= 0;
-  }
-
-  if (self->weight > 1 && root)
-  {
-    ((memcached_st *)root)->ketama.weighted= true;
-  }
+  self->state= MEMCACHED_SERVER_STATE_NEW;
+  self->next_retry= 0;
 
   self->root= root;
-  self->limit_maxbytes= 0;
-  if (hostname == NULL)
+  if (root)
   {
-    self->hostname[0]= 0;
+    self->version= ++root->server_info.version;
   }
   else
   {
-    strncpy(self->hostname, hostname, NI_MAXHOST - 1);
+    self->version= UINT_MAX;
   }
+  self->limit_maxbytes= 0;
+  memcpy(self->hostname, hostname.c_str, hostname.size);
+  self->hostname[hostname.size]= 0;
 }
 
 static memcached_server_st *_server_create(memcached_server_st *self, const memcached_st *memc)
 {
   if (self == NULL)
   {
-   self= (memcached_server_st *)libmemcached_malloc(memc, sizeof(memcached_server_st));
+   self= libmemcached_xmalloc(memc, struct memcached_server_st);
 
-    if (! self)
+    if (self == NULL)
+    {
       return NULL; /*  MEMCACHED_MEMORY_ALLOCATION_FAILURE */
+    }
 
     self->options.is_allocated= true;
   }
@@ -89,48 +111,58 @@ static memcached_server_st *_server_create(memcached_server_st *self, const memc
   return self;
 }
 
-memcached_server_st *memcached_server_create_with(const memcached_st *memc,
-                                                  memcached_server_write_instance_st self,
-                                                  const char *hostname, in_port_t port,
-                                                  uint32_t weight, memcached_connection_t type)
+memcached_server_st *__server_create_with(memcached_st *memc,
+                                          memcached_server_write_instance_st self,
+                                          const memcached_string_t& hostname,
+                                          const in_port_t port,
+                                          uint32_t weight, 
+                                          const memcached_connection_t type)
 {
+  if (memcached_is_valid_servername(hostname) == false)
+  {
+    memcached_set_error(*memc, MEMCACHED_INVALID_ARGUMENTS, MEMCACHED_AT, memcached_literal_param("Invalid hostname provided"));
+    return NULL;
+  }
+
   self= _server_create(self, memc);
 
   if (self == NULL)
+  {
     return NULL;
+  }
 
-  _server_init(self, memc, hostname, port, weight, type);
-
+  _server_init(self, const_cast<memcached_st *>(memc), hostname, port, weight, type);
 
-  if (type == MEMCACHED_CONNECTION_UDP)
-  {
+  if (memc and memcached_is_udp(memc))
+  { 
     self->write_buffer_offset= UDP_DATAGRAM_HEADER_LENGTH;
     memcached_io_init_udp_header(self, 0);
   }
 
+  if (memc)
+  {
+    memcached_connect_try(self);
+  }
+
   return self;
 }
 
-void memcached_server_free(memcached_server_st *self)
+void __server_free(memcached_server_st *self)
 {
   memcached_quit_server(self, false);
 
-  if (self->cached_server_error)
-    free(self->cached_server_error);
-
   if (self->address_info)
+  {
     freeaddrinfo(self->address_info);
+    self->address_info= NULL;
+    self->address_info_next= NULL;
+  }
+
+  memcached_error_free(*self);
 
   if (memcached_is_allocated(self))
   {
-    if (self->root)
-    {
-      libmemcached_free(self->root, self);
-    }
-    else
-    {
-      free(self);
-    }
+    libmemcached_free(self->root, self);
   }
   else
   {
@@ -138,27 +170,39 @@ void memcached_server_free(memcached_server_st *self)
   }
 }
 
+void memcached_server_free(memcached_server_st *self)
+{
+  if (self == NULL)
+  {
+    return;
+  }
+
+  if (memcached_server_list_count(self))
+  {
+    memcached_server_list_free(self);
+    return;
+  }
+
+  __server_free(self);
+}
+
 /*
   If we do not have a valid object to clone from, we toss an error.
 */
 memcached_server_st *memcached_server_clone(memcached_server_st *destination,
-                                            const memcached_server_st *source)
+                                            memcached_server_st *source)
 {
   /* We just do a normal create if source is missing */
   if (source == NULL)
-    return NULL;
-
-  destination= memcached_server_create_with(source->root, destination,
-                                            source->hostname, source->port, source->weight,
-                                            source->type);
-  if (destination != NULL)
   {
-    destination->cached_errno= source->cached_errno;
-
-    if (source->cached_server_error)
-      destination->cached_server_error= strdup(source->cached_server_error);
+    return NULL;
   }
 
+  memcached_string_t hostname= { memcached_string_make_from_cstr(source->hostname) };
+  destination= __server_create_with(source->root, destination,
+                                    hostname,
+                                    source->port, source->weight,
+                                    source->type);
   return destination;
 
 }
@@ -169,11 +213,12 @@ memcached_return_t memcached_server_cursor(const memcached_st *ptr,
                                            uint32_t number_of_callbacks)
 {
   memcached_return_t rc;
-  if ((rc= initialize_const_query(ptr)) != MEMCACHED_SUCCESS)
+  if (memcached_failed(rc= initialize_const_query(ptr)))
   {
     return rc;
   }
 
+  size_t errors= 0;
   for (uint32_t x= 0; x < memcached_server_count(ptr); x++)
   {
     memcached_server_instance_st instance=
@@ -181,64 +226,70 @@ memcached_return_t memcached_server_cursor(const memcached_st *ptr,
 
     for (uint32_t y= 0; y < number_of_callbacks; y++)
     {
-      unsigned int iferror;
-
-      iferror= (*callback[y])(ptr, instance, context);
+      memcached_return_t ret= (*callback[y])(ptr, instance, context);
 
-      if (iferror)
+      if (memcached_failed(ret))
+      {
+        errors++;
         continue;
+      }
     }
   }
 
-  return MEMCACHED_SUCCESS;
+  return errors ? MEMCACHED_SOME_ERRORS : MEMCACHED_SUCCESS;
 }
 
 memcached_return_t memcached_server_execute(memcached_st *ptr,
                                             memcached_server_execute_fn callback,
                                             void *context)
 {
-  for (uint32_t x= 0; x < memcached_server_count(ptr); x++)
+  if (callback == NULL)
   {
-    memcached_server_write_instance_st instance=
-      memcached_server_instance_fetch(ptr, x);
-
-    unsigned int iferror;
+    return MEMCACHED_INVALID_ARGUMENTS;
+  }
 
-    iferror= (*callback)(ptr, instance, context);
+  bool some_errors= false;;
+  for (uint32_t x= 0; x < memcached_server_count(ptr); x++)
+  {
+    memcached_server_write_instance_st instance= memcached_server_instance_fetch(ptr, x);
 
-    if (iferror)
-      continue;
+    memcached_return_t rc= (*callback)(ptr, instance, context);
+    if (rc == MEMCACHED_INVALID_ARGUMENTS)
+    {
+      return rc;
+    }
+    else if (memcached_fatal(rc))
+    {
+      some_errors= true;
+    }
   }
 
+  (void)some_errors;
   return MEMCACHED_SUCCESS;
 }
 
-memcached_server_instance_st memcached_server_by_key(const memcached_st *ptr,
+memcached_server_instance_st memcached_server_by_key(memcached_st *ptr,
                                                      const char *key,
                                                      size_t key_length,
                                                      memcached_return_t *error)
 {
-  memcached_return_t rc;
-  if (memcached_failed(rc= initialize_const_query(ptr)))
+  memcached_return_t unused;
+  if (not error)
   {
-    if (error)
-      *error= rc;
-
-    return NULL;
+    error= &unused;
   }
 
-  if (memcached_failed(rc= memcached_validate_key_length(key_length, ptr->flags.binary_protocol)))
-  {
-    if (error)
-      *error= rc;
 
+  memcached_return_t rc;
+  if (memcached_failed(rc= initialize_const_query(ptr)))
+  {
+    *error= rc;
     return NULL;
   }
 
-  if (ptr->flags.verify_key && (memcached_key_test((const char **)&key, &key_length, 1) == MEMCACHED_BAD_KEY_PROVIDED))
+  if (memcached_failed((memcached_key_test(*ptr, (const char **)&key, &key_length, 1))))
   {
-    if (error)
-      *error= MEMCACHED_BAD_KEY_PROVIDED;
+    *error= memcached_last_error(ptr);
     return NULL;
   }
 
@@ -250,51 +301,32 @@ memcached_server_instance_st memcached_server_by_key(const memcached_st *ptr,
 void memcached_server_error_reset(memcached_server_st *self)
 {
   WATCHPOINT_ASSERT(self);
-  if (not self)
+  if (self == NULL)
+  {
     return;
+  }
 
-  self->cached_server_error[0]= 0;
+  memcached_error_free(*self);
 }
 
 memcached_server_instance_st memcached_server_get_last_disconnect(const memcached_st *self)
 {
   WATCHPOINT_ASSERT(self);
-  if (not self)
-    return 0;
-
-  return self->last_disconnected_server;
-}
-
-void memcached_server_list_free(memcached_server_list_st self)
-{
-  if (not self)
-    return;
-
-  for (uint32_t x= 0; x < memcached_server_list_count(self); x++)
+  if (self == NULL)
   {
-    if (self[x].address_info)
-    {
-      freeaddrinfo(self[x].address_info);
-      self[x].address_info= NULL;
-    }
+    return 0;
   }
 
-  const memcached_st *root= self->root;
-  if (root)
-  {
-    libmemcached_free(root, self);
-  }
-  else
-  {
-    free(self);
-  }
+  return self->last_disconnected_server;
 }
 
 uint32_t memcached_servers_set_count(memcached_server_st *servers, uint32_t count)
 {
   WATCHPOINT_ASSERT(servers);
-  if (not servers)
+  if (servers == NULL)
+  {
     return 0;
+  }
 
   return servers->number_of_hosts= count;
 }
@@ -302,41 +334,59 @@ uint32_t memcached_servers_set_count(memcached_server_st *servers, uint32_t coun
 uint32_t memcached_server_count(const memcached_st *self)
 {
   WATCHPOINT_ASSERT(self);
-  if (not self)
+  if (self == NULL)
     return 0;
 
   return self->number_of_hosts;
 }
 
-const char *memcached_server_name(memcached_server_instance_st self)
+const char *memcached_server_name(const memcached_server_instance_st self)
 {
   WATCHPOINT_ASSERT(self);
-  if (not self)
+  if (self == NULL)
     return NULL;
 
   return self->hostname;
 }
 
-in_port_t memcached_server_port(memcached_server_instance_st self)
+in_port_t memcached_server_port(const memcached_server_instance_st self)
 {
   WATCHPOINT_ASSERT(self);
-  if (not self)
+  if (self == NULL)
+  {
     return 0;
+  }
 
   return self->port;
 }
 
-uint32_t memcached_server_response_count(memcached_server_instance_st self)
+uint32_t memcached_server_response_count(const memcached_server_instance_st self)
 {
   WATCHPOINT_ASSERT(self);
-  if (not self)
+  if (self == NULL)
+  {
     return 0;
+  }
 
   return self->cursor_active;
 }
 
-const char *memcached_server_error(memcached_server_instance_st ptr)
+const char *memcached_server_type(const memcached_server_instance_st ptr)
 {
-  return ptr ?  ptr->cached_server_error : NULL;
-}
+  if (ptr)
+  {
+    switch (ptr->type)
+    {
+    case MEMCACHED_CONNECTION_TCP:
+      return "TCP";
 
+    case MEMCACHED_CONNECTION_UDP:
+      return "UDP";
+
+    case MEMCACHED_CONNECTION_UNIX_SOCKET:
+      return "SOCKET";
+    }
+  }
+
+  return "UNKNOWN";
+}