git.m6w6.name Git - awesomized/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_write_instance_st;
  58
  59 typedef memcached_return_t (*memcached_server_execute_fn)(memcached_st *ptr, memcached_server_write_instance_st server, void *context);
  60
  61 LIBMEMCACHED_LOCAL
  62 memcached_server_write_instance_st memcached_server_instance_fetch(memcached_st *ptr, uint32_t server_key);
  63
  64 LIBMEMCACHED_LOCAL
  65 memcached_return_t memcached_server_execute(memcached_st *ptr,
  66                                             memcached_server_execute_fn callback,
  67                                             void *context);
  68
  69
  70 /* These are private not to be installed headers */
  71 #include "libmemcached/io.h"
  72 #include "libmemcached/do.h"
  73 #include "libmemcached/internal.h"
  74 #include "libmemcached/libmemcached_probes.h"
  75 #include "libmemcached/memcached/protocol_binary.h"
  76 #include "libmemcached/byteorder.h"
  77 #include "libmemcached/response.h"
  78
  79 /* string value */
  80 struct memcached_continuum_item_st
  81 {
  82   uint32_t index;
  83   uint32_t value;
  84 };
  85
  86 /* Yum, Fortran.... can you make the reference? */
  87 typedef enum {
  88   MEM_NOT= -1,
  89   MEM_FALSE= false,
  90   MEM_TRUE= true
  91 } memcached_ternary_t;
  92
  93
  94 #if !defined(__GNUC__) || (__GNUC__ == 2 && __GNUC_MINOR__ < 96)
  95
  96 #define likely(x)       if((x))
  97 #define unlikely(x)     if((x))
  98
  99 #else
 100
 101 #define likely(x)       if(__builtin_expect((x) != 0, 1))
 102 #define unlikely(x)     if(__builtin_expect((x) != 0, 0))
 103 #endif
 104
 105 #define MEMCACHED_BLOCK_SIZE 1024
 106 #define MEMCACHED_DEFAULT_COMMAND_SIZE 350
 107 #define SMALL_STRING_LEN 1024
 108 #define HUGE_STRING_LEN 8196
 109
 110 #ifdef __cplusplus
 111 extern "C" {
 112 #endif
 113
 114 LIBMEMCACHED_LOCAL
 115 memcached_return_t memcached_connect(memcached_server_write_instance_st ptr);
 116
 117 LIBMEMCACHED_LOCAL
 118 memcached_return_t run_distribution(memcached_st *ptr);
 119
 120 #define memcached_server_response_increment(A) (A)->cursor_active++
 121 #define memcached_server_response_decrement(A) (A)->cursor_active--
 122 #define memcached_server_response_reset(A) (A)->cursor_active=0
 123
 124 // These are private
 125 #define memcached_is_allocated(__object) ((__object)->options.is_allocated)
 126 #define memcached_is_initialized(__object) ((__object)->options.is_initialized)
 127 #define memcached_is_purging(__object) ((__object)->state.is_purging)
 128 #define memcached_is_processing_input(__object) ((__object)->state.is_processing_input)
 129 #define memcached_set_purging(__object, __value) ((__object)->state.is_purging= (__value))
 130 #define memcached_set_processing_input(__object, __value) ((__object)->state.is_processing_input= (__value))
 131 #define memcached_set_initialized(__object, __value) ((__object)->options.is_initialized(= (__value))
 132 #define memcached_set_allocated(__object, __value) ((__object)->options.is_allocated(= (__value))
 133
 134 LIBMEMCACHED_LOCAL
 135 void set_last_disconnected_host(memcached_server_write_instance_st ptr);
 136
 137 LIBMEMCACHED_LOCAL
 138 memcached_return_t memcached_key_test(const char * const *keys,
 139                                       const size_t *key_length,
 140                                       size_t number_of_keys);
 141
 142 LIBMEMCACHED_LOCAL
 143 memcached_return_t memcached_purge(memcached_server_write_instance_st ptr);
 144
 145 LIBMEMCACHED_LOCAL
 146 memcached_server_st *memcached_server_create_with(const memcached_st *memc,
 147                                                   memcached_server_write_instance_st host,
 148                                                   const char *hostname,
 149                                                   in_port_t port,
 150                                                   uint32_t weight,
 151                                                   memcached_connection_t type);
 152
 153
 154 static inline memcached_return_t memcached_validate_key_length(size_t key_length, bool binary)
 155 {
 156   unlikely (key_length == 0)
 157     return MEMCACHED_BAD_KEY_PROVIDED;
 158
 159   if (binary)
 160   {
 161     unlikely (key_length > 0xffff)
 162       return MEMCACHED_BAD_KEY_PROVIDED;
 163   }
 164   else
 165   {
 166     unlikely (key_length >= MEMCACHED_MAX_KEY)
 167       return MEMCACHED_BAD_KEY_PROVIDED;
 168   }
 169
 170   return MEMCACHED_SUCCESS;
 171 }
 172
 173 #ifdef TCP_CORK
 174   #define CORK TCP_CORK
 175 #elif defined TCP_NOPUSH
 176   #define CORK TCP_NOPUSH
 177 #endif
 178
 179 /*
 180   test_cork() tries to enable TCP_CORK. IF TCP_CORK is not an option
 181   on the system it returns false but sets errno to 0. Otherwise on
 182   failure errno is set.
 183 */
 184 static inline memcached_ternary_t test_cork(memcached_server_st *ptr, int enable)
 185 {
 186 #ifdef CORK
 187   if (ptr->type != MEMCACHED_CONNECTION_TCP)
 188     return MEM_FALSE;
 189
 190   int err= setsockopt(ptr->fd, IPPROTO_TCP, CORK,
 191                       &enable, (socklen_t)sizeof(int));
 192   if (! err)
 193   {
 194     return MEM_TRUE;
 195   }
 196
 197   perror(strerror(errno));
 198   ptr->cached_errno= errno;
 199
 200   return MEM_FALSE;
 201 #else
 202   (void)ptr;
 203   (void)enable;
 204
 205   ptr->cached_errno= 0;
 206
 207   return MEM_NOT;
 208 #endif
 209 }
 210
 211 static inline void libmemcached_free(const memcached_st *ptr, void *mem)
 212 {
 213   ptr->allocators.free(ptr, mem, ptr->allocators.context);
 214 }
 215
 216 static inline void *libmemcached_malloc(const memcached_st *ptr, const size_t size)
 217 {
 218   return ptr->allocators.malloc(ptr, size, ptr->allocators.context);
 219 }
 220
 221 static inline void *libmemcached_realloc(const memcached_st *ptr, void *mem, const size_t size)
 222 {
 223   return ptr->allocators.realloc(ptr, mem, size, ptr->allocators.context);
 224 }
 225
 226 static inline void *libmemcached_calloc(const memcached_st *ptr, size_t nelem, size_t size)
 227 {
 228   return ptr->allocators.calloc(ptr, nelem, size, ptr->allocators.context);
 229 }
 230
 231 #ifdef __cplusplus
 232 }
 233 #endif
 234
 235 #endif /* __LIBMEMCACHED_COMMON_H__ */