Collapse the VCLI .c and .h files, leaving only two: The bare protocol

and the VCLI core serve code.

include/vcli_common.h

-/*-
- * Copyright (c) 2006 Verdens Gang AS
- * Copyright (c) 2006-2011 Varnish Software AS
- * All rights reserved.
- *
- * Author: Poul-Henning Kamp <phk@phk.freebsd.dk>
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions
- * are met:
- * 1. Redistributions of source code must retain the above copyright
- *    notice, this list of conditions and the following disclaimer.
- * 2. 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.
- *
- * THIS SOFTWARE IS PROVIDED BY THE AUTHOR 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 AUTHOR 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.
- *
- */
-
-struct vlu;
-struct VCLS;
-
-struct cli {
-	unsigned		magic;
-#define CLI_MAGIC		0x4038d570
-	struct vsb		*sb;
-	enum VCLI_status_e	result;
-	char			*cmd;
-	unsigned		auth;
-	char			challenge[34];
-	char			*ident;
-	struct vlu		*vlu;
-	struct VCLS		*cls;
-	volatile unsigned	*limit;
-};

include/vcli_serve.h

-/*-
- * Copyright (c) 2010-2011 Varnish Software AS
- * All rights reserved.
- *
- * Author: Poul-Henning Kamp <phk@phk.freebsd.dk>
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions
- * are met:
- * 1. Redistributions of source code must retain the above copyright
- *    notice, this list of conditions and the following disclaimer.
- * 2. 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.
- *
- * THIS SOFTWARE IS PROVIDED BY THE AUTHOR 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 AUTHOR 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.
- *
- */
-
-struct VCLS;
-typedef void cls_cb_f(void *priv);
-typedef void cls_cbc_f(const struct cli*);
-struct VCLS *VCLS_New(cls_cbc_f *before, cls_cbc_f *after,
-    volatile unsigned *maxlen, volatile unsigned *limit);
-struct cli *VCLS_AddFd(struct VCLS *cs, int fdi, int fdo, cls_cb_f *closefunc,
-    void *priv);
-void VCLS_AddFunc(struct VCLS *cs, unsigned auth, struct cli_proto *clp);
-int VCLS_Poll(struct VCLS *cs, int timeout);
-int VCLS_PollFd(struct VCLS *cs, int fd, int timeout);
-void VCLS_Destroy(struct VCLS **);
-void VCLS_Clone(struct VCLS *cs, struct VCLS *cso);
-
-/* From libvarnish/cli.c */
-cli_func_t	VCLS_func_close;
-cli_func_t	VCLS_func_help;
-cli_func_t	VCLS_func_help_json;
-cli_func_t	VCLS_func_ping;

lib/libvarnish/cli_common.c

