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