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 * $FreeBSD$ 27 */ 28 29 #ifndef __NSCD_QUERY_H__ 30 #define __NSCD_QUERY_H__ 31 32 #include "cachelib.h" 33 #include "config.h" 34 #include "protocol.h" 35 36 struct query_state; 37 struct configuration; 38 struct configuration_entry; 39 40 typedef int (*query_process_func)(struct query_state *); 41 typedef void (*query_destroy_func)(struct query_state *); 42 typedef ssize_t (*query_read_func)(struct query_state *, void *, size_t); 43 typedef ssize_t (*query_write_func)(struct query_state *, const void *, size_t); 44 45 /* 46 * The query state structure contains the information to process all types of 47 * requests and to send all types of responses. 48 */ 49 struct query_state { 50 struct timeval creation_time; 51 struct timeval timeout; 52 53 struct comm_element request; 54 struct comm_element response; 55 struct configuration_entry *config_entry; 56 void *mdata; 57 58 query_process_func process_func; /* called on each event */ 59 query_destroy_func destroy_func; /* called on destroy */ 60 61 /* 62 * By substituting these functions we can opaquely send and received 63 * very large buffers 64 */ 65 query_write_func write_func; /* data write function */ 66 query_read_func read_func; /* data read function */ 67 68 char *eid_str; /* the user-identifying string (euid_egid_) */ 69 size_t eid_str_length; 70 71 uid_t euid; /* euid of the caller, received via getpeereid */ 72 uid_t uid; /* uid of the caller, received via credentials */ 73 gid_t egid; /* egid of the caller, received via getpeereid */ 74 gid_t gid; /* gid of the caller received via credentials */ 75 76 size_t io_buffer_size; 77 size_t io_buffer_watermark; 78 size_t kevent_watermark; /* bytes to be sent/received */ 79 int sockfd; /* the unix socket to read/write */ 80 int kevent_filter; /* EVFILT_READ or EVFILT_WRITE */ 81 int socket_failed; /* set to 1 if the socket doesn't work correctly */ 82 83 /* 84 * These fields are used to opaquely proceed sending/receiving of 85 * the large buffers 86 */ 87 char *io_buffer; 88 char *io_buffer_p; 89 int io_buffer_filter; 90 int use_alternate_io; 91 }; 92 93 int check_query_eids(struct query_state *); 94 95 ssize_t query_io_buffer_read(struct query_state *, void *, size_t); 96 ssize_t query_io_buffer_write(struct query_state *, const void *, size_t); 97 98 ssize_t query_socket_read(struct query_state *, void *, size_t); 99 ssize_t query_socket_write(struct query_state *, const void *, size_t); 100 101 struct query_state *init_query_state(int, size_t, uid_t, gid_t); 102 void destroy_query_state(struct query_state *); 103 104 #endif 105