Mass rename to simplify names.
[m6w6/libmemcached] / libmemcached / common.h
index 7e21afff48a740f1152b6cfff48e0baaf2358097..c9d7cf812add5678282bd13d3de8065aa4cb5aef 100644 (file)
@@ -1,13 +1,27 @@
+/* LibMemcached
+ * Copyright (C) 2006-2009 Brian Aker
+ * All rights reserved.
+ *
+ * Use and distribution licensed under the BSD license.  See
+ * the COPYING file in the parent directory for full text.
+ *
+ * Summary:
+ *
+ */
+
 /*
   Common include file for libmemached
 */
 
-#ifndef __COMMON_H__
-#define __COMMON_H__
+#ifndef LIBMEMCACHED_COMMON_H
+#define LIBMEMCACHED_COMMON_H
+
+#include "config.h"
 
 #include <stdio.h>
 #include <stdlib.h>
 #include <string.h>
+#include <strings.h>
 #include <ctype.h>
 #include <sys/types.h>
 #include <sys/socket.h>
 #include <netdb.h>
 #include <unistd.h>
 #include <limits.h>
-#include <assert.h>
 #include <errno.h>
 #include <fcntl.h>
 #include <sys/un.h>
 #include <netinet/tcp.h>
-
-#if TIME_WITH_SYS_TIME
+#ifdef TIME_WITH_SYS_TIME
 # include <sys/time.h>
 # include <time.h>
 #else
-# if HAVE_SYS_TIME_H
+# ifdef HAVE_SYS_TIME_H
 #  include <sys/time.h>
 # else
 #  include <time.h>
 # endif
 #endif
 
+/* Define this here, which will turn on the visibilty controls while we're
+ * building libmemcached.
+ */
+#define BUILDING_LIBMEMCACHED 1
+
+
+#include "libmemcached/memcached.h"
+#include "libmemcached/watchpoint.h"
 
+/* These are private not to be installed headers */
+#include "libmemcached/io.h"
+#include "libmemcached/internal.h"
+#include "libmemcached/libmemcached_probes.h"
+#include "libmemcached/memcached/protocol_binary.h"
+#include "libmemcached/byteorder.h"
 
-#include <memcached.h>
-#include "memcached_io.h"
+/* string value */
+struct memcached_continuum_item_st {
+  uint32_t index;
+  uint32_t value;
+};
 
-#include <libmemcached_config.h>
 
 #if !defined(__GNUC__) || (__GNUC__ == 2 && __GNUC_MINOR__ < 96)
 
 
 #else
 
-#define likely(x)       if(__builtin_expect(!!(x), 1))
-#define unlikely(x)     if(__builtin_expect((x), 0))
-#endif
-
-
-#ifdef HAVE_DTRACE
-#define _DTRACE_VERSION 1
-#else
-#undef _DTRACE_VERSION
+#define likely(x)       if(__builtin_expect((x) != 0, 1))
+#define unlikely(x)     if(__builtin_expect((x) != 0, 0))
 #endif
 
-#include "libmemcached_probes.h"
 
 #define MEMCACHED_BLOCK_SIZE 1024
 #define MEMCACHED_DEFAULT_COMMAND_SIZE 350
@@ -71,42 +91,91 @@ typedef enum {
   MEM_TCP_NODELAY= (1 << 1),
   MEM_REUSE_MEMORY= (1 << 2),
   MEM_USE_MD5= (1 << 3),
-  MEM_USE_KETAMA= (1 << 4),
+  /* 4 was once Ketama */
   MEM_USE_CRC= (1 << 5),
   MEM_USE_CACHE_LOOKUPS= (1 << 6),
   MEM_SUPPORT_CAS= (1 << 7),
   MEM_BUFFER_REQUESTS= (1 << 8),
   MEM_USE_SORT_HOSTS= (1 << 9),
   MEM_VERIFY_KEY= (1 << 10),
+  /* 11 used for weighted ketama */
+  MEM_KETAMA_WEIGHTED= (1 << 11),
+  MEM_BINARY_PROTOCOL= (1 << 12),
+  MEM_HASH_WITH_PREFIX_KEY= (1 << 13),
+  MEM_NOREPLY= (1 << 14),
+  MEM_USE_UDP= (1 << 15),
+  MEM_AUTO_EJECT_HOSTS= (1 << 16),
+  MEM_RANDOMIZE_REPLICA_READ= (1 << 17)
 } memcached_flags;
 
 /* Hashing algo */
