1 /* 2 * CDDL HEADER START 3 * 4 * The contents of this file are subject to the terms of the 5 * Common Development and Distribution License (the "License"). 6 * You may not use this file except in compliance with the License. 7 * 8 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE 9 * or http://www.opensolaris.org/os/licensing. 10 * See the License for the specific language governing permissions 11 * and limitations under the License. 12 * 13 * When distributing Covered Code, include this CDDL HEADER in each 14 * file and include the License file at usr/src/OPENSOLARIS.LICENSE. 15 * If applicable, add the following below this CDDL HEADER, with the 16 * fields enclosed by brackets "[]" replaced with your own identifying 17 * information: Portions Copyright [yyyy] [name of copyright owner] 18 * 19 * CDDL HEADER END 20 */ 21 /* 22 * Copyright 2007 Sun Microsystems, Inc. All rights reserved. 23 * Use is subject to license terms. 24 */ 25 26 #ifndef _NSCD_SWITCH_H 27 #define _NSCD_SWITCH_H 28 29 #pragma ident "%Z%%M% %I% %E% SMI" 30 31 #ifdef __cplusplus 32 extern "C" { 33 #endif 34 35 #include <nss_dbdefs.h> 36 #include <thread.h> 37 #include <libscf.h> 38 #define __NSS_PRIVATE_INTERFACE 39 #include "nsswitch_priv.h" 40 #undef __NSS_PRIVATE_INTERFACE 41 #include "nscd_db.h" 42 #include "nscd_config.h" 43 44 /* 45 * max. length of e.g. "passwd: files ldap" 46 */ 47 #define MAX_NSSWITCH_CONFIG_STRING_SZ 256 48 49 /* 50 * max. length of the name of a NSS database 51 */ 52 #define MAX_NSSWITCH_CONFIG_DB_NAME_SZ 256 53 54 /* 55 * nscd_nsw_config_t is an abstraction of the configuration 56 * for a NSS database 57 */ 58 typedef struct { 59 char *db_name; 60 char *nsw_cfg_str; 61 nss_db_params_t fe_params; 62 struct __nsw_switchconfig_v1 *nsw_config; 63 int max_src; 64 int *src_idx; /* ptr to array of */ 65 /* src index */ 66 int nobase; /* not shared */ 67 } nscd_nsw_config_t; 68 69 /* 70 * nscd_be_info_t is an abstraction of a NSS backend 71 */ 72 typedef struct { 73 nss_backend_constr_t be_constr; 74 nss_backend_finder_t *finder; 75 void *finder_priv; 76 } nscd_be_info_t; 77 78 /* 79 * nscd_state_ctrl_t is used to control a nscd_nsw_state pool 80 */ 81 typedef struct { 82 int max; 83 int allocated; 84 int free; 85 int waiter; 86 struct nscd_nsw_state *first; 87 } nscd_state_ctrl_t; 88 89 /* 90 * nscd_nsw_state_base_t represents the nscd_nsw_state pool 91 * for a NSS database 92 */ 93 typedef struct nscd_nsw_state_base { 94 int dbi; /* which database? */ 95 nscd_state_ctrl_t nsw_state; 96 nscd_state_ctrl_t nsw_state_thr; 97 int used_by_thr; 98 thread_t tid; 99 cond_t thr_cond; 100 } nscd_nsw_state_base_t; 101 102 /* 103 * nscd_nsw_state_t is an abstraction of all the data needed 104 * to do lookup of NSS database (e.g. "passwd" or "hosts") 105 */ 106 typedef struct nscd_nsw_state { 107 int dbi; /* which database? */ 108 int max_src; /* is == config->num_lookups */ 109 int getent; /* used by getent */ 110 nscd_bool_t recheck_be; /* if set, check/init be */ 111 nss_db_params_t p; 112 struct __nsw_switchconfig_v1 *config; 113 nscd_nsw_config_t **nsw_cfg_p; 114 nscd_nsw_state_base_t *base; 115 nss_backend_t **be; /* array of backends */ 116 nss_backend_constr_t *be_constr; /* be constructor array */ 117 nscd_db_t ***be_db_pp; 118 struct nscd_nsw_state *next; 119 } nscd_nsw_state_t; 120 121 /* 122 * nscd_getent_ctx_base_t represents the nscd_getent_ctx_base_t pool 123 * for a NSS database 124 */ 125 typedef struct nscd_getent_ctx_base { 126 int dbi; /* which database? */ 127 int deattached; /* not associated with */ 128 /* current config */ 129 int max_getent_ctx; 130 int num_getent_ctx; 131 int num_waiter; 132 struct nscd_getent_context *first; 133 } nscd_getent_ctx_base_t; 134 135 /* 136 * nscd_getent_context_t is an abstraction of all the data needed 137 * to enumerate a NSS database (e.g. "passwd" or "hosts") 138 */ 139 typedef struct nscd_getent_context { 140 int dbi; 141 nscd_seq_num_t seq_num; 142 nscd_cookie_num_t cookie_num; 143 pid_t pid; /* door client's pid */ 144 int n_src; /* >=max_src: end of sequence */ 145 nscd_nsw_state_t *nsw_state; 146 nss_backend_t *be; 147 nscd_getent_ctx_base_t *base; 148 struct nscd_getent_context *next; 149 } nscd_getent_context_t; 150 151 /* 152 * nscd_smf_state_t is used to keep track of the state of the smf 153 * service associated with a NSS source (e.g. "passwd" or "hosts") 154 */ 155 typedef struct { 156 char *src_name; 157 int src_state; 158 } nscd_smf_state_t; 159 160 /* 161 * nscd_smf_state_t is used to keep track of the state of the smf 162 * service associated with a NSS source (e.g. "passwd" or "hosts") 163 */ 164 typedef struct { 165 int dbi; /* database index */ 166 /* 167 * index of the database of which the switch policy 168 * should be used 169 */ 170 int cfgdbi; 171 /* 172 * index of the pseudo database that the NSS backend 173 * does search on 174 */ 175 int compati; 176 /* 177 * ptr to ptr to the siwtch config structure 178 */ 179 nscd_nsw_config_t **nswcfg; 180 /* 181 * frontend params passed to nss_search or nss_*ent 182 */ 183 struct nss_db_params p; 184 /* 185 * set to 1 if database is "hosts", else 2 if "ipnodes" 186 */ 187 int8_t dnsi; 188 /* 189 * set to 1 if require privilege to look up the database 190 */ 191 uint8_t privdb; 192 } nscd_nsw_params_t; 193 194 /* 195 * additional info returned by the switch engine 196 */ 197 typedef struct { 198 void *pbuf; /* ptr to packed buffer */ 199 size_t pbufsiz; /* length of the packed buffer */ 200 int srci; /* last source searched */ 201 int errnum; /* errno from the backend */ 202 int noarg; /* if set, backend does not use the arg structure */ 203 int fallback; /* if set, may need to fall back to main nscd */ 204 } nscd_sw_return_t; 205 206 /* 207 * nscd cookies used for setent/getent/endent 208 * - p0 cookie: returned by nscd to indicate 209 * the start of the enumeration position 210 * - p1 cookie: returned/updated by nscd to indicate 211 * the current enumeration position 212 */ 213 #define NSCD_P0_COOKIE_SEQNUM -1 214 typedef struct { 215 pid_t p0_pid; 216 time_t p0_time; 217 nscd_seq_num_t p0_seqnum; 218 } nscd_getent_p0_cookie_t; 219 220 typedef struct { 221 nscd_cookie_num_t p1_cookie_num; 222 nscd_seq_num_t p1_seqnum; 223 } nscd_getent_p1_cookie_t; 224 225 /* 226 * static tables or global data defined in other files 227 */ 228 extern int _nscd_cfg_num_nsw_src; 229 extern int _nscd_cfg_num_nsw_src_all; 230 extern int _nscd_cfg_num_nsw_db; 231 extern int _nscd_cfg_num_nsw_db_all; 232 extern int _nscd_cfg_num_smf_services; 233 extern nscd_cfg_id_t _nscd_cfg_nsw_src[]; 234 extern nscd_cfg_id_t *_nscd_cfg_nsw_src_all; 235 extern nscd_cfg_id_t _nscd_cfg_nsw_db[]; 236 extern nss_db_initf_t nscd_nss_db_initf[]; 237 extern nscd_cfg_id_t _nscd_cfg_smf_services[]; 238 extern nscd_smf_state_t *nscd_smf_service_state; 239 extern nscd_db_t ***nscd_src_backend_db; 240 extern nscd_nsw_config_t ***nscd_nsw_config; 241 extern nscd_nsw_state_base_t **nscd_nsw_state_base; 242 extern nscd_getent_ctx_base_t **nscd_getent_ctx_base; 243 extern nscd_cfg_global_switch_t nscd_switch_cfg_g; 244 extern nscd_cfg_switch_t *nscd_switch_cfg; 245 extern nscd_cfg_stat_global_switch_t nscd_switch_stats_g; 246 extern nscd_cfg_stat_switch_t *nscd_switch_stats; 247 248 #define NSCD_NUM_SRC _nscd_cfg_num_nsw_src_all 249 #define NSCD_NUM_DB _nscd_cfg_num_nsw_db_all 250 #define NSCD_NUM_SMF_FMRI _nscd_cfg_num_smf_services 251 #define NSCD_NSW_SRC_NAME(i) (_nscd_cfg_nsw_src_all + i)->name 252 #define NSCD_NSW_DB_NAME(i) _nscd_cfg_nsw_db[i].name 253 #define NSCD_SMF_SVC_FMRI(i) _nscd_cfg_smf_services[i].name 254 #define NSCD_SMF_SVC_INDEX(i) _nscd_cfg_smf_services[i].index 255 #define NSCD_SMF_SVC_STATE(i) nscd_smf_service_state[i].src_state 256 #define NSCD_SW_CFG_G nscd_switch_cfg_g 257 #define NSCD_SW_CFG(i) nscd_switch_cfg[i] 258 #define NSCD_SW_STATS_G nscd_switch_stats_g 259 #define NSCD_SW_STATS(i) nscd_switch_stats[i] 260 261 /* 262 * special service states used by the switch engine 263 */ 264 #define NSCD_SVC_STATE_UNINITED -1 265 #define NSCD_SVC_STATE_UNKNOWN_SRC -2 266 267 /* 268 * prototypes 269 */ 270 271 void 272 _nscd_put_nsw_state( 273 nscd_nsw_state_t *s); 274 275 void 276 _nscd_put_nsw_state_thread( 277 nscd_nsw_state_t *s); 278 279 nscd_rc_t 280 _nscd_get_nsw_state( 281 nss_db_root_t *rootp, 282 nscd_nsw_params_t *params); 283 284 nscd_rc_t 285 _nscd_get_nsw_state_thread( 286 nss_db_root_t *rootp, 287 nscd_nsw_params_t *params); 288 289 nscd_rc_t 290 _nscd_init_all_nsw_state_base(); 291 292 nscd_rc_t 293 _nscd_init_nsw_state_base( 294 int dbi, 295 int compat_basei, 296 int lock); 297 298 nscd_rc_t 299 _nscd_init_all_getent_ctx(); 300 301 nscd_rc_t 302 _nscd_init_getent_ctx_base( 303 int dbi, 304 int lock); 305 306 nscd_db_t 307 *_nscd_create_getent_ctxaddrDB(); 308 309 nscd_rc_t 310 _nscd_get_getent_ctx( 311 nss_getent_t *contextpp, 312 nscd_nsw_params_t *params); 313 314 void 315 _nscd_put_getent_ctx( 316 nscd_getent_context_t *ctx); 317 318 nscd_rc_t 319 _nscd_init_all_nsw_config(); 320 321 nscd_rc_t 322 _nscd_init_all_nsw_be_info_db(); 323 324 #ifdef NSCD_NSSWITCH_CONF_FROM_SMF_PROP 325 nscd_rc_t 326 _nscd_get_new_nsw_config( 327 scf_handle_t *hndl, 328 const char *fmri, 329 scf_propertygroup_t *pg); 330 #endif 331 332 nscd_rc_t 333 _nscd_get_new_service_state( 334 int index, 335 scf_handle_t *hndl, 336 scf_property_t *prop); 337 338 nscd_getent_context_t * 339 _nscd_is_getent_ctx( 340 nscd_cookie_num_t cookie_num); 341 342 nscd_rc_t 343 _nscd_create_sw_struct( 344 int dbi, 345 int compat_basei, 346 const char *dbn, 347 const char *cfgstr, 348 void *swcfgv1, 349 nscd_nsw_params_t *params); 350 351 nscd_rc_t 352 _nscd_create_new_config( 353 nscd_nsw_params_t *params); 354 355 void 356 _nscd_free_nsw_config( 357 nscd_nsw_config_t *nswcfg); 358 359 nscd_rc_t 360 _nscd_init_smf_monitor(); 361 362 nscd_rc_t 363 _nscd_alloc_nsw_config(); 364 365 nscd_rc_t 366 _nscd_alloc_service_state_table(); 367 368 nscd_rc_t 369 _nscd_alloc_nsw_state_base(); 370 371 nscd_rc_t 372 _nscd_alloc_nsw_be_info_db(); 373 374 nscd_rc_t 375 _nscd_alloc_getent_ctx_base(); 376 377 void 378 _nscd_free_all_nsw_state_base(); 379 380 void 381 _nscd_free_all_getent_ctx_base(); 382 383 void 384 _nscd_free_all_nsw_config(); 385 386 void 387 _nscd_free_all_nsw_backend_info_db(); 388 389 struct __nsw_switchconfig_v1 * 390 _nsw_getoneconfig_v1( 391 const char *name, 392 char *linep, 393 enum __nsw_parse_err *errp); 394 int 395 __nsw_freeconfig_v1( 396 struct __nsw_switchconfig_v1 *conf); 397 398 int 399 _nscd_get_smf_state(int srci, int dbi, int recheck); 400 401 void 402 nss_psearch(void *buffer, size_t length); 403 void 404 nss_psetent(void *buffer, size_t length, pid_t pid); 405 void 406 nss_pgetent(void *buffer, size_t length); 407 void 408 nss_pendent(void *buffer, size_t length); 409 void 410 nss_pdelete(void *buffer, size_t length); 411 412 nscd_rc_t _nscd_alloc_switch_cfg(); 413 nscd_rc_t _nscd_alloc_switch_stats(); 414 nscd_db_t *_nscd_create_getent_ctx_addrDB(); 415 nscd_db_t *_nscd_create_getent_ctxDB(); 416 417 #ifdef __cplusplus 418 } 419 #endif 420 421 #endif /* _NSCD_SWITCH_H */ 422