nscd/nscd.h

   1 /* Copyright (c) 1998, 1999, 2000, 2001, 2003, 2004, 2005
   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   size_t max_db_size;
  67   const char *filename;
  68   const char *db_filename;
  69   time_t file_mtime;
  70   size_t suggested_module;
  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 /* Maximum alignment requirement we will encounter.  */
  98 #define BLOCK_ALIGN_LOG 3
  99 #define BLOCK_ALIGN (1 << BLOCK_ALIGN_LOG)
 100 #define BLOCK_ALIGN_M1 (BLOCK_ALIGN - 1)
 101
 102 /* Default value for the maximum size of the database files.  */
 103 #define DEFAULT_MAX_DB_SIZE     (32 * 1024 * 1024)
 104
 105 /* Number of bytes of data we initially reserve for each hash table bucket.  */
 106 #define DEFAULT_DATASIZE_PER_BUCKET 1024
 107
 108
 109 /* Global variables.  */
 110 extern struct database_dyn dbs[lastdb];
 111 extern const char *dbnames[lastdb];
 112 extern const char *serv2str[LASTREQ];
 113
 114 extern const struct iovec pwd_iov_disabled;
 115 extern const struct iovec grp_iov_disabled;
 116 extern const struct iovec hst_iov_disabled;
 117
 118
 119 /* Initial number of threads to run.  */
 120 extern int nthreads;
 121 /* Maximum number of threads to use.  */
 122 extern int max_nthreads;
 123
 124 /* User name to run server processes as.  */
 125 extern const char *server_user;
 126
 127 /* Name and UID of user who is allowed to request statistics.  */
 128 extern const char *stat_user;
 129 extern uid_t stat_uid;
 130
 131 /* Time the server was started.  */
 132 extern time_t start_time;
 133
 134 /* Number of times clients had to wait.  */
 135 extern unsigned long int client_queued;
 136
 137 /* Maximum needed alignment.  */
 138 extern const size_t block_align;
 139
 140 /* Number of times a value is reloaded without being used.  UINT_MAX
 141    means unlimited.  */
 142 extern unsigned int reload_count;
 143
 144 /* Pagesize minus one.  */
 145 extern uintptr_t pagesize_m1;
 146
 147 /* Nonzero if paranoia mode is enabled.  */
 148 extern int paranoia;
 149 /* Time after which the process restarts.  */
 150 extern time_t restart_time;
 151 /* How much time between restarts.  */
 152 extern time_t restart_interval;
 153 /* Old current working directory.  */
 154 extern const char *oldcwd;
 155 /* Old user and group ID.  */
 156 extern uid_t old_uid;
 157 extern gid_t old_gid;
 158
 159
 160 /* Prototypes for global functions.  */
 161
 162 /* nscd.c */
 163 extern void termination_handler (int signum) __attribute__ ((__noreturn__));
 164 extern int nscd_open_socket (void);
 165
 166 /* connections.c */
 167 extern void nscd_init (void);
 168 extern void close_sockets (void);
 169 extern void start_threads (void) __attribute__ ((__noreturn__));
 170
 171 /* nscd_conf.c */
 172 extern int nscd_parse_file (const char *fname,
 173                             struct database_dyn dbs[lastdb]);
 174
 175 /* nscd_stat.c */
 176 extern void send_stats (int fd, struct database_dyn dbs[lastdb]);
 177 extern int receive_print_stats (void) __attribute__ ((__noreturn__));
 178
 179 /* cache.c */
 180 extern struct datahead *cache_search (request_type, void *key, size_t len,
 181                                       struct database_dyn *table,
 182                                       uid_t owner);
 183 extern int cache_add (int type, const void *key, size_t len,
 184                       struct datahead *packet, bool first,
 185                       struct database_dyn *table, uid_t owner);
 186 extern void prune_cache (struct database_dyn *table, time_t now);
 187
 188 /* pwdcache.c */
 189 extern void addpwbyname (struct database_dyn *db, int fd, request_header *req,
 190                          void *key, uid_t uid);
 191 extern void addpwbyuid (struct database_dyn *db, int fd, request_header *req,
 192                         void *key, uid_t uid);
 193 extern void readdpwbyname (struct database_dyn *db, struct hashentry *he,
 194                            struct datahead *dh);
 195 extern void readdpwbyuid (struct database_dyn *db, struct hashentry *he,
 196                           struct datahead *dh);
 197
 198 /* grpcache.c */
 199 extern void addgrbyname (struct database_dyn *db, int fd, request_header *req,
 200                          void *key, uid_t uid);
 201 extern void addgrbygid (struct database_dyn *db, int fd, request_header *req,
 202                         void *key, uid_t uid);
 203 extern void readdgrbyname (struct database_dyn *db, struct hashentry *he,
 204                            struct datahead *dh);
 205 extern void readdgrbygid (struct database_dyn *db, struct hashentry *he,
 206                           struct datahead *dh);
 207
 208 /* hstcache.c */
 209 extern void addhstbyname (struct database_dyn *db, int fd, request_header *req,
 210                           void *key, uid_t uid);
 211 extern void addhstbyaddr (struct database_dyn *db, int fd, request_header *req,
 212                           void *key, uid_t uid);
 213 extern void addhstbynamev6 (struct database_dyn *db, int fd,
 214                             request_header *req, void *key, uid_t uid);
 215 extern void addhstbyaddrv6 (struct database_dyn *db, int fd,
 216                             request_header *req, void *key, uid_t uid);
 217 extern void readdhstbyname (struct database_dyn *db, struct hashentry *he,
 218                             struct datahead *dh);
 219 extern void readdhstbyaddr (struct database_dyn *db, struct hashentry *he,
 220                             struct datahead *dh);
 221 extern void readdhstbynamev6 (struct database_dyn *db, struct hashentry *he,
 222                               struct datahead *dh);
 223 extern void readdhstbyaddrv6 (struct database_dyn *db, struct hashentry *he,
 224                               struct datahead *dh);
 225
 226 /* aicache.c */
 227 extern void addhstai (struct database_dyn *db, int fd, request_header *req,
 228                       void *key, uid_t uid);
 229 extern void readdhstai (struct database_dyn *db, struct hashentry *he,
 230                         struct datahead *dh);
 231
 232
 233 /* initgrcache.c */
 234 extern void addinitgroups (struct database_dyn *db, int fd,
 235                            request_header *req, void *key, uid_t uid);
 236 extern void readdinitgroups (struct database_dyn *db, struct hashentry *he,
 237                              struct datahead *dh);
 238
 239 /* mem.c */
 240 extern void *mempool_alloc (struct database_dyn *db, size_t len);
 241 extern void gc (struct database_dyn *db);
 242
 243
 244 /* nscd_setup_thread.c */
 245 extern void setup_thread (struct database_dyn *db);
 246
 247
 248 /* Special version of TEMP_FAILURE_RETRY for functions returning error
 249    values.  */
 250 #define TEMP_FAILURE_RETRY_VAL(expression) \
 251   (__extension__                                                              \
 252     ({ long int __result;                                                     \
 253        do __result = (long int) (expression);                                 \
 254        while (__result == EINTR);                                             \
 255        __result; }))
 256
 257 #endif /* nscd.h */