1/*	$OpenBSD: imsg.h,v 1.3 2013/12/26 17:32:33 eric Exp $	*/
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
28struct ibuf {
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;
36};
37
38struct msgbuf {
39	TAILQ_HEAD(, ibuf)	 bufs;
40	u_int32_t		 queued;
41	int			 fd;
42};
43
44struct ibuf_read {
45	u_char			 buf[IBUF_READ_SIZE];
46	u_char			*rptr;
47	size_t			 wpos;
48};
49
50struct imsg_fd {
51	TAILQ_ENTRY(imsg_fd)	entry;
52	int			fd;
53};
54
55struct imsgbuf {
56	TAILQ_HEAD(, imsg_fd)	 fds;
57	struct ibuf_read	 r;
58	struct msgbuf		 w;
59	int			 fd;
60	pid_t			 pid;
61};
62
63#define IMSGF_HASFD	1
64
65struct imsg_hdr {
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;
71};
72
73struct imsg {
74	struct imsg_hdr	 hdr;
75	int		 fd;
76	void		*data;
77};
78
79
80/* buffer.c */
81struct ibuf	*ibuf_open(size_t);
82struct ibuf	*ibuf_dynamic(size_t, size_t);
83int		 ibuf_add(struct ibuf *, const void *, size_t);
84void		*ibuf_reserve(struct ibuf *, size_t);
85void		*ibuf_seek(struct ibuf *, size_t, size_t);
86size_t		 ibuf_size(struct ibuf *);
87size_t		 ibuf_left(struct ibuf *);
88void		 ibuf_close(struct msgbuf *, struct ibuf *);
89int		 ibuf_write(struct msgbuf *);
90void		 ibuf_free(struct ibuf *);
91void		 msgbuf_init(struct msgbuf *);
92void		 msgbuf_clear(struct msgbuf *);
93int		 msgbuf_write(struct msgbuf *);
94void		 msgbuf_drain(struct msgbuf *, size_t);
95
96/* imsg.c */
97void	 imsg_init(struct imsgbuf *, int);
98ssize_t	 imsg_read(struct imsgbuf *);
99ssize_t	 imsg_get(struct imsgbuf *, struct imsg *);
100int	 imsg_compose(struct imsgbuf *, u_int32_t, u_int32_t, pid_t,
101	    int, const void *, u_int16_t);
102int	 imsg_composev(struct imsgbuf *, u_int32_t, u_int32_t,  pid_t,
103	    int, const struct iovec *, int);
104struct ibuf *imsg_create(struct imsgbuf *, u_int32_t, u_int32_t, pid_t,
105	    u_int16_t);
106int	 imsg_add(struct ibuf *, const void *, u_int16_t);
107void	 imsg_close(struct imsgbuf *, struct ibuf *);
108void	 imsg_free(struct imsg *);
109int	 imsg_flush(struct imsgbuf *);
110void	 imsg_clear(struct imsgbuf *);
111
112#endif
113