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

   1 /*  vim:expandtab:shiftwidth=2:tabstop=2:smarttab:
   2  *
   3  *  LibMemcached
   4  *
   5  *  Copyright (C) 2011 Data Differential, http://datadifferential.com/
   6  *  Copyright (C) 2006-2009 Brian Aker
   7  *  All rights reserved.
   8  *
   9  *  Redistribution and use in source and binary forms, with or without
  10  *  modification, are permitted provided that the following conditions are
  11  *  met:
  12  *
  13  *      * Redistributions of source code must retain the above copyright
  14  *  notice, this list of conditions and the following disclaimer.
  15  *
  16  *      * Redistributions in binary form must reproduce the above
  17  *  copyright notice, this list of conditions and the following disclaimer
  18  *  in the documentation and/or other materials provided with the
  19  *  distribution.
  20  *
  21  *      * The names of its contributors may not be used to endorse or
  22  *  promote products derived from this software without specific prior
  23  *  written permission.
  24  *
  25  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  26  *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  27  *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  28  *  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  29  *  OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  30  *  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  31  *  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  32  *  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  33  *  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  34  *  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  35  *  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  36  *
  37  */
  38
  39 /*
  40   Common include file for libmemached
  41 */
  42
  43 #pragma once
  44
  45 #include <config.h>
  46
  47 #ifdef __cplusplus
  48 #include <cstdio>
  49 #include <cstdlib>
  50 #include <cstring>
  51 #include <ctime>
  52 #include <ctype.h>
  53 #else
  54 #include <stdio.h>
  55 #include <stdlib.h>
  56 #include <string.h>
  57 #include <time.h>
  58 #endif
  59
  60 #include <errno.h>
  61 #include <fcntl.h>
  62 #include <limits.h>
  63 #include <sys/types.h>
  64 #include <unistd.h>
  65
  66 #ifdef HAVE_STRINGS_H
  67 #include <strings.h>
  68 #endif
  69
  70 #include <libmemcached/memcached.h>
  71 #include <libmemcached/watchpoint.h>
  72 #include <libmemcached/is.h>
  73 #include <libmemcached/namespace.h>
  74
  75 #include <libmemcached/server_instance.h>
  76
  77 #ifdef HAVE_POLL_H
  78 #include <poll.h>
  79 #else
  80 #include "poll/poll.h"
  81 #endif
  82
  83
  84 #ifdef __cplusplus
  85 extern "C" {
  86 #endif
  87
  88 typedef memcached_return_t (*memcached_server_execute_fn)(memcached_st *ptr, memcached_server_write_instance_st server, void *context);
  89
  90 LIBMEMCACHED_LOCAL
  91 memcached_server_write_instance_st memcached_server_instance_fetch(memcached_st *ptr, uint32_t server_key);
  92
  93 LIBMEMCACHED_LOCAL
  94 memcached_return_t memcached_server_execute(memcached_st *ptr,
  95                                             memcached_server_execute_fn callback,
  96                                             void *context);
  97 #ifdef __cplusplus
  98 } // extern "C"
  99 #endif
 100
 101
 102 /* These are private not to be installed headers */
 103 #include <libmemcached/error.hpp>
 104 #include <libmemcached/memory.h>
 105 #include <libmemcached/io.h>
 106 #ifdef __cplusplus
 107 #include <libmemcached/string.hpp>
 108 #include <libmemcached/io.hpp>
 109 #include <libmemcached/do.hpp>
 110 #endif
 111 #include <libmemcached/internal.h>
 112 #include <libmemcached/array.h>
 113 #include <libmemcached/libmemcached_probes.h>
 114 #include <libmemcached/memcached/protocol_binary.h>
 115 #include <libmemcached/byteorder.h>
 116 #include <libmemcached/initialize_query.h>
 117 #include <libmemcached/response.h>
 118 #include <libmemcached/namespace.h>
 119
 120 #ifdef __cplusplus
 121 #include <libmemcached/backtrace.hpp>
 122 #include <libmemcached/assert.hpp>
 123 #include <libmemcached/server.hpp>
 124 #endif
 125
 126 #include <libmemcached/continuum.hpp>
 127
 128 #if !defined(__GNUC__) || (__GNUC__ == 2 && __GNUC_MINOR__ < 96)
 129
 130 #define likely(x)       if((x))
 131 #define unlikely(x)     if((x))
 132
 133 #else
 134
 135 #define likely(x)       if(__builtin_expect((x) != 0, 1))
 136 #define unlikely(x)     if(__builtin_expect((x) != 0, 0))
 137 #endif
 138
 139 #define MEMCACHED_BLOCK_SIZE 1024
 140 #define MEMCACHED_DEFAULT_COMMAND_SIZE 350
 141 #define SMALL_STRING_LEN 1024
 142 #define HUGE_STRING_LEN 8196
 143
 144 #ifdef __cplusplus
 145 extern "C" {
 146 #endif
 147
 148 LIBMEMCACHED_LOCAL
 149 memcached_return_t memcached_connect(memcached_server_write_instance_st ptr);
 150
 151 LIBMEMCACHED_LOCAL
 152 memcached_return_t run_distribution(memcached_st *ptr);
 153
 154 #define memcached_server_response_increment(A) (A)->cursor_active++
 155 #define memcached_server_response_decrement(A) (A)->cursor_active--
 156 #define memcached_server_response_reset(A) (A)->cursor_active=0
 157
 158 #ifdef __cplusplus
 159 LIBMEMCACHED_LOCAL
 160 memcached_return_t memcached_key_test(const memcached_st& memc,
 161                                       const char * const *keys,
 162                                       const size_t *key_length,
 163                                       size_t number_of_keys);
 164 #endif
 165
 166 LIBMEMCACHED_LOCAL
 167 memcached_return_t memcached_purge(memcached_server_write_instance_st ptr);
 168
 169
 170 static inline memcached_return_t memcached_validate_key_length(size_t key_length, bool binary)
 171 {
 172   if (key_length == 0)
 173   {
 174     return MEMCACHED_BAD_KEY_PROVIDED;
 175   }
 176
 177   if (binary)
 178   {
 179     if (key_length > 0xffff)
 180     {
 181       return MEMCACHED_BAD_KEY_PROVIDED;
 182     }
 183   }
 184   else
 185   {
 186     if (key_length >= MEMCACHED_MAX_KEY)
 187     {
 188       return MEMCACHED_BAD_KEY_PROVIDED;
 189     }
 190   }
 191
 192   return MEMCACHED_SUCCESS;
 193 }
 194
 195 #ifdef __cplusplus
 196 }
 197 #endif