1/*-
2 * Copyright (c) 2005 Michael Bushkov <bushman@rsu.ru>
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 * 1. Redistributions of source code must retain the above copyright
9 *    notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 *    notice, this list of conditions and the following disclaimer in the
12 *    documentation and/or other materials provided with the distribution.
13 *
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24 * SUCH DAMAGE.
25 */
26
27#ifndef __NSCD_QUERY_H__
28#define __NSCD_QUERY_H__
29
30#include "cachelib.h"
31#include "config.h"
32#include "protocol.h"
33
34struct query_state;
35struct configuration;
36struct configuration_entry;
37
38typedef	int (*query_process_func)(struct query_state *);
39typedef void (*query_destroy_func)(struct query_state *);
40typedef ssize_t (*query_read_func)(struct query_state *, void *, size_t);
41typedef ssize_t (*query_write_func)(struct query_state *, const void *, size_t);
42
43/*
44 * The query state structure contains the information to process all types of
45 * requests and to send all types of responses.
46 */
47struct query_state {
48	struct timeval creation_time;
49	struct timeval timeout;
50
51	struct comm_element request;
52	struct comm_element response;
53	struct configuration_entry *config_entry;
54	void	*mdata;
55
56	query_process_func process_func;	/* called on each event */
57	query_destroy_func destroy_func;	/* called on destroy */
58
59	/*
60	 * By substituting these functions we can opaquely send and received
61	 * very large buffers
62	 */
63	query_write_func write_func;		/* data write function */
64	query_read_func read_func;		/* data read function */
65
66	char	*eid_str;	/* the user-identifying string (euid_egid_) */
67	size_t	eid_str_length;
68
69	uid_t	euid;	/* euid of the caller, received via getpeereid */
70	uid_t	uid;	/* uid of the caller, received via credentials */
71	gid_t	egid;	/* egid of the caller, received via getpeereid */
72	gid_t	gid;	/* gid of the caller received via credentials */
73
74	size_t	io_buffer_size;
75	size_t	io_buffer_watermark;
76	size_t	kevent_watermark;	/* bytes to be sent/received */
77	int	sockfd;			/* the unix socket to read/write */
78	int	kevent_filter;	/* EVFILT_READ or EVFILT_WRITE */
79	int socket_failed; /* set to 1 if the socket doesn't work correctly */
80
81	/*
82	 * These fields are used to opaquely proceed sending/receiving of
83	 * the large buffers
84	 */
85	char	*io_buffer;
86	char	*io_buffer_p;
87	int	io_buffer_filter;
88	int	use_alternate_io;
89};
90
91int check_query_eids(struct query_state *);
92
93ssize_t query_io_buffer_read(struct query_state *, void *, size_t);
94ssize_t query_io_buffer_write(struct query_state *, const void *, size_t);
95
96ssize_t query_socket_read(struct query_state *, void *, size_t);
97ssize_t query_socket_write(struct query_state *, const void *, size_t);
98
99struct query_state *init_query_state(int, size_t, uid_t, gid_t);
100void destroy_query_state(struct query_state *);
101
102#endif
103