[mirror_frr.git] / lib / imsg.h

/*	$OpenBSD$	*/

/*
 * Copyright (c) 2006, 2007 Pierre-Yves Ritschard <pyr@openbsd.org>
 * Copyright (c) 2006, 2007, 2008 Reyk Floeter <reyk@openbsd.org>
 * Copyright (c) 2003, 2004 Henning Brauer <henning@openbsd.org>
 *
 * Permission to use, copy, modify, and distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 */

#ifndef _IMSG_H_
#define _IMSG_H_

#define IBUF_READ_SIZE		65535
#define IMSG_HEADER_SIZE	sizeof(struct imsg_hdr)
#define MAX_IMSGSIZE		16384

struct ibuf {
	TAILQ_ENTRY(ibuf) entry;
	u_char *buf;
	size_t size;
	size_t max;
	size_t wpos;
	size_t rpos;
	int fd;
};

struct msgbuf {
	TAILQ_HEAD(, ibuf) bufs;
	u_int32_t queued;
	int fd;
};

struct ibuf_read {
	u_char buf[IBUF_READ_SIZE];
	u_char *rptr;
	size_t wpos;
};

struct imsg_fd {
	TAILQ_ENTRY(imsg_fd) entry;
	int fd;
};

struct imsgbuf {
	TAILQ_HEAD(, imsg_fd) fds;
	struct ibuf_read r;
	struct msgbuf w;
	int fd;
	pid_t pid;
};

#define IMSGF_HASFD	1

struct imsg_hdr {
	u_int32_t type;
	u_int16_t len;
	u_int16_t flags;
	u_int32_t peerid;
	u_int32_t pid;
};

struct imsg {
	struct imsg_hdr hdr;
	int fd;
	void *data;
};


/* buffer.c */
struct ibuf *ibuf_open(size_t);
struct ibuf *ibuf_dynamic(size_t, size_t);
int ibuf_add(struct ibuf *, const void *, size_t);
void *ibuf_reserve(struct ibuf *, size_t);
void *ibuf_seek(struct ibuf *, size_t, size_t);
size_t ibuf_size(struct ibuf *);
size_t ibuf_left(struct ibuf *);
void ibuf_close(struct msgbuf *, struct ibuf *);
int ibuf_write(struct msgbuf *);
void ibuf_free(struct ibuf *);
void msgbuf_init(struct msgbuf *);
void msgbuf_clear(struct msgbuf *);
int msgbuf_write(struct msgbuf *);
void msgbuf_drain(struct msgbuf *, size_t);

/* imsg.c */
void imsg_init(struct imsgbuf *, int);
ssize_t imsg_read(struct imsgbuf *);
ssize_t imsg_get(struct imsgbuf *, struct imsg *);
int imsg_compose(struct imsgbuf *, u_int32_t, u_int32_t, pid_t, int,
		 const void *, u_int16_t);
int imsg_composev(struct imsgbuf *, u_int32_t, u_int32_t, pid_t, int,
		  const struct iovec *, int);
struct ibuf *imsg_create(struct imsgbuf *, u_int32_t, u_int32_t, pid_t,
			 u_int16_t);
int imsg_add(struct ibuf *, const void *, u_int16_t);
void imsg_close(struct imsgbuf *, struct ibuf *);
void imsg_free(struct imsg *);
int imsg_flush(struct imsgbuf *);
void imsg_clear(struct imsgbuf *);

