nscd/nscd.h

   1 /* Copyright (c) 1998, 1999, 2000, 2001, 2003, 2004
   2    Free Software Foundation, Inc.
   3    This file is part of the GNU C Library.
   4    Contributed by Thorsten Kukuk <kukuk@suse.de>, 1998.
   5
   6    The GNU C Library is free software; you can redistribute it and/or
   7    modify it under the terms of the GNU Lesser General Public
   8    License as published by the Free Software Foundation; either
   9    version 2.1 of the License, or (at your option) any later version.
  10
  11    The GNU C Library is distributed in the hope that it will be useful,
  12    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14    Lesser General Public License for more details.
  15
  16    You should have received a copy of the GNU Lesser General Public
  17    License along with the GNU C Library; if not, write to the Free
  18    Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
  19    02111-1307 USA.  */
  20
  21 #ifndef _NSCD_H
  22 #define _NSCD_H 1
  23
  24 #include <pthread.h>
  25 #include <stdbool.h>
  26 #include <time.h>
  27 #include <sys/uio.h>
  28
  29 /* The declarations for the request and response types are in the file
  30    "nscd-client.h", which should contain everything needed by client
  31    functions.  */
  32 #include "nscd-client.h"
  33
  34
  35 /* Handle databases.  */
  36 typedef enum
  37 {
  38   pwddb,
  39   grpdb,
  40   hstdb,
  41   lastdb
  42 } dbtype;
  43
  44
  45 /* Default limit on the number of times a value gets reloaded without
  46    being used in the meantime.  NSCD does not throw a value out as
  47    soon as it times out.  It tries to reload the value from the
  48    server.  Only if the value has not been used for so many rounds it
  49    is removed.  */
  50 #define DEFAULT_RELOAD_LIMIT 5
  51
  52
  53 /* Time before restarting the process in paranoia mode.  */
  54 #define RESTART_INTERVAL (60 * 60)
  55
  56
  57 /* Structure describing dynamic part of one database.  */
  58 struct database_dyn
  59 {
  60   pthread_rwlock_t lock;
  61
  62   int enabled;
  63   int check_file;
  64   int persistent;
  65   int shared;
  66   const char *filename;
  67   const char *db_filename;
  68   time_t file_mtime;
  69   size_t suggested_module;
  70   int secure;
  71
  72   unsigned long int postimeout; /* In seconds.  */
  73   unsigned long int negtimeout; /* In seconds.  */
  74
  75   int wr_fd;                    /* Writable file descriptor.  */
  76   int ro_fd;                    /* Unwritable file descriptor.  */
  77
  78   const struct iovec *disabled_iov;
  79
  80   struct database_pers_head *head;
  81   char *data;
  82   size_t memsize;
  83   pthread_mutex_t memlock;
  84   bool mmap_used;
  85   bool last_alloc_failed;
  86 };
  87
  88
  89 /* Paths of the file for the persistent storage.  */
  90 #define _PATH_NSCD_PASSWD_DB    "/var/db/nscd/passwd"
  91 #define _PATH_NSCD_GROUP_DB     "/var/db/nscd/group"
  92 #define _PATH_NSCD_HOSTS_DB     "/var/db/nscd/hosts"
  93
  94 /* Path used when not using persistent storage.  */
  95 #define _PATH_NSCD_XYZ_DB_TMP   "/var/run/nscd/dbXXXXXX"
  96
  97
  98 /* Global variables.  */
  99 extern struct database_dyn dbs[lastdb];
 100 extern const char *dbnames[lastdb];
 101 extern const char *serv2str[LASTREQ];
 102
 103 extern const struct iovec pwd_iov_disabled;
 104 extern const struct iovec grp_iov_disabled;
 105 extern const struct iovec hst_iov_disabled;
 106
 107
 108 /* Initial number of threads to run.  */
 109 extern int nthreads;
 110 /* Maximum number of threads to use.  */
 111 extern int max_nthreads;
 112
 113 /* Tables for which we cache data with uid.  */
 114 extern int secure_in_use; /* Is one of the above 1?  */
 115
 116 /* User name to run server processes as.  */
 117 extern const char *server_user;
 118
 119 /* Name and UID of user who is allowed to request statistics.  */
 120 extern const char *stat_user;
 121 extern uid_t stat_uid;
 122
 123 /* Time the server was started.  */
 124 extern time_t start_time;
 125
 126 /* Number of times clients had to wait.  */
 127 extern unsigned long int client_queued;
 128
 129 /* Maximum needed alignment.  */
 130 extern const size_t block_align;
 131
 132 /* Number of times a value is reloaded without being used.  UINT_MAX
 133    means unlimited.  */
 134 extern unsigned int reload_count;
 135
 136 /* Pagesize minus one.  */
 137 extern uintptr_t pagesize_m1;
 138
 139 /* Nonzero if paranoia mode is enabled.  */
 140 extern int paranoia;
 141 /* Time after which the process restarts.  */
 142 extern time_t restart_time;
 143 /* How much time between restarts.  */
 144 extern time_t restart_interval;
 145 /* Old current working directory.  */
 146 extern const char *oldcwd;
 147 /* Old user and group ID.  */
 148 extern uid_t old_uid;
 149 extern gid_t old_gid;
 150
 151
 152 /* Prototypes for global functions.  */
 153
 154 /* nscd.c */
 155 extern void termination_handler (int signum) __attribute__ ((__noreturn__));
 156 extern int nscd_open_socket (void);
 157
 158 /* connections.c */
 159 extern void nscd_init (void);
 160 extern void close_sockets (void);
 161 extern void start_threads (void) __attribute__ ((__noreturn__));
 162
 163 /* nscd_conf.c */
 164 extern int nscd_parse_file (const char *fname,
 165                             struct database_dyn dbs[lastdb]);
 166
 167 /* nscd_stat.c */
 168 extern void send_stats (int fd, struct database_dyn dbs[lastdb]);
 169 extern int receive_print_stats (void) __attribute__ ((__noreturn__));
 170
 171 /* cache.c */
 172 extern struct datahead *cache_search (request_type, void *key, size_t len,
 173                                       struct database_dyn *table,
 174                                       uid_t owner);
 175 extern int cache_add (int type, const void *key, size_t len,
 176                       struct datahead *packet, bool first,
 177                       struct database_dyn *table, uid_t owner);
 178 extern void prune_cache (struct database_dyn *table, time_t now);
 179
 180 /* pwdcache.c */
 181 extern void addpwbyname (struct database_dyn *db, int fd, request_header *req,
 182                          void *key, uid_t uid);
 183 extern void addpwbyuid (struct database_dyn *db, int fd, request_header *req,
 184                         void *key, uid_t uid);
 185 extern void readdpwbyname (struct database_dyn *db, struct hashentry *he,
 186                            struct datahead *dh);
 187 extern void readdpwbyuid (struct database_dyn *db, struct hashentry *he,
 188                           struct datahead *dh);
 189
 190 /* grpcache.c */
 191 extern void addgrbyname (struct database_dyn *db, int fd, request_header *req,
 192                          void *key, uid_t uid);
 193 extern void addgrbygid (struct database_dyn *db, int fd, request_header *req,
 194                         void *key, uid_t uid);
 195 extern void readdgrbyname (struct database_dyn *db, struct hashentry *he,
 196                            struct datahead *dh);
 197 extern void readdgrbygid (struct database_dyn *db, struct hashentry *he,
 198                           struct datahead *dh);
 199
 200 /* hstcache.c */
 201 extern void addhstbyname (struct database_dyn *db, int fd, request_header *req,
 202                           void *key, uid_t uid);
 203 extern void addhstbyaddr (struct database_dyn *db, int fd, request_header *req,
 204                           void *key, uid_t uid);
 205 extern void addhstbynamev6 (struct database_dyn *db, int fd,
 206                             request_header *req, void *key, uid_t uid);
 207 extern void addhstbyaddrv6 (struct database_dyn *db, int fd,
 208                             request_header *req, void *key, uid_t uid);
 209 extern void readdhstbyname (struct database_dyn *db, struct hashentry *he,
 210                             struct datahead *dh);
 211 extern void readdhstbyaddr (struct database_dyn *db, struct hashentry *he,
 212                             struct datahead *dh);
 213 extern void readdhstbynamev6 (struct database_dyn *db, struct hashentry *he,
 214                               struct datahead *dh);
 215 extern void readdhstbyaddrv6 (struct database_dyn *db, struct hashentry *he,
 216                               struct datahead *dh);
 217
 218 /* aicache.c */
 219 extern void addhstai (struct database_dyn *db, int fd, request_header *req,
 220                       void *key, uid_t uid);
 221 extern void readdhstai (struct database_dyn *db, struct hashentry *he,
 222                         struct datahead *dh);
 223
 224
 225 /* initgrcache.c */
 226 extern void addinitgroups (struct database_dyn *db, int fd,
 227                            request_header *req, void *key, uid_t uid);
 228 extern void readdinitgroups (struct database_dyn *db, struct hashentry *he,
 229                              struct datahead *dh);
 230
 231 /* mem.c */
 232 extern void *mempool_alloc (struct database_dyn *db, size_t len);
 233 extern void gc (struct database_dyn *db);
 234
 235
 236 /* nscd_setup_thread.c */
 237 extern void setup_thread (struct database_dyn *db);
 238
 239 #endif /* nscd.h */