git.m6w6.name Git - m6w6/libmemcached/blob - libmemcached/common.h

   1 /* LibMemcached
   2  * Copyright (C) 2006-2009 Brian Aker
   3  * All rights reserved.
   4  *
   5  * Use and distribution licensed under the BSD license.  See
   6  * the COPYING file in the parent directory for full text.
   7  *
   8  * Summary:
   9  *
  10  */
  11
  12 /*
  13   Common include file for libmemached
  14 */
  15
  16 #ifndef __LIBMEMCACHED_COMMON_H__
  17 #define __LIBMEMCACHED_COMMON_H__
  18
  19 #include "config.h"
  20
  21 #include <stdio.h>
  22 #include <stdlib.h>
  23 #include <string.h>
  24 #include <strings.h>
  25 #include <ctype.h>
  26 #include <sys/types.h>
  27 #include <sys/socket.h>
  28 #include <netinet/in.h>
  29 #include <arpa/inet.h>
  30 #include <netdb.h>
  31 #include <unistd.h>
  32 #include <limits.h>
  33 #include <errno.h>
  34 #include <fcntl.h>
  35 #include <sys/un.h>
  36 #include <netinet/tcp.h>
  37 #ifdef TIME_WITH_SYS_TIME
  38 # include <sys/time.h>
  39 # include <time.h>
  40 #else
  41 # ifdef HAVE_SYS_TIME_H
  42 #  include <sys/time.h>
  43 # else
  44 #  include <time.h>
  45 # endif
  46 #endif
  47
  48 /* Define this here, which will turn on the visibilty controls while we're
  49  * building libmemcached.
  50  */
  51 #define BUILDING_LIBMEMCACHED 1
  52
  53
  54 #include "libmemcached/memcached.h"
  55 #include "libmemcached/watchpoint.h"
  56
  57 typedef struct memcached_server_st memcached_server_instance_st;
  58
  59 /* These are private not to be installed headers */
  60 #include "libmemcached/io.h"
  61 #include "libmemcached/internal.h"
  62 #include "libmemcached/libmemcached_probes.h"
  63 #include "libmemcached/memcached/protocol_binary.h"
  64 #include "libmemcached/byteorder.h"
  65 #include "libmemcached/response.h"
  66
  67 /* string value */
  68 struct memcached_continuum_item_st
  69 {
  70   uint32_t index;
  71   uint32_t value;
  72 };
  73
  74 /* Yum, Fortran.... can you make the reference? */
  75 typedef enum {
  76   MEM_NOT= -1,
  77   MEM_FALSE= false,
  78   MEM_TRUE= true,
  79 } memcached_ternary_t;
  80
  81
  82 #if !defined(__GNUC__) || (__GNUC__ == 2 && __GNUC_MINOR__ < 96)
  83
  84 #define likely(x)       if((x))
  85 #define unlikely(x)     if((x))
  86
  87 #else
  88
  89 #define likely(x)       if(__builtin_expect((x) != 0, 1))
  90 #define unlikely(x)     if(__builtin_expect((x) != 0, 0))
  91 #endif
  92
  93 #define MEMCACHED_BLOCK_SIZE 1024
  94 #define MEMCACHED_DEFAULT_COMMAND_SIZE 350
  95 #define SMALL_STRING_LEN 1024
  96 #define HUGE_STRING_LEN 8196
  97
  98 #ifdef __cplusplus
  99 extern "C" {
 100 #endif
 101
 102 LIBMEMCACHED_LOCAL
 103 memcached_return_t memcached_connect(memcached_server_instance_st *ptr);
 104 LIBMEMCACHED_LOCAL
 105 void memcached_quit_server(memcached_server_instance_st *ptr, uint8_t io_death);
 106
 107 LIBMEMCACHED_LOCAL
 108 memcached_return_t run_distribution(memcached_st *ptr);
 109
 110 #define memcached_server_response_increment(A) (A)->cursor_active++
 111 #define memcached_server_response_decrement(A) (A)->cursor_active--
 112 #define memcached_server_response_reset(A) (A)->cursor_active=0
 113
 114 // These are private
 115 #define memcached_is_allocated(__object) ((__object)->options.is_allocated)
 116 #define memcached_is_initialized(__object) ((__object)->options.is_initialized)
 117 #define memcached_is_purging(__object) ((__object)->state.is_purging)
 118 #define memcached_is_processing_input(__object) ((__object)->state.is_processing_input)
 119 #define memcached_set_purging(__object, __value) ((__object)->state.is_purging= (__value))
 120 #define memcached_set_processing_input(__object, __value) ((__object)->state.is_processing_input= (__value))
 121 #define memcached_set_initialized(__object, __value) ((__object)->options.is_initialized(= (__value))
 122 #define memcached_set_allocated(__object, __value) ((__object)->options.is_allocated(= (__value))
 123
 124
 125 LIBMEMCACHED_LOCAL
 126 memcached_return_t memcached_do(memcached_server_instance_st *ptr, const void *commmand,
 127                                 size_t command_length, uint8_t with_flush);
 128 LIBMEMCACHED_LOCAL
 129 memcached_return_t value_fetch(memcached_server_instance_st *ptr,
 130                                char *buffer,
 131                                memcached_result_st *result);
 132 LIBMEMCACHED_LOCAL
 133 void server_list_free(memcached_st *ptr, memcached_server_instance_st *servers);
 134
 135 LIBMEMCACHED_LOCAL
 136 memcached_return_t memcached_key_test(const char * const *keys,
 137                                       const size_t *key_length,
 138                                       size_t number_of_keys);
 139
 140
 141 LIBMEMCACHED_LOCAL
 142 uint32_t generate_hash(memcached_st *ptr, const char *key, size_t key_length);
 143
 144 LIBMEMCACHED_LOCAL
 145 memcached_return_t memcached_purge(memcached_server_instance_st *ptr);
 146
 147 static inline memcached_return_t memcached_validate_key_length(size_t key_length, bool binary)
 148 {
 149   unlikely (key_length == 0)
 150     return MEMCACHED_BAD_KEY_PROVIDED;
 151
 152   if (binary)
 153   {
 154     unlikely (key_length > 0xffff)
 155       return MEMCACHED_BAD_KEY_PROVIDED;
 156   }
 157   else
 158   {
 159     unlikely (key_length >= MEMCACHED_MAX_KEY)
 160       return MEMCACHED_BAD_KEY_PROVIDED;
 161   }
 162
 163   return MEMCACHED_SUCCESS;
 164 }
 165
 166 #ifdef TCP_CORK
 167   #define CORK TCP_CORK
 168 #elif defined TCP_NOPUSH
 169   #define CORK TCP_NOPUSH
 170 #endif
 171
 172 /*
 173   test_cork() tries to enable TCP_CORK. IF TCP_CORK is not an option
 174   on the system it returns false but sets errno to 0. Otherwise on
 175   failure errno is set.
 176 */
 177 static inline memcached_ternary_t test_cork(memcached_server_st *ptr, int enable)
 178 {
 179 #ifdef CORK
 180   if (ptr->type != MEMCACHED_CONNECTION_TCP)
 181     return MEM_FALSE;
 182
 183   int err= setsockopt(ptr->fd, IPPROTO_TCP, CORK,
 184                       &enable, (socklen_t)sizeof(int));
 185   if (! err)
 186   {
 187     return MEM_TRUE;
 188   }
 189
 190   perror(strerror(errno));
 191   ptr->cached_errno= errno;
 192
 193   return MEM_FALSE;
 194 #else
 195   (void)ptr;
 196   (void)enable;
 197
 198   ptr->cached_errno= 0;
 199
 200   return MEM_NOT;
 201 #endif
 202 }
 203
 204 static inline void libmemcached_free(const memcached_st *ptr, void *mem)
 205 {
 206   ptr->allocators.free(ptr, mem, ptr->allocators.context);
 207 }
 208
 209 static inline void *libmemcached_malloc(const memcached_st *ptr, const size_t size)
 210 {
 211   return ptr->allocators.malloc(ptr, size, ptr->allocators.context);
 212 }
 213
 214 static inline void *libmemcached_realloc(const memcached_st *ptr, void *mem, const size_t size)
 215 {
 216   return ptr->allocators.realloc(ptr, mem, size, ptr->allocators.context);
 217 }
 218
 219 static inline void *libmemcached_calloc(const memcached_st *ptr, size_t nelem, size_t size)
 220 {
 221   return ptr->allocators.calloc(ptr, nelem, size, ptr->allocators.context);
 222 }
 223
 224 #ifdef __cplusplus
 225 }
 226 #endif
 227
 228 #endif /* __LIBMEMCACHED_COMMON_H__ */