#endif
Commit	Line	Data
8429abe0 RW	1	/* $OpenBSD$ */
	2
	3	/*
	4	* Copyright (c) 2006, 2007 Pierre-Yves Ritschard <pyr@openbsd.org>
	5	* Copyright (c) 2006, 2007, 2008 Reyk Floeter <reyk@openbsd.org>
	6	* Copyright (c) 2003, 2004 Henning Brauer <henning@openbsd.org>
	7	*
	8	* Permission to use, copy, modify, and distribute this software for any
	9	* purpose with or without fee is hereby granted, provided that the above
	10	* copyright notice and this permission notice appear in all copies.
	11	*
	12	* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
	13	* WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
	14	* MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
	15	* ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
	16	* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
	17	* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
	18	* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
	19	*/
	20
	21	#ifndef _IMSG_H_
	22	#define _IMSG_H_
	23
	24	#define IBUF_READ_SIZE 65535
	25	#define IMSG_HEADER_SIZE sizeof(struct imsg_hdr)
	26	#define MAX_IMSGSIZE 16384
	27
	28	struct ibuf {
d62a17ae	29	TAILQ_ENTRY(ibuf) entry;
	30	u_char *buf;
	31	size_t size;
	32	size_t max;
	33	size_t wpos;
	34	size_t rpos;
	35	int fd;
8429abe0 RW	36	};
	37
	38	struct msgbuf {
d62a17ae	39	TAILQ_HEAD(, ibuf) bufs;
	40	u_int32_t queued;
	41	int fd;
8429abe0 RW	42	};
	43
	44	struct ibuf_read {
d62a17ae	45	u_char buf[IBUF_READ_SIZE];
	46	u_char *rptr;
	47	size_t wpos;
8429abe0 RW	48	};
	49
	50	struct imsg_fd {
d62a17ae	51	TAILQ_ENTRY(imsg_fd) entry;
d62a17ae	52	int fd;
8429abe0 RW	53	};
	54
	55	struct imsgbuf {
d62a17ae	56	TAILQ_HEAD(, imsg_fd) fds;
	57	struct ibuf_read r;
	58	struct msgbuf w;
	59	int fd;
	60	pid_t pid;
8429abe0 RW	61	};
	62
	63	#define IMSGF_HASFD 1
	64
	65	struct imsg_hdr {
d62a17ae	66	u_int32_t type;
	67	u_int16_t len;
	68	u_int16_t flags;
	69	u_int32_t peerid;
	70	u_int32_t pid;
8429abe0 RW	71	};
	72
	73	struct imsg {
d62a17ae	74	struct imsg_hdr hdr;
	75	int fd;
	76	void *data;
8429abe0 RW	77	};
	78
	79
	80	/* buffer.c */
d62a17ae	81	struct ibuf *ibuf_open(size_t);
	82	struct ibuf *ibuf_dynamic(size_t, size_t);
	83	int ibuf_add(struct ibuf , const void , size_t);
	84	void ibuf_reserve(struct ibuf , size_t);
	85	void ibuf_seek(struct ibuf , size_t, size_t);
	86	size_t ibuf_size(struct ibuf *);
	87	size_t ibuf_left(struct ibuf *);
	88	void ibuf_close(struct msgbuf , struct ibuf );
	89	int ibuf_write(struct msgbuf *);
	90	void ibuf_free(struct ibuf *);
	91	void msgbuf_init(struct msgbuf *);
	92	void msgbuf_clear(struct msgbuf *);
	93	int msgbuf_write(struct msgbuf *);
	94	void msgbuf_drain(struct msgbuf *, size_t);
8429abe0 RW	95
8429abe0 RW	96	/* imsg.c */
d62a17ae	97	void imsg_init(struct imsgbuf *, int);
	98	ssize_t imsg_read(struct imsgbuf *);
	99	ssize_t imsg_get(struct imsgbuf , struct imsg );
	100	int imsg_compose(struct imsgbuf *, u_int32_t, u_int32_t, pid_t, int,
	101	const void *, u_int16_t);
	102	int imsg_composev(struct imsgbuf *, u_int32_t, u_int32_t, pid_t, int,
	103	const struct iovec *, int);
8429abe0	104	struct ibuf imsg_create(struct imsgbuf , u_int32_t, u_int32_t, pid_t,
d62a17ae	105	u_int16_t);
	106	int imsg_add(struct ibuf , const void , u_int16_t);
	107	void imsg_close(struct imsgbuf , struct ibuf );
	108	void imsg_free(struct imsg *);
	109	int imsg_flush(struct imsgbuf *);
	110	void imsg_clear(struct imsgbuf *);
8429abe0 RW	111
8429abe0 RW	112	#endif