1 | /* |
2 | * Copyright (c) 2009-2012, Pieter Noordhuis <pcnoordhuis at gmail dot com> |
3 | * Copyright (c) 2009-2012, Salvatore Sanfilippo <antirez at gmail dot com> |
4 | * All rights reserved. |
5 | * |
6 | * Redistribution and use in source and binary forms, with or without |
7 | * modification, are permitted provided that the following conditions are met: |
8 | * |
9 | * * Redistributions of source code must retain the above copyright notice, |
10 | * this list of conditions and the following disclaimer. |
11 | * * Redistributions in binary form must reproduce the above copyright |
12 | * notice, this list of conditions and the following disclaimer in the |
13 | * documentation and/or other materials provided with the distribution. |
14 | * * Neither the name of Redis nor the names of its contributors may be used |
15 | * to endorse or promote products derived from this software without |
16 | * specific prior written permission. |
17 | * |
18 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" |
19 | * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
20 | * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE |
21 | * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE |
22 | * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR |
23 | * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF |
24 | * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS |
25 | * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN |
26 | * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) |
27 | * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE |
28 | * POSSIBILITY OF SUCH DAMAGE. |
29 | */ |
30 | |
31 | #ifndef _ZIPLIST_H |
32 | #define _ZIPLIST_H |
33 | |
34 | #define ZIPLIST_HEAD 0 |
35 | #define ZIPLIST_TAIL 1 |
36 | |
37 | /* Each entry in the ziplist is either a string or an integer. */ |
38 | typedef struct { |
39 | /* When string is used, it is provided with the length (slen). */ |
40 | unsigned char *sval; |
41 | unsigned int slen; |
42 | /* When integer is used, 'sval' is NULL, and lval holds the value. */ |
43 | long long lval; |
44 | } ziplistEntry; |
45 | |
46 | unsigned char *ziplistNew(void); |
47 | unsigned char *ziplistMerge(unsigned char **first, unsigned char **second); |
48 | unsigned char *ziplistPush(unsigned char *zl, unsigned char *s, unsigned int slen, int where); |
49 | unsigned char *ziplistIndex(unsigned char *zl, int index); |
50 | unsigned char *ziplistNext(unsigned char *zl, unsigned char *p); |
51 | unsigned char *ziplistPrev(unsigned char *zl, unsigned char *p); |
52 | unsigned int ziplistGet(unsigned char *p, unsigned char **sval, unsigned int *slen, long long *lval); |
53 | unsigned char *ziplistInsert(unsigned char *zl, unsigned char *p, unsigned char *s, unsigned int slen); |
54 | unsigned char *ziplistDelete(unsigned char *zl, unsigned char **p); |
55 | unsigned char *ziplistDeleteRange(unsigned char *zl, int index, unsigned int num); |
56 | unsigned char *ziplistReplace(unsigned char *zl, unsigned char *p, unsigned char *s, unsigned int slen); |
57 | unsigned int ziplistCompare(unsigned char *p, unsigned char *s, unsigned int slen); |
58 | unsigned char *ziplistFind(unsigned char *zl, unsigned char *p, unsigned char *vstr, unsigned int vlen, unsigned int skip); |
59 | unsigned int ziplistLen(unsigned char *zl); |
60 | size_t ziplistBlobLen(unsigned char *zl); |
61 | void ziplistRepr(unsigned char *zl); |
62 | typedef int (*ziplistValidateEntryCB)(unsigned char* p, unsigned int head_count, void* userdata); |
63 | int ziplistValidateIntegrity(unsigned char *zl, size_t size, int deep, |
64 | ziplistValidateEntryCB entry_cb, void *cb_userdata); |
65 | void ziplistRandomPair(unsigned char *zl, unsigned long total_count, ziplistEntry *key, ziplistEntry *val); |
66 | void ziplistRandomPairs(unsigned char *zl, unsigned int count, ziplistEntry *keys, ziplistEntry *vals); |
67 | unsigned int ziplistRandomPairsUnique(unsigned char *zl, unsigned int count, ziplistEntry *keys, ziplistEntry *vals); |
68 | int ziplistSafeToAdd(unsigned char* zl, size_t add); |
69 | |
70 | #ifdef REDIS_TEST |
71 | int ziplistTest(int argc, char *argv[], int flags); |
72 | #endif |
73 | |
74 | #endif /* _ZIPLIST_H */ |
75 | |