Simple dead code removal and fix for analysis structure always being free()
[m6w6/libmemcached] / 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 /* These are private not to be installed headers */
58 #include "libmemcached/io.h"
59 #include "libmemcached/internal.h"
60 #include "libmemcached/libmemcached_probes.h"
61 #include "libmemcached/memcached/protocol_binary.h"
62 #include "libmemcached/byteorder.h"
63
64 /* string value */
65 struct memcached_continuum_item_st
66 {
67 uint32_t index;
68 uint32_t value;
69 };
70
71
72 #if !defined(__GNUC__) || (__GNUC__ == 2 && __GNUC_MINOR__ < 96)
73
74 #define likely(x) if((x))
75 #define unlikely(x) if((x))
76
77 #else
78
79 #define likely(x) if(__builtin_expect((x) != 0, 1))
80 #define unlikely(x) if(__builtin_expect((x) != 0, 0))
81 #endif
82
83
84 #define MEMCACHED_BLOCK_SIZE 1024
85 #define MEMCACHED_DEFAULT_COMMAND_SIZE 350
86 #define SMALL_STRING_LEN 1024
87 #define HUGE_STRING_LEN 8196
88
89 /* Hashing algo */
90
91 LIBMEMCACHED_LOCAL
92 void md5_signature(const unsigned char *key, unsigned int length, unsigned char *result);
93 LIBMEMCACHED_LOCAL
94 uint32_t hash_crc32(const char *data,
95 size_t data_len);
96 #ifdef HAVE_HSIEH_HASH
97 LIBMEMCACHED_LOCAL
98 uint32_t hsieh_hash(const char *key, size_t key_length);
99 #endif
100 LIBMEMCACHED_LOCAL
101 uint32_t murmur_hash(const char *key, size_t key_length);
102 LIBMEMCACHED_LOCAL
103 uint32_t jenkins_hash(const void *key, size_t length, uint32_t initval);
104
105 LIBMEMCACHED_LOCAL
106 memcached_return_t memcached_connect(memcached_server_st *ptr);
107 LIBMEMCACHED_LOCAL
108 memcached_return_t memcached_response(memcached_server_st *ptr,
109 char *buffer, size_t buffer_length,
110 memcached_result_st *result);
111 LIBMEMCACHED_LOCAL
112 void memcached_quit_server(memcached_server_st *ptr, uint8_t io_death);
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 LIBMEMCACHED_LOCAL
119 memcached_return_t memcached_do(memcached_server_st *ptr, const void *commmand,
120 size_t command_length, uint8_t with_flush);
121 LIBMEMCACHED_LOCAL
122 memcached_return_t value_fetch(memcached_server_st *ptr,
123 char *buffer,
124 memcached_result_st *result);
125 LIBMEMCACHED_LOCAL
126 void server_list_free(memcached_st *ptr, memcached_server_st *servers);
127
128 LIBMEMCACHED_LOCAL
129 memcached_return_t memcached_key_test(const char * const *keys,
130 const size_t *key_length,
131 size_t number_of_keys);
132
133
134 LIBMEMCACHED_LOCAL
135 uint32_t generate_hash(memcached_st *ptr, const char *key, size_t key_length);
136
137 LIBMEMCACHED_LOCAL
138 memcached_return_t memcached_purge(memcached_server_st *ptr);
139
140 static inline memcached_return_t memcached_validate_key_length(size_t key_length, bool binary)
141 {
142 unlikely (key_length == 0)
143 return MEMCACHED_BAD_KEY_PROVIDED;
144
145 if (binary)
146 {
147 unlikely (key_length > 0xffff)
148 return MEMCACHED_BAD_KEY_PROVIDED;
149 }
150 else
151 {
152 unlikely (key_length >= MEMCACHED_MAX_KEY)
153 return MEMCACHED_BAD_KEY_PROVIDED;
154 }
155
156 return MEMCACHED_SUCCESS;
157 }
158
159 #endif /* LIBMEMCACHED_COMMON_H */