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