f4f6b6d65c
also, clean up redisContextInit -- we're just zeoring the struct
1025 lines
30 KiB
C
1025 lines
30 KiB
C
/*
|
|
* Copyright (c) 2009-2011, Salvatore Sanfilippo <antirez at gmail dot com>
|
|
* Copyright (c) 2010-2014, Pieter Noordhuis <pcnoordhuis at gmail dot com>
|
|
* Copyright (c) 2015, Matt Stancliff <matt at genges dot com>,
|
|
* Jan-Erik Rediger <janerik at fnordig dot com>
|
|
*
|
|
* All rights reserved.
|
|
*
|
|
* Redistribution and use in source and binary forms, with or without
|
|
* modification, are permitted provided that the following conditions are met:
|
|
*
|
|
* * Redistributions of source code must retain the above copyright notice,
|
|
* this list of conditions and the following disclaimer.
|
|
* * Redistributions in binary form must reproduce the above copyright
|
|
* notice, this list of conditions and the following disclaimer in the
|
|
* documentation and/or other materials provided with the distribution.
|
|
* * Neither the name of Redis nor the names of its contributors may be used
|
|
* to endorse or promote products derived from this software without
|
|
* specific prior written permission.
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
|
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
|
|
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
|
|
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
|
|
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
|
|
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
|
|
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
|
|
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
|
* POSSIBILITY OF SUCH DAMAGE.
|
|
*/
|
|
|
|
#include "fmacros.h"
|
|
#include <string.h>
|
|
#include <stdlib.h>
|
|
#include <unistd.h>
|
|
#include <assert.h>
|
|
#include <errno.h>
|
|
#include <ctype.h>
|
|
|
|
#include "hiredis.h"
|
|
#include "net.h"
|
|
#include "sds.h"
|
|
#include "sslio.h"
|
|
|
|
static redisReply *createReplyObject(int type);
|
|
static void *createStringObject(const redisReadTask *task, char *str, size_t len);
|
|
static void *createArrayObject(const redisReadTask *task, int elements);
|
|
static void *createIntegerObject(const redisReadTask *task, long long value);
|
|
static void *createNilObject(const redisReadTask *task);
|
|
|
|
/* Default set of functions to build the reply. Keep in mind that such a
|
|
* function returning NULL is interpreted as OOM. */
|
|
static redisReplyObjectFunctions defaultFunctions = {
|
|
createStringObject,
|
|
createArrayObject,
|
|
createIntegerObject,
|
|
createNilObject,
|
|
freeReplyObject
|
|
};
|
|
|
|
/* Create a reply object */
|
|
static redisReply *createReplyObject(int type) {
|
|
redisReply *r = calloc(1,sizeof(*r));
|
|
|
|
if (r == NULL)
|
|
return NULL;
|
|
|
|
r->type = type;
|
|
return r;
|
|
}
|
|
|
|
/* Free a reply object */
|
|
void freeReplyObject(void *reply) {
|
|
redisReply *r = reply;
|
|
size_t j;
|
|
|
|
if (r == NULL)
|
|
return;
|
|
|
|
switch(r->type) {
|
|
case REDIS_REPLY_INTEGER:
|
|
break; /* Nothing to free */
|
|
case REDIS_REPLY_ARRAY:
|
|
if (r->element != NULL) {
|
|
for (j = 0; j < r->elements; j++)
|
|
freeReplyObject(r->element[j]);
|
|
free(r->element);
|
|
}
|
|
break;
|
|
case REDIS_REPLY_ERROR:
|
|
case REDIS_REPLY_STATUS:
|
|
case REDIS_REPLY_STRING:
|
|
free(r->str);
|
|
break;
|
|
}
|
|
free(r);
|
|
}
|
|
|
|
static void *createStringObject(const redisReadTask *task, char *str, size_t len) {
|
|
redisReply *r, *parent;
|
|
char *buf;
|
|
|
|
r = createReplyObject(task->type);
|
|
if (r == NULL)
|
|
return NULL;
|
|
|
|
buf = malloc(len+1);
|
|
if (buf == NULL) {
|
|
freeReplyObject(r);
|
|
return NULL;
|
|
}
|
|
|
|
assert(task->type == REDIS_REPLY_ERROR ||
|
|
task->type == REDIS_REPLY_STATUS ||
|
|
task->type == REDIS_REPLY_STRING);
|
|
|
|
/* Copy string value */
|
|
memcpy(buf,str,len);
|
|
buf[len] = '\0';
|
|
r->str = buf;
|
|
r->len = len;
|
|
|
|
if (task->parent) {
|
|
parent = task->parent->obj;
|
|
assert(parent->type == REDIS_REPLY_ARRAY);
|
|
parent->element[task->idx] = r;
|
|
}
|
|
return r;
|
|
}
|
|
|
|
static void *createArrayObject(const redisReadTask *task, int elements) {
|
|
redisReply *r, *parent;
|
|
|
|
r = createReplyObject(REDIS_REPLY_ARRAY);
|
|
if (r == NULL)
|
|
return NULL;
|
|
|
|
if (elements > 0) {
|
|
r->element = calloc(elements,sizeof(redisReply*));
|
|
if (r->element == NULL) {
|
|
freeReplyObject(r);
|
|
return NULL;
|
|
}
|
|
}
|
|
|
|
r->elements = elements;
|
|
|
|
if (task->parent) {
|
|
parent = task->parent->obj;
|
|
assert(parent->type == REDIS_REPLY_ARRAY);
|
|
parent->element[task->idx] = r;
|
|
}
|
|
return r;
|
|
}
|
|
|
|
static void *createIntegerObject(const redisReadTask *task, long long value) {
|
|
redisReply *r, *parent;
|
|
|
|
r = createReplyObject(REDIS_REPLY_INTEGER);
|
|
if (r == NULL)
|
|
return NULL;
|
|
|
|
r->integer = value;
|
|
|
|
if (task->parent) {
|
|
parent = task->parent->obj;
|
|
assert(parent->type == REDIS_REPLY_ARRAY);
|
|
parent->element[task->idx] = r;
|
|
}
|
|
return r;
|
|
}
|
|
|
|
static void *createNilObject(const redisReadTask *task) {
|
|
redisReply *r, *parent;
|
|
|
|
r = createReplyObject(REDIS_REPLY_NIL);
|
|
if (r == NULL)
|
|
return NULL;
|
|
|
|
if (task->parent) {
|
|
parent = task->parent->obj;
|
|
assert(parent->type == REDIS_REPLY_ARRAY);
|
|
parent->element[task->idx] = r;
|
|
}
|
|
return r;
|
|
}
|
|
|
|
/* Return the number of digits of 'v' when converted to string in radix 10.
|
|
* Implementation borrowed from link in redis/src/util.c:string2ll(). */
|
|
static uint32_t countDigits(uint64_t v) {
|
|
uint32_t result = 1;
|
|
for (;;) {
|
|
if (v < 10) return result;
|
|
if (v < 100) return result + 1;
|
|
if (v < 1000) return result + 2;
|
|
if (v < 10000) return result + 3;
|
|
v /= 10000U;
|
|
result += 4;
|
|
}
|
|
}
|
|
|
|
/* Helper that calculates the bulk length given a certain string length. */
|
|
static size_t bulklen(size_t len) {
|
|
return 1+countDigits(len)+2+len+2;
|
|
}
|
|
|
|
int redisvFormatCommand(char **target, const char *format, va_list ap) {
|
|
const char *c = format;
|
|
char *cmd = NULL; /* final command */
|
|
int pos; /* position in final command */
|
|
sds curarg, newarg; /* current argument */
|
|
int touched = 0; /* was the current argument touched? */
|
|
char **curargv = NULL, **newargv = NULL;
|
|
int argc = 0;
|
|
int totlen = 0;
|
|
int error_type = 0; /* 0 = no error; -1 = memory error; -2 = format error */
|
|
int j;
|
|
|
|
/* Abort if there is not target to set */
|
|
if (target == NULL)
|
|
return -1;
|
|
|
|
/* Build the command string accordingly to protocol */
|
|
curarg = sdsempty();
|
|
if (curarg == NULL)
|
|
return -1;
|
|
|
|
while(*c != '\0') {
|
|
if (*c != '%' || c[1] == '\0') {
|
|
if (*c == ' ') {
|
|
if (touched) {
|
|
newargv = realloc(curargv,sizeof(char*)*(argc+1));
|
|
if (newargv == NULL) goto memory_err;
|
|
curargv = newargv;
|
|
curargv[argc++] = curarg;
|
|
totlen += bulklen(sdslen(curarg));
|
|
|
|
/* curarg is put in argv so it can be overwritten. */
|
|
curarg = sdsempty();
|
|
if (curarg == NULL) goto memory_err;
|
|
touched = 0;
|
|
}
|
|
} else {
|
|
newarg = sdscatlen(curarg,c,1);
|
|
if (newarg == NULL) goto memory_err;
|
|
curarg = newarg;
|
|
touched = 1;
|
|
}
|
|
} else {
|
|
char *arg;
|
|
size_t size;
|
|
|
|
/* Set newarg so it can be checked even if it is not touched. */
|
|
newarg = curarg;
|
|
|
|
switch(c[1]) {
|
|
case 's':
|
|
arg = va_arg(ap,char*);
|
|
size = strlen(arg);
|
|
if (size > 0)
|
|
newarg = sdscatlen(curarg,arg,size);
|
|
break;
|
|
case 'b':
|
|
arg = va_arg(ap,char*);
|
|
size = va_arg(ap,size_t);
|
|
if (size > 0)
|
|
newarg = sdscatlen(curarg,arg,size);
|
|
break;
|
|
case '%':
|
|
newarg = sdscat(curarg,"%");
|
|
break;
|
|
default:
|
|
/* Try to detect printf format */
|
|
{
|
|
static const char intfmts[] = "diouxX";
|
|
static const char flags[] = "#0-+ ";
|
|
char _format[16];
|
|
const char *_p = c+1;
|
|
size_t _l = 0;
|
|
va_list _cpy;
|
|
|
|
/* Flags */
|
|
while (*_p != '\0' && strchr(flags,*_p) != NULL) _p++;
|
|
|
|
/* Field width */
|
|
while (*_p != '\0' && isdigit(*_p)) _p++;
|
|
|
|
/* Precision */
|
|
if (*_p == '.') {
|
|
_p++;
|
|
while (*_p != '\0' && isdigit(*_p)) _p++;
|
|
}
|
|
|
|
/* Copy va_list before consuming with va_arg */
|
|
va_copy(_cpy,ap);
|
|
|
|
/* Integer conversion (without modifiers) */
|
|
if (strchr(intfmts,*_p) != NULL) {
|
|
va_arg(ap,int);
|
|
goto fmt_valid;
|
|
}
|
|
|
|
/* Double conversion (without modifiers) */
|
|
if (strchr("eEfFgGaA",*_p) != NULL) {
|
|
va_arg(ap,double);
|
|
goto fmt_valid;
|
|
}
|
|
|
|
/* Size: char */
|
|
if (_p[0] == 'h' && _p[1] == 'h') {
|
|
_p += 2;
|
|
if (*_p != '\0' && strchr(intfmts,*_p) != NULL) {
|
|
va_arg(ap,int); /* char gets promoted to int */
|
|
goto fmt_valid;
|
|
}
|
|
goto fmt_invalid;
|
|
}
|
|
|
|
/* Size: short */
|
|
if (_p[0] == 'h') {
|
|
_p += 1;
|
|
if (*_p != '\0' && strchr(intfmts,*_p) != NULL) {
|
|
va_arg(ap,int); /* short gets promoted to int */
|
|
goto fmt_valid;
|
|
}
|
|
goto fmt_invalid;
|
|
}
|
|
|
|
/* Size: long long */
|
|
if (_p[0] == 'l' && _p[1] == 'l') {
|
|
_p += 2;
|
|
if (*_p != '\0' && strchr(intfmts,*_p) != NULL) {
|
|
va_arg(ap,long long);
|
|
goto fmt_valid;
|
|
}
|
|
goto fmt_invalid;
|
|
}
|
|
|
|
/* Size: long */
|
|
if (_p[0] == 'l') {
|
|
_p += 1;
|
|
if (*_p != '\0' && strchr(intfmts,*_p) != NULL) {
|
|
va_arg(ap,long);
|
|
goto fmt_valid;
|
|
}
|
|
goto fmt_invalid;
|
|
}
|
|
|
|
fmt_invalid:
|
|
va_end(_cpy);
|
|
goto format_err;
|
|
|
|
fmt_valid:
|
|
_l = (_p+1)-c;
|
|
if (_l < sizeof(_format)-2) {
|
|
memcpy(_format,c,_l);
|
|
_format[_l] = '\0';
|
|
newarg = sdscatvprintf(curarg,_format,_cpy);
|
|
|
|
/* Update current position (note: outer blocks
|
|
* increment c twice so compensate here) */
|
|
c = _p-1;
|
|
}
|
|
|
|
va_end(_cpy);
|
|
break;
|
|
}
|
|
}
|
|
|
|
if (newarg == NULL) goto memory_err;
|
|
curarg = newarg;
|
|
|
|
touched = 1;
|
|
c++;
|
|
}
|
|
c++;
|
|
}
|
|
|
|
/* Add the last argument if needed */
|
|
if (touched) {
|
|
newargv = realloc(curargv,sizeof(char*)*(argc+1));
|
|
if (newargv == NULL) goto memory_err;
|
|
curargv = newargv;
|
|
curargv[argc++] = curarg;
|
|
totlen += bulklen(sdslen(curarg));
|
|
} else {
|
|
sdsfree(curarg);
|
|
}
|
|
|
|
/* Clear curarg because it was put in curargv or was free'd. */
|
|
curarg = NULL;
|
|
|
|
/* Add bytes needed to hold multi bulk count */
|
|
totlen += 1+countDigits(argc)+2;
|
|
|
|
/* Build the command at protocol level */
|
|
cmd = malloc(totlen+1);
|
|
if (cmd == NULL) goto memory_err;
|
|
|
|
pos = sprintf(cmd,"*%d\r\n",argc);
|
|
for (j = 0; j < argc; j++) {
|
|
pos += sprintf(cmd+pos,"$%zu\r\n",sdslen(curargv[j]));
|
|
memcpy(cmd+pos,curargv[j],sdslen(curargv[j]));
|
|
pos += sdslen(curargv[j]);
|
|
sdsfree(curargv[j]);
|
|
cmd[pos++] = '\r';
|
|
cmd[pos++] = '\n';
|
|
}
|
|
assert(pos == totlen);
|
|
cmd[pos] = '\0';
|
|
|
|
free(curargv);
|
|
*target = cmd;
|
|
return totlen;
|
|
|
|
format_err:
|
|
error_type = -2;
|
|
goto cleanup;
|
|
|
|
memory_err:
|
|
error_type = -1;
|
|
goto cleanup;
|
|
|
|
cleanup:
|
|
if (curargv) {
|
|
while(argc--)
|
|
sdsfree(curargv[argc]);
|
|
free(curargv);
|
|
}
|
|
|
|
sdsfree(curarg);
|
|
free(cmd);
|
|
|
|
return error_type;
|
|
}
|
|
|
|
/* Format a command according to the Redis protocol. This function
|
|
* takes a format similar to printf:
|
|
*
|
|
* %s represents a C null terminated string you want to interpolate
|
|
* %b represents a binary safe string
|
|
*
|
|
* When using %b you need to provide both the pointer to the string
|
|
* and the length in bytes as a size_t. Examples:
|
|
*
|
|
* len = redisFormatCommand(target, "GET %s", mykey);
|
|
* len = redisFormatCommand(target, "SET %s %b", mykey, myval, myvallen);
|
|
*/
|
|
int redisFormatCommand(char **target, const char *format, ...) {
|
|
va_list ap;
|
|
int len;
|
|
va_start(ap,format);
|
|
len = redisvFormatCommand(target,format,ap);
|
|
va_end(ap);
|
|
|
|
/* The API says "-1" means bad result, but we now also return "-2" in some
|
|
* cases. Force the return value to always be -1. */
|
|
if (len < 0)
|
|
len = -1;
|
|
|
|
return len;
|
|
}
|
|
|
|
/* Format a command according to the Redis protocol using an sds string and
|
|
* sdscatfmt for the processing of arguments. This function takes the
|
|
* number of arguments, an array with arguments and an array with their
|
|
* lengths. If the latter is set to NULL, strlen will be used to compute the
|
|
* argument lengths.
|
|
*/
|
|
int redisFormatSdsCommandArgv(sds *target, int argc, const char **argv,
|
|
const size_t *argvlen)
|
|
{
|
|
sds cmd;
|
|
unsigned long long totlen;
|
|
int j;
|
|
size_t len;
|
|
|
|
/* Abort on a NULL target */
|
|
if (target == NULL)
|
|
return -1;
|
|
|
|
/* Calculate our total size */
|
|
totlen = 1+countDigits(argc)+2;
|
|
for (j = 0; j < argc; j++) {
|
|
len = argvlen ? argvlen[j] : strlen(argv[j]);
|
|
totlen += bulklen(len);
|
|
}
|
|
|
|
/* Use an SDS string for command construction */
|
|
cmd = sdsempty();
|
|
if (cmd == NULL)
|
|
return -1;
|
|
|
|
/* We already know how much storage we need */
|
|
cmd = sdsMakeRoomFor(cmd, totlen);
|
|
if (cmd == NULL)
|
|
return -1;
|
|
|
|
/* Construct command */
|
|
cmd = sdscatfmt(cmd, "*%i\r\n", argc);
|
|
for (j=0; j < argc; j++) {
|
|
len = argvlen ? argvlen[j] : strlen(argv[j]);
|
|
cmd = sdscatfmt(cmd, "$%u\r\n", len);
|
|
cmd = sdscatlen(cmd, argv[j], len);
|
|
cmd = sdscatlen(cmd, "\r\n", sizeof("\r\n")-1);
|
|
}
|
|
|
|
assert(sdslen(cmd)==totlen);
|
|
|
|
*target = cmd;
|
|
return totlen;
|
|
}
|
|
|
|
void redisFreeSdsCommand(sds cmd) {
|
|
sdsfree(cmd);
|
|
}
|
|
|
|
/* Format a command according to the Redis protocol. This function takes the
|
|
* number of arguments, an array with arguments and an array with their
|
|
* lengths. If the latter is set to NULL, strlen will be used to compute the
|
|
* argument lengths.
|
|
*/
|
|
int redisFormatCommandArgv(char **target, int argc, const char **argv, const size_t *argvlen) {
|
|
char *cmd = NULL; /* final command */
|
|
int pos; /* position in final command */
|
|
size_t len;
|
|
int totlen, j;
|
|
|
|
/* Abort on a NULL target */
|
|
if (target == NULL)
|
|
return -1;
|
|
|
|
/* Calculate number of bytes needed for the command */
|
|
totlen = 1+countDigits(argc)+2;
|
|
for (j = 0; j < argc; j++) {
|
|
len = argvlen ? argvlen[j] : strlen(argv[j]);
|
|
totlen += bulklen(len);
|
|
}
|
|
|
|
/* Build the command at protocol level */
|
|
cmd = malloc(totlen+1);
|
|
if (cmd == NULL)
|
|
return -1;
|
|
|
|
pos = sprintf(cmd,"*%d\r\n",argc);
|
|
for (j = 0; j < argc; j++) {
|
|
len = argvlen ? argvlen[j] : strlen(argv[j]);
|
|
pos += sprintf(cmd+pos,"$%zu\r\n",len);
|
|
memcpy(cmd+pos,argv[j],len);
|
|
pos += len;
|
|
cmd[pos++] = '\r';
|
|
cmd[pos++] = '\n';
|
|
}
|
|
assert(pos == totlen);
|
|
cmd[pos] = '\0';
|
|
|
|
*target = cmd;
|
|
return totlen;
|
|
}
|
|
|
|
void redisFreeCommand(char *cmd) {
|
|
free(cmd);
|
|
}
|
|
|
|
void __redisSetError(redisContext *c, int type, const char *str) {
|
|
size_t len;
|
|
|
|
c->err = type;
|
|
if (str != NULL) {
|
|
len = strlen(str);
|
|
len = len < (sizeof(c->errstr)-1) ? len : (sizeof(c->errstr)-1);
|
|
memcpy(c->errstr,str,len);
|
|
c->errstr[len] = '\0';
|
|
} else {
|
|
/* Only REDIS_ERR_IO may lack a description! */
|
|
assert(type == REDIS_ERR_IO);
|
|
strerror_r(errno, c->errstr, sizeof(c->errstr));
|
|
}
|
|
}
|
|
|
|
redisReader *redisReaderCreate(void) {
|
|
return redisReaderCreateWithFunctions(&defaultFunctions);
|
|
}
|
|
|
|
static redisContext *redisContextInit(const redisOptions *options) {
|
|
redisContext *c;
|
|
|
|
c = calloc(1, sizeof(*c));
|
|
if (c == NULL)
|
|
return NULL;
|
|
|
|
c->obuf = sdsempty();
|
|
c->reader = redisReaderCreate();
|
|
|
|
if (c->obuf == NULL || c->reader == NULL) {
|
|
redisFree(c);
|
|
return NULL;
|
|
}
|
|
(void)options; /* options are used in other functions */
|
|
return c;
|
|
}
|
|
|
|
void redisFree(redisContext *c) {
|
|
if (c == NULL)
|
|
return;
|
|
if (c->fd > 0)
|
|
close(c->fd);
|
|
|
|
sdsfree(c->obuf);
|
|
redisReaderFree(c->reader);
|
|
free(c->tcp.host);
|
|
free(c->tcp.source_addr);
|
|
free(c->unix_sock.path);
|
|
free(c->timeout);
|
|
free(c->saddr);
|
|
if (c->ssl) {
|
|
redisFreeSsl(c->ssl);
|
|
}
|
|
}
|
|
|
|
int redisFreeKeepFd(redisContext *c) {
|
|
int fd = c->fd;
|
|
c->fd = -1;
|
|
redisFree(c);
|
|
return fd;
|
|
}
|
|
|
|
int redisReconnect(redisContext *c) {
|
|
c->err = 0;
|
|
memset(c->errstr, '\0', strlen(c->errstr));
|
|
|
|
if (c->fd > 0) {
|
|
close(c->fd);
|
|
}
|
|
|
|
sdsfree(c->obuf);
|
|
redisReaderFree(c->reader);
|
|
|
|
c->obuf = sdsempty();
|
|
c->reader = redisReaderCreate();
|
|
|
|
if (c->connection_type == REDIS_CONN_TCP) {
|
|
return redisContextConnectBindTcp(c, c->tcp.host, c->tcp.port,
|
|
c->timeout, c->tcp.source_addr);
|
|
} else if (c->connection_type == REDIS_CONN_UNIX) {
|
|
return redisContextConnectUnix(c, c->unix_sock.path, c->timeout);
|
|
} else {
|
|
/* Something bad happened here and shouldn't have. There isn't
|
|
enough information in the context to reconnect. */
|
|
__redisSetError(c,REDIS_ERR_OTHER,"Not enough information to reconnect");
|
|
}
|
|
|
|
return REDIS_ERR;
|
|
}
|
|
|
|
redisContext *redisConnectWithOptions(const redisOptions *options) {
|
|
redisContext *c = redisContextInit(options);
|
|
if (c == NULL) {
|
|
return NULL;
|
|
}
|
|
if (!(options->options & REDIS_OPT_NONBLOCK)) {
|
|
c->flags |= REDIS_BLOCK;
|
|
}
|
|
if (options->options & REDIS_OPT_REUSEADDR) {
|
|
c->flags |= REDIS_REUSEADDR;
|
|
}
|
|
|
|
if (options->type == REDIS_CONN_TCP) {
|
|
redisContextConnectBindTcp(c, options->endpoint.tcp.ip,
|
|
options->endpoint.tcp.port, options->timeout,
|
|
options->endpoint.tcp.source_addr);
|
|
} else if (options->type == REDIS_CONN_UNIX) {
|
|
redisContextConnectUnix(c, options->endpoint.unix_socket,
|
|
options->timeout);
|
|
} else if (options->type == REDIS_CONN_USERFD) {
|
|
c->fd = options->endpoint.fd;
|
|
c->flags |= REDIS_CONNECTED;
|
|
} else {
|
|
// Unknown type - FIXME - FREE
|
|
return NULL;
|
|
}
|
|
return c;
|
|
}
|
|
|
|
/* Connect to a Redis instance. On error the field error in the returned
|
|
* context will be set to the return value of the error function.
|
|
* When no set of reply functions is given, the default set will be used. */
|
|
redisContext *redisConnect(const char *ip, int port) {
|
|
redisOptions options = {0};
|
|
REDIS_OPTIONS_SET_TCP(&options, ip, port);
|
|
return redisConnectWithOptions(&options);
|
|
}
|
|
|
|
redisContext *redisConnectWithTimeout(const char *ip, int port, const struct timeval tv) {
|
|
redisOptions options = {0};
|
|
REDIS_OPTIONS_SET_TCP(&options, ip, port);
|
|
options.timeout = &tv;
|
|
return redisConnectWithOptions(&options);
|
|
}
|
|
|
|
redisContext *redisConnectNonBlock(const char *ip, int port) {
|
|
redisOptions options = {0};
|
|
REDIS_OPTIONS_SET_TCP(&options, ip, port);
|
|
options.options |= REDIS_OPT_NONBLOCK;
|
|
return redisConnectWithOptions(&options);
|
|
}
|
|
|
|
redisContext *redisConnectBindNonBlock(const char *ip, int port,
|
|
const char *source_addr) {
|
|
redisOptions options = {0};
|
|
REDIS_OPTIONS_SET_TCP(&options, ip, port);
|
|
options.endpoint.tcp.source_addr = source_addr;
|
|
options.options |= REDIS_OPT_NONBLOCK;
|
|
return redisConnectWithOptions(&options);
|
|
}
|
|
|
|
redisContext *redisConnectBindNonBlockWithReuse(const char *ip, int port,
|
|
const char *source_addr) {
|
|
redisOptions options = {0};
|
|
REDIS_OPTIONS_SET_TCP(&options, ip, port);
|
|
options.endpoint.tcp.source_addr = source_addr;
|
|
options.options |= REDIS_OPT_NONBLOCK|REDIS_OPT_REUSEADDR;
|
|
return redisConnectWithOptions(&options);
|
|
}
|
|
|
|
redisContext *redisConnectUnix(const char *path) {
|
|
redisOptions options = {0};
|
|
REDIS_OPTIONS_SET_UNIX(&options, path);
|
|
return redisConnectWithOptions(&options);
|
|
}
|
|
|
|
redisContext *redisConnectUnixWithTimeout(const char *path, const struct timeval tv) {
|
|
redisOptions options = {0};
|
|
REDIS_OPTIONS_SET_UNIX(&options, path);
|
|
options.timeout = &tv;
|
|
return redisConnectWithOptions(&options);
|
|
}
|
|
|
|
redisContext *redisConnectUnixNonBlock(const char *path) {
|
|
redisOptions options = {0};
|
|
REDIS_OPTIONS_SET_UNIX(&options, path);
|
|
options.options |= REDIS_OPT_NONBLOCK;
|
|
return redisConnectWithOptions(&options);
|
|
}
|
|
|
|
redisContext *redisConnectFd(int fd) {
|
|
redisOptions options = {0};
|
|
options.type = REDIS_CONN_USERFD;
|
|
options.endpoint.fd = fd;
|
|
return redisConnectWithOptions(&options);
|
|
}
|
|
|
|
int redisSecureConnection(redisContext *c, const char *caPath,
|
|
const char *certPath, const char *keyPath) {
|
|
return redisSslCreate(c, caPath, certPath, keyPath);
|
|
}
|
|
|
|
/* Set read/write timeout on a blocking socket. */
|
|
int redisSetTimeout(redisContext *c, const struct timeval tv) {
|
|
if (c->flags & REDIS_BLOCK)
|
|
return redisContextSetTimeout(c,tv);
|
|
return REDIS_ERR;
|
|
}
|
|
|
|
/* Enable connection KeepAlive. */
|
|
int redisEnableKeepAlive(redisContext *c) {
|
|
if (redisKeepAlive(c, REDIS_KEEPALIVE_INTERVAL) != REDIS_OK)
|
|
return REDIS_ERR;
|
|
return REDIS_OK;
|
|
}
|
|
|
|
static int rawRead(redisContext *c, char *buf, size_t bufcap) {
|
|
int nread = read(c->fd, buf, bufcap);
|
|
if (nread == -1) {
|
|
if ((errno == EAGAIN && !(c->flags & REDIS_BLOCK)) || (errno == EINTR)) {
|
|
/* Try again later */
|
|
return 0;
|
|
} else {
|
|
__redisSetError(c, REDIS_ERR_IO, NULL);
|
|
return -1;
|
|
}
|
|
} else if (nread == 0) {
|
|
__redisSetError(c, REDIS_ERR_EOF, "Server closed the connection");
|
|
return -1;
|
|
} else {
|
|
return nread;
|
|
}
|
|
}
|
|
|
|
/* Use this function to handle a read event on the descriptor. It will try
|
|
* and read some bytes from the socket and feed them to the reply parser.
|
|
*
|
|
* After this function is called, you may use redisGetReplyFromReader to
|
|
* see if there is a reply available. */
|
|
int redisBufferRead(redisContext *c) {
|
|
char buf[1024*16];
|
|
int nread;
|
|
|
|
/* Return early when the context has seen an error. */
|
|
if (c->err)
|
|
return REDIS_ERR;
|
|
|
|
nread = c->flags & REDIS_SSL ?
|
|
redisSslRead(c, buf, sizeof(buf)) : rawRead(c, buf, sizeof(buf));
|
|
if (nread > 0) {
|
|
if (redisReaderFeed(c->reader, buf, nread) != REDIS_OK) {
|
|
__redisSetError(c, c->reader->err, c->reader->errstr);
|
|
return REDIS_ERR;
|
|
} else {
|
|
}
|
|
} else if (nread < 0) {
|
|
return REDIS_ERR;
|
|
}
|
|
return REDIS_OK;
|
|
}
|
|
|
|
static int rawWrite(redisContext *c) {
|
|
int nwritten = write(c->fd, c->obuf, sdslen(c->obuf));
|
|
if (nwritten < 0) {
|
|
if ((errno == EAGAIN && !(c->flags & REDIS_BLOCK)) || (errno == EINTR)) {
|
|
/* Try again later */
|
|
} else {
|
|
__redisSetError(c, REDIS_ERR_IO, NULL);
|
|
return -1;
|
|
}
|
|
}
|
|
return nwritten;
|
|
}
|
|
|
|
/* Write the output buffer to the socket.
|
|
*
|
|
* Returns REDIS_OK when the buffer is empty, or (a part of) the buffer was
|
|
* successfully written to the socket. When the buffer is empty after the
|
|
* write operation, "done" is set to 1 (if given).
|
|
*
|
|
* Returns REDIS_ERR if an error occurred trying to write and sets
|
|
* c->errstr to hold the appropriate error string.
|
|
*/
|
|
int redisBufferWrite(redisContext *c, int *done) {
|
|
|
|
/* Return early when the context has seen an error. */
|
|
if (c->err)
|
|
return REDIS_ERR;
|
|
|
|
if (sdslen(c->obuf) > 0) {
|
|
int nwritten = (c->flags & REDIS_SSL) ? redisSslWrite(c) : rawWrite(c);
|
|
if (nwritten < 0) {
|
|
return REDIS_ERR;
|
|
} else if (nwritten > 0) {
|
|
if (nwritten == (signed)sdslen(c->obuf)) {
|
|
sdsfree(c->obuf);
|
|
c->obuf = sdsempty();
|
|
} else {
|
|
sdsrange(c->obuf,nwritten,-1);
|
|
}
|
|
}
|
|
}
|
|
if (done != NULL) *done = (sdslen(c->obuf) == 0);
|
|
return REDIS_OK;
|
|
}
|
|
|
|
/* Internal helper function to try and get a reply from the reader,
|
|
* or set an error in the context otherwise. */
|
|
int redisGetReplyFromReader(redisContext *c, void **reply) {
|
|
if (redisReaderGetReply(c->reader,reply) == REDIS_ERR) {
|
|
__redisSetError(c,c->reader->err,c->reader->errstr);
|
|
return REDIS_ERR;
|
|
}
|
|
return REDIS_OK;
|
|
}
|
|
|
|
int redisGetReply(redisContext *c, void **reply) {
|
|
int wdone = 0;
|
|
void *aux = NULL;
|
|
|
|
/* Try to read pending replies */
|
|
if (redisGetReplyFromReader(c,&aux) == REDIS_ERR)
|
|
return REDIS_ERR;
|
|
|
|
/* For the blocking context, flush output buffer and read reply */
|
|
if (aux == NULL && c->flags & REDIS_BLOCK) {
|
|
/* Write until done */
|
|
do {
|
|
if (redisBufferWrite(c,&wdone) == REDIS_ERR)
|
|
return REDIS_ERR;
|
|
} while (!wdone);
|
|
|
|
/* Read until there is a reply */
|
|
do {
|
|
if (redisBufferRead(c) == REDIS_ERR)
|
|
return REDIS_ERR;
|
|
if (redisGetReplyFromReader(c,&aux) == REDIS_ERR)
|
|
return REDIS_ERR;
|
|
} while (aux == NULL);
|
|
}
|
|
|
|
/* Set reply object */
|
|
if (reply != NULL) *reply = aux;
|
|
return REDIS_OK;
|
|
}
|
|
|
|
|
|
/* Helper function for the redisAppendCommand* family of functions.
|
|
*
|
|
* Write a formatted command to the output buffer. When this family
|
|
* is used, you need to call redisGetReply yourself to retrieve
|
|
* the reply (or replies in pub/sub).
|
|
*/
|
|
int __redisAppendCommand(redisContext *c, const char *cmd, size_t len) {
|
|
sds newbuf;
|
|
|
|
newbuf = sdscatlen(c->obuf,cmd,len);
|
|
if (newbuf == NULL) {
|
|
__redisSetError(c,REDIS_ERR_OOM,"Out of memory");
|
|
return REDIS_ERR;
|
|
}
|
|
|
|
c->obuf = newbuf;
|
|
return REDIS_OK;
|
|
}
|
|
|
|
int redisAppendFormattedCommand(redisContext *c, const char *cmd, size_t len) {
|
|
|
|
if (__redisAppendCommand(c, cmd, len) != REDIS_OK) {
|
|
return REDIS_ERR;
|
|
}
|
|
|
|
return REDIS_OK;
|
|
}
|
|
|
|
int redisvAppendCommand(redisContext *c, const char *format, va_list ap) {
|
|
char *cmd;
|
|
int len;
|
|
|
|
len = redisvFormatCommand(&cmd,format,ap);
|
|
if (len == -1) {
|
|
__redisSetError(c,REDIS_ERR_OOM,"Out of memory");
|
|
return REDIS_ERR;
|
|
} else if (len == -2) {
|
|
__redisSetError(c,REDIS_ERR_OTHER,"Invalid format string");
|
|
return REDIS_ERR;
|
|
}
|
|
|
|
if (__redisAppendCommand(c,cmd,len) != REDIS_OK) {
|
|
free(cmd);
|
|
return REDIS_ERR;
|
|
}
|
|
|
|
free(cmd);
|
|
return REDIS_OK;
|
|
}
|
|
|
|
int redisAppendCommand(redisContext *c, const char *format, ...) {
|
|
va_list ap;
|
|
int ret;
|
|
|
|
va_start(ap,format);
|
|
ret = redisvAppendCommand(c,format,ap);
|
|
va_end(ap);
|
|
return ret;
|
|
}
|
|
|
|
int redisAppendCommandArgv(redisContext *c, int argc, const char **argv, const size_t *argvlen) {
|
|
sds cmd;
|
|
int len;
|
|
|
|
len = redisFormatSdsCommandArgv(&cmd,argc,argv,argvlen);
|
|
if (len == -1) {
|
|
__redisSetError(c,REDIS_ERR_OOM,"Out of memory");
|
|
return REDIS_ERR;
|
|
}
|
|
|
|
if (__redisAppendCommand(c,cmd,len) != REDIS_OK) {
|
|
sdsfree(cmd);
|
|
return REDIS_ERR;
|
|
}
|
|
|
|
sdsfree(cmd);
|
|
return REDIS_OK;
|
|
}
|
|
|
|
/* Helper function for the redisCommand* family of functions.
|
|
*
|
|
* Write a formatted command to the output buffer. If the given context is
|
|
* blocking, immediately read the reply into the "reply" pointer. When the
|
|
* context is non-blocking, the "reply" pointer will not be used and the
|
|
* command is simply appended to the write buffer.
|
|
*
|
|
* Returns the reply when a reply was successfully retrieved. Returns NULL
|
|
* otherwise. When NULL is returned in a blocking context, the error field
|
|
* in the context will be set.
|
|
*/
|
|
static void *__redisBlockForReply(redisContext *c) {
|
|
void *reply;
|
|
|
|
if (c->flags & REDIS_BLOCK) {
|
|
if (redisGetReply(c,&reply) != REDIS_OK)
|
|
return NULL;
|
|
return reply;
|
|
}
|
|
return NULL;
|
|
}
|
|
|
|
void *redisvCommand(redisContext *c, const char *format, va_list ap) {
|
|
if (redisvAppendCommand(c,format,ap) != REDIS_OK)
|
|
return NULL;
|
|
return __redisBlockForReply(c);
|
|
}
|
|
|
|
void *redisCommand(redisContext *c, const char *format, ...) {
|
|
va_list ap;
|
|
va_start(ap,format);
|
|
void *reply = redisvCommand(c,format,ap);
|
|
va_end(ap);
|
|
return reply;
|
|
}
|
|
|
|
void *redisCommandArgv(redisContext *c, int argc, const char **argv, const size_t *argvlen) {
|
|
if (redisAppendCommandArgv(c,argc,argv,argvlen) != REDIS_OK)
|
|
return NULL;
|
|
return __redisBlockForReply(c);
|
|
}
|