-void md5_signature(unsigned char *key, unsigned int length, unsigned char *result);
+
+LIBMEMCACHED_LOCAL
+void md5_signature(const unsigned char *key, unsigned int length, unsigned char *result);
+LIBMEMCACHED_LOCAL
 uint32_t hash_crc32(const char *data,
                     size_t data_len);
-uint32_t hsieh_hash(char *key, size_t key_length);
-uint32_t murmur_hash(char *key, size_t key_length);
-
-memcached_return memcached_connect(memcached_server_st *ptr);
-memcached_return memcached_response(memcached_server_st *ptr,
-                                    char *buffer, size_t buffer_length,
-                                    memcached_result_st *result);
-unsigned int memcached_generate_hash(memcached_st *ptr, char *key, size_t key_length);
+#ifdef HAVE_HSIEH_HASH
+LIBMEMCACHED_LOCAL
+uint32_t hsieh_hash(const char *key, size_t key_length);
+#endif
+LIBMEMCACHED_LOCAL
+uint32_t murmur_hash(const char *key, size_t key_length);
+LIBMEMCACHED_LOCAL
+uint32_t jenkins_hash(const void *key, size_t length, uint32_t initval);
+
+LIBMEMCACHED_LOCAL
+memcached_return_t memcached_connect(memcached_server_st *ptr);
+LIBMEMCACHED_LOCAL
+memcached_return_t memcached_response(memcached_server_st *ptr,
+                                      char *buffer, size_t buffer_length,
+                                      memcached_result_st *result);
+LIBMEMCACHED_LOCAL
 void memcached_quit_server(memcached_server_st *ptr, uint8_t io_death);
 
 #define memcached_server_response_increment(A) (A)->cursor_active++
 #define memcached_server_response_decrement(A) (A)->cursor_active--
 #define memcached_server_response_reset(A) (A)->cursor_active=0
 
-memcached_return memcached_do(memcached_server_st *ptr, char *commmand,
-                              size_t command_length, uint8_t with_flush);
-memcached_return memcached_version(memcached_st *ptr);
-memcached_return value_fetch(memcached_server_st *ptr,
-                             char *buffer,
-                             memcached_result_st *result);
+LIBMEMCACHED_LOCAL
+memcached_return_t memcached_do(memcached_server_st *ptr, const void *commmand,
+                                size_t command_length, uint8_t with_flush);
+LIBMEMCACHED_LOCAL
+memcached_return_t value_fetch(memcached_server_st *ptr,
+                               char *buffer,
+                               memcached_result_st *result);
+LIBMEMCACHED_LOCAL
 void server_list_free(memcached_st *ptr, memcached_server_st *servers);
 
-memcached_return memcachd_key_test(char **keys, size_t *key_length,
-                                   unsigned int number_of_keys);
+LIBMEMCACHED_LOCAL
+memcached_return_t memcached_key_test(const char * const *keys, 
+                                      const size_t *key_length,
+                                      size_t number_of_keys);
+
+
+LIBMEMCACHED_LOCAL
+uint32_t generate_hash(memcached_st *ptr, const char *key, size_t key_length);
+
+LIBMEMCACHED_LOCAL
+memcached_return_t memcached_purge(memcached_server_st *ptr);
+
+static inline memcached_return_t memcached_validate_key_length(size_t key_length, bool binary)
+{
+  unlikely (key_length == 0)
+    return MEMCACHED_BAD_KEY_PROVIDED;
+
+  if (binary)
+  {
+    unlikely (key_length > 0xffff)
+      return MEMCACHED_BAD_KEY_PROVIDED;
+  }
+  else
+  {
+    unlikely (key_length >= MEMCACHED_MAX_KEY)
+      return MEMCACHED_BAD_KEY_PROVIDED;
+  }
+
+  return MEMCACHED_SUCCESS;
+}
 
-#endif /* __COMMON_H__ */
+#endif /* LIBMEMCACHED_COMMON_H */