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