-/*-
- * Copyright (c) 2006 Verdens Gang AS
- * Copyright (c) 2006-2011 Varnish Software AS
- * All rights reserved.
- *
- * Author: Poul-Henning Kamp <phk@phk.freebsd.dk>
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions
- * are met:
- * 1. Redistributions of source code must retain the above copyright
- *    notice, this list of conditions and the following disclaimer.
- * 2. 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.
- *
- * THIS SOFTWARE IS PROVIDED BY THE AUTHOR 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 AUTHOR 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 "config.h"
-
-#include <sys/types.h>
-#include <sys/uio.h>
-
-#include <errno.h>
-#include <poll.h>
-#include <signal.h>
-#include <stdarg.h>
-#include <stdint.h>
-#include <stdio.h>
-#include <stdlib.h>
-#include <string.h>
-#include <time.h>
-#include <unistd.h>
-
-#include "vdef.h"
-#include "vas.h"
-#include "miniobj.h"
-#include "vqueue.h"
-
-#include "vcli.h"
-#include "vcli_common.h"
-#include "vcli_priv.h"
-#include "vsb.h"
-
-/*lint -e{818} cli could be const */
-void
-VCLI_Out(struct cli *cli, const char *fmt, ...)
-{
-	va_list ap;
-
-	va_start(ap, fmt);
-	if (cli != NULL) {
-		CHECK_OBJ_NOTNULL(cli, CLI_MAGIC);
-		if (VSB_len(cli->sb) < *cli->limit)
-			(void)VSB_vprintf(cli->sb, fmt, ap);
-		else if (cli->result == CLIS_OK)
-			cli->result = CLIS_TRUNCATED;
-	} else {
-		(void)vfprintf(stdout, fmt, ap);
-	}
-	va_end(ap);
-}
-
-/*lint -e{818} cli could be const */
-int
-VCLI_Overflow(struct cli *cli)
-{
-	CHECK_OBJ_NOTNULL(cli, CLI_MAGIC);
-	if (cli->result == CLIS_TRUNCATED ||
-	    VSB_len(cli->sb) >= *cli->limit)
-		return (1);
-	return (0);
-}
-
-/*lint -e{818} cli could be const */
-void
-VCLI_JSON_str(struct cli *cli, const char *s)
-{
-
-	CHECK_OBJ_NOTNULL(cli, CLI_MAGIC);
-	VSB_quote(cli->sb, s, -1, VSB_QUOTE_JSON);
-}
-
-/*lint -e{818} cli could be const */
-void
-VCLI_JSON_ver(struct cli *cli, unsigned ver, const char * const * av)
-{
-	int i;
-
-	CHECK_OBJ_NOTNULL(cli, CLI_MAGIC);
-	VCLI_Out(cli, "[ %u, [", ver);
-	for (i = 1; av[i] != NULL; i++) {
-		VCLI_JSON_str(cli, av[i]);
-		if (av[i + 1] != NULL)
-			VCLI_Out(cli, ", ");
-	}
-	VCLI_Out(cli, "]");
-}
-
-/*lint -e{818} cli could be const */
-void
-VCLI_Quote(struct cli *cli, const char *s)
-{
-
-	CHECK_OBJ_NOTNULL(cli, CLI_MAGIC);
-	VSB_quote(cli->sb, s, -1, 0);
-}
-
-void
-VCLI_SetResult(struct cli *cli, unsigned res)
-{
-
-	if (cli != NULL) {
-		CHECK_OBJ_NOTNULL(cli, CLI_MAGIC);
-		if (cli->result != CLIS_TRUNCATED || res != CLIS_OK)
-			cli->result = res;	/*lint !e64 type mismatch */
-	} else {
-		printf("CLI result = %u\n", res);
-	}
-}
-
-int
-VCLI_WriteResult(int fd, unsigned status, const char *result)
-{
-	int i, l;
-	struct iovec iov[3];
-	char nl[2] = "\n";
-	size_t len;
-	char res[CLI_LINE0_LEN + 2];	/*
-					 * NUL + one more so we can catch
-					 * any misformats by snprintf
-					 */
-
-	assert(status >= 100);
-	assert(status <= 999);		/*lint !e650 const out of range */
-
-	len = strlen(result);
-
-	i = snprintf(res, sizeof res,
-	    "%-3d %-8zd\n", status, len);
-	assert(i == CLI_LINE0_LEN);
-	assert(strtoul(res + 3, NULL, 10) == len);
-
-	iov[0].iov_base = res;
-	iov[0].iov_len = CLI_LINE0_LEN;
-
-	iov[1].iov_base = (void*)(uintptr_t)result;	/* TRUST ME */
-	iov[1].iov_len = len;
-
-	iov[2].iov_base = nl;
-	iov[2].iov_len = 1;
-
-	for (l = i = 0; i < 3; i++)
-		l += iov[i].iov_len;
-	i = writev(fd, iov, 3);
-	return (i != l);
-}
-
-static int
-read_tmo(int fd, char *ptr, unsigned len, double tmo)
-{
-	int i, j, to;
-	struct pollfd pfd;
-
-	if (tmo > 0)
-		to = (int)(tmo * 1e3);
-	else
-		to = -1;
-	pfd.fd = fd;
-	pfd.events = POLLIN;
-	for (j = 0; len > 0; ) {
-		i = poll(&pfd, 1, to);
-		if (i == 0) {
-			errno = ETIMEDOUT;
-			return (-1);
-		}
-		i = read(fd, ptr, len);
-		if (i < 0)
-			return (i);
-		if (i == 0)
-			break;
-		len -= i;
-		ptr += i;
-		j += i;
-	}
-	return (j);
-}
-
-int
-VCLI_ReadResult(int fd, unsigned *status, char **ptr, double tmo)
-{
-	char res[CLI_LINE0_LEN];	/* For NUL */
-	int i, j;
-	unsigned u, v, s;
-	char *p = NULL;
-	const char *err = "CLI communication error (hdr)";
-
-	if (status == NULL)
-		status = &s;
-	if (ptr != NULL)
-		*ptr = NULL;
-	do {
-		i = read_tmo(fd, res, CLI_LINE0_LEN, tmo);
-		if (i != CLI_LINE0_LEN)
-			break;
-
-		if (res[3] != ' ')
-			break;
-
-		if (res[CLI_LINE0_LEN - 1] != '\n')
-			break;
-
-		res[CLI_LINE0_LEN - 1] = '\0';
-		j = sscanf(res, "%u %u\n", &u, &v);
-		if (j != 2)
-			break;
-
-		err = "CLI communication error (body)";
-
-		*status = u;
-		p = malloc(v + 1L);
-		if (p == NULL)
-			break;
-
-		i = read_tmo(fd, p, v + 1, tmo);
-		if (i < 0)
-			break;
-		if (i != v + 1)
-			break;
-		if (p[v] != '\n')
-			break;
-
-		p[v] = '\0';
-		if (ptr == NULL)
-			free(p);
-		else
-			*ptr = p;
-		return (0);
-	} while(0);
-
-	if (p != NULL)
-		free(p);
-	*status = CLIS_COMMS;
-	if (ptr != NULL)
-		*ptr = strdup(err);
-	return (*status);
-}