nscd/nscd.h

   1 /* Copyright (c) 1998, 1999, 2000, 2001, 2003 Free Software Foundation, Inc.
   2    This file is part of the GNU C Library.
   3    Contributed by Thorsten Kukuk <kukuk@suse.de>, 1998.
   4
   5    The GNU C Library is free software; you can redistribute it and/or
   6    modify it under the terms of the GNU Lesser General Public
   7    License as published by the Free Software Foundation; either
   8    version 2.1 of the License, or (at your option) any later version.
   9
  10    The GNU C Library is distributed in the hope that it will be useful,
  11    but WITHOUT ANY WARRANTY; without even the implied warranty of
  12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13    Lesser General Public License for more details.
  14
  15    You should have received a copy of the GNU Lesser General Public
  16    License along with the GNU C Library; if not, write to the Free
  17    Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
  18    02111-1307 USA.  */
  19
  20 #ifndef _NSCD_H
  21 #define _NSCD_H 1
  22
  23 #include <pthread.h>
  24 #include <time.h>
  25 #include <sys/uio.h>
  26
  27 /* The declarations for the request and response types are in the file
  28    "nscd-client.h", which should contain everything needed by client
  29    functions.  */
  30 #include "nscd-client.h"
  31
  32
  33 /* Handle databases.  */
  34 typedef enum
  35 {
  36   pwddb,
  37   grpdb,
  38   hstdb,
  39   lastdb
  40 } dbtype;
  41
  42
  43 /* Structure for one hash table entry.  */
  44 struct hashentry
  45 {
  46   request_type type;            /* Which type of dataset.  */
  47   size_t len;                   /* Length of key.  */
  48   void *key;                    /* Pointer to key.  */
  49   uid_t owner;                  /* If secure table, this is the owner.  */
  50   struct hashentry *next;       /* Next entry in this hash bucket list.  */
  51   time_t timeout;               /* Time when this entry becomes invalid.  */
  52   ssize_t total;                /* Number of bytes in PACKET.  */
  53   const void *packet;           /* Records for the result.  */
  54   void *data;                   /* The malloc()ed respond record.  */
  55   int last;                     /* Nonzero if DATA should be free()d.  */
  56   struct hashentry *dellist;    /* Next record to be deleted.  */
  57 };
  58
  59 /* Structure describing one database.  */
  60 struct database
  61 {
  62   pthread_rwlock_t lock;
  63
  64   int enabled;
  65   int check_file;
  66   const char *filename;
  67   time_t file_mtime;
  68   size_t module;
  69
  70   const struct iovec *disabled_iov;
  71
  72   unsigned long int postimeout;
  73   unsigned long int negtimeout;
  74
  75   unsigned long int poshit;
  76   unsigned long int neghit;
  77   unsigned long int posmiss;
  78   unsigned long int negmiss;
  79
  80   unsigned long int nentries;
  81   unsigned long int maxnentries;
  82   unsigned long int maxnsearched;
  83
  84   unsigned long int rdlockdelayed;
  85   unsigned long int wrlockdelayed;
  86
  87   struct hashentry **array;
  88 };
  89
  90
  91 /* Global variables.  */
  92 extern struct database dbs[lastdb];
  93 extern const char *dbnames[lastdb];
  94 extern const char *serv2str[LASTREQ];
  95
  96 extern const struct iovec pwd_iov_disabled;
  97 extern const struct iovec grp_iov_disabled;
  98 extern const struct iovec hst_iov_disabled;
  99
 100 /* Number of threads to run.  */
 101 extern int nthreads;
 102
 103 /* Tables for which we cache data with uid.  */
 104 extern int secure[lastdb];
 105 extern int secure_in_use; /* Is one of the above 1?  */
 106
 107 /* User name to run server processes as.  */
 108 extern const char *server_user;
 109
 110 /* Name and UID of user who is allowed to request statistics.  */
 111 extern const char *stat_user;
 112 extern uid_t stat_uid;
 113
 114 /* Time the server was started.  */
 115 extern time_t start_time;
 116
 117 /* Number of times clients had to wait.  */
 118 extern unsigned long int client_queued;
 119
 120 /* Prototypes for global functions.  */
 121
 122 /* nscd.c */
 123 extern void termination_handler (int signum) __attribute__ ((__noreturn__));
 124 extern int nscd_open_socket (void);
 125
 126 /* connections.c */
 127 extern void nscd_init (void);
 128 extern void close_sockets (void);
 129 extern void start_threads (void) __attribute__ ((__noreturn__));
 130
 131 /* nscd_conf.c */
 132 extern int nscd_parse_file (const char *fname, struct database dbs[lastdb]);
 133
 134 /* nscd_stat.c */
 135 extern void send_stats (int fd, struct database dbs[lastdb]);
 136 extern int receive_print_stats (void) __attribute__ ((__noreturn__));
 137
 138 /* cache.c */
 139 extern struct hashentry *cache_search (request_type, void *key, size_t len,
 140                                        struct database *table, uid_t owner);
 141 extern void cache_add (int type, void *key, size_t len,
 142                        const void *packet, size_t iovtotal, void *data,
 143                        int last, time_t t, struct database *table,
 144                        uid_t owner);
 145 extern void prune_cache (struct database *table, time_t now);
 146
 147 /* pwdcache.c */
 148 extern void addpwbyname (struct database *db, int fd, request_header *req,
 149                          void *key, uid_t uid);
 150 extern void addpwbyuid (struct database *db, int fd, request_header *req,
 151                         void *key, uid_t uid);
 152
 153 /* grpcache.c */
 154 extern void addgrbyname (struct database *db, int fd, request_header *req,
 155                          void *key, uid_t uid);
 156 extern void addgrbygid (struct database *db, int fd, request_header *req,
 157                         void *key, uid_t uid);
 158
 159 /* hstcache.c */
 160 extern void addhstbyname (struct database *db, int fd, request_header *req,
 161                           void *key, uid_t uid);
 162 extern void addhstbyaddr (struct database *db, int fd, request_header *req,
 163                           void *key, uid_t uid);
 164 extern void addhstbynamev6 (struct database *db, int fd, request_header *req,
 165                             void *key, uid_t uid);
 166 extern void addhstbyaddrv6 (struct database *db, int fd, request_header *req,
 167                             void *key, uid_t uid);
 168
 169
 170 #endif /* nscd.h */