2 * Copyright (c) 2005 Michael Bushkov <bushman@rsu.ru>
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
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 thereg
12 * documentation and/or other materials provided with the distribution.
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
28 #include <sys/cdefs.h>
29 __FBSDID("$FreeBSD$");
31 #include <sys/param.h>
32 #include <sys/event.h>
33 #include <sys/socket.h>
50 #include "agents/passwd.h"
51 #include "agents/group.h"
52 #include "agents/services.h"
60 #include "singletons.h"
63 #define CONFIG_PATH "/etc/nscd.conf"
65 #define DEFAULT_CONFIG_PATH "nscd.conf"
67 #define MAX_SOCKET_IO_SIZE 4096
69 struct processing_thread_args {
71 struct configuration *the_configuration;
72 struct runtime_env *the_runtime_env;
75 static void accept_connection(struct kevent *, struct runtime_env *,
76 struct configuration *);
77 static void destroy_cache_(cache);
78 static void destroy_runtime_env(struct runtime_env *);
79 static cache init_cache_(struct configuration *);
80 static struct runtime_env *init_runtime_env(struct configuration *);
81 static void processing_loop(cache, struct runtime_env *,
82 struct configuration *);
83 static void process_socket_event(struct kevent *, struct runtime_env *,
84 struct configuration *);
85 static void process_timer_event(struct kevent *, struct runtime_env *,
86 struct configuration *);
87 static void *processing_thread(void *);
88 static void usage(void);
90 void get_time_func(struct timeval *);
96 "usage: nscd [-dnst] [-i cachename] [-I cachename]\n");
101 init_cache_(struct configuration *config)
103 struct cache_params params;
106 struct configuration_entry *config_entry;
110 TRACE_IN(init_cache_);
112 memset(¶ms, 0, sizeof(struct cache_params));
113 params.get_time_func = get_time_func;
114 retval = init_cache(¶ms);
116 size = configuration_get_entries_size(config);
117 for (i = 0; i < size; ++i) {
118 config_entry = configuration_get_entry(config, i);
120 * We should register common entries now - multipart entries
121 * would be registered automatically during the queries.
123 res = register_cache_entry(retval, (struct cache_entry_params *)
124 &config_entry->positive_cache_params);
125 config_entry->positive_cache_entry = find_cache_entry(retval,
126 config_entry->positive_cache_params.cep.entry_name);
127 assert(config_entry->positive_cache_entry !=
128 INVALID_CACHE_ENTRY);
130 res = register_cache_entry(retval, (struct cache_entry_params *)
131 &config_entry->negative_cache_params);
132 config_entry->negative_cache_entry = find_cache_entry(retval,
133 config_entry->negative_cache_params.cep.entry_name);
134 assert(config_entry->negative_cache_entry !=
135 INVALID_CACHE_ENTRY);
138 LOG_MSG_2("cache", "cache was successfully initialized");
139 TRACE_OUT(init_cache_);
144 destroy_cache_(cache the_cache)
146 TRACE_IN(destroy_cache_);
147 destroy_cache(the_cache);
148 TRACE_OUT(destroy_cache_);
152 * Socket and kqueues are prepared here. We have one global queue for both
153 * socket and timers events.
155 static struct runtime_env *
156 init_runtime_env(struct configuration *config)
159 struct sockaddr_un serv_addr;
161 struct kevent eventlist;
162 struct timespec timeout;
164 struct runtime_env *retval;
166 TRACE_IN(init_runtime_env);
167 retval = calloc(1, sizeof(*retval));
168 assert(retval != NULL);
170 retval->sockfd = socket(PF_LOCAL, SOCK_STREAM, 0);
172 if (config->force_unlink == 1)
173 unlink(config->socket_path);
175 memset(&serv_addr, 0, sizeof(struct sockaddr_un));
176 serv_addr.sun_family = PF_LOCAL;
177 strlcpy(serv_addr.sun_path, config->socket_path,
178 sizeof(serv_addr.sun_path));
179 serv_addr_len = sizeof(serv_addr.sun_family) +
180 strlen(serv_addr.sun_path) + 1;
182 if (bind(retval->sockfd, (struct sockaddr *)&serv_addr,
183 serv_addr_len) == -1) {
184 close(retval->sockfd);
187 LOG_ERR_2("runtime environment", "can't bind socket to path: "
188 "%s", config->socket_path);
189 TRACE_OUT(init_runtime_env);
192 LOG_MSG_2("runtime environment", "using socket %s",
193 config->socket_path);
196 * Here we're marking socket as non-blocking and setting its backlog
197 * to the maximum value
199 chmod(config->socket_path, config->socket_mode);
200 listen(retval->sockfd, -1);
201 fcntl(retval->sockfd, F_SETFL, O_NONBLOCK);
203 retval->queue = kqueue();
204 assert(retval->queue != -1);
206 EV_SET(&eventlist, retval->sockfd, EVFILT_READ, EV_ADD | EV_ONESHOT,
208 memset(&timeout, 0, sizeof(struct timespec));
209 kevent(retval->queue, &eventlist, 1, NULL, 0, &timeout);
211 LOG_MSG_2("runtime environment", "successfully initialized");
212 TRACE_OUT(init_runtime_env);
217 destroy_runtime_env(struct runtime_env *env)
219 TRACE_IN(destroy_runtime_env);
223 TRACE_OUT(destroy_runtime_env);
227 accept_connection(struct kevent *event_data, struct runtime_env *env,
228 struct configuration *config)
230 struct kevent eventlist[2];
231 struct timespec timeout;
232 struct query_state *qstate;
240 TRACE_IN(accept_connection);
241 fd = accept(event_data->ident, NULL, NULL);
243 LOG_ERR_2("accept_connection", "error %d during accept()",
245 TRACE_OUT(accept_connection);
249 if (getpeereid(fd, &euid, &egid) != 0) {
250 LOG_ERR_2("accept_connection", "error %d during getpeereid()",
252 TRACE_OUT(accept_connection);
256 qstate = init_query_state(fd, sizeof(int), euid, egid);
257 if (qstate == NULL) {
258 LOG_ERR_2("accept_connection", "can't init query_state");
259 TRACE_OUT(accept_connection);
263 memset(&timeout, 0, sizeof(struct timespec));
264 EV_SET(&eventlist[0], fd, EVFILT_TIMER, EV_ADD | EV_ONESHOT,
265 0, qstate->timeout.tv_sec * 1000, qstate);
266 EV_SET(&eventlist[1], fd, EVFILT_READ, EV_ADD | EV_ONESHOT,
267 NOTE_LOWAT, qstate->kevent_watermark, qstate);
268 res = kevent(env->queue, eventlist, 2, NULL, 0, &timeout);
270 LOG_ERR_2("accept_connection", "kevent error");
272 TRACE_OUT(accept_connection);
276 process_socket_event(struct kevent *event_data, struct runtime_env *env,
277 struct configuration *config)
279 struct kevent eventlist[2];
280 struct timeval query_timeout;
281 struct timespec kevent_timeout;
285 struct query_state *qstate;
287 TRACE_IN(process_socket_event);
288 eof_res = event_data->flags & EV_EOF ? 1 : 0;
291 memset(&kevent_timeout, 0, sizeof(struct timespec));
292 EV_SET(&eventlist[0], event_data->ident, EVFILT_TIMER, EV_DELETE,
294 nevents = kevent(env->queue, eventlist, 1, NULL, 0, &kevent_timeout);
296 if (errno == ENOENT) {
297 /* the timer is already handling this event */
298 TRACE_OUT(process_socket_event);
301 /* some other error happened */
302 LOG_ERR_2("process_socket_event", "kevent error, errno"
304 TRACE_OUT(process_socket_event);
308 qstate = (struct query_state *)event_data->udata;
311 * If the buffer that is to be send/received is too large,
312 * we send it implicitly, by using query_io_buffer_read and
313 * query_io_buffer_write functions in the query_state. These functions
314 * use the temporary buffer, which is later send/received in parts.
315 * The code below implements buffer splitting/mergind for send/receive
316 * operations. It also does the actual socket IO operations.
318 if (((qstate->use_alternate_io == 0) &&
319 (qstate->kevent_watermark <= (size_t)event_data->data)) ||
320 ((qstate->use_alternate_io != 0) &&
321 (qstate->io_buffer_watermark <= (size_t)event_data->data))) {
322 if (qstate->use_alternate_io != 0) {
323 switch (qstate->io_buffer_filter) {
325 io_res = query_socket_read(qstate,
327 qstate->io_buffer_watermark);
329 qstate->use_alternate_io = 0;
330 qstate->process_func = NULL;
332 qstate->io_buffer_p += io_res;
333 if (qstate->io_buffer_p ==
335 qstate->io_buffer_size) {
336 qstate->io_buffer_p =
338 qstate->use_alternate_io = 0;
347 if (qstate->use_alternate_io == 0) {
349 res = qstate->process_func(qstate);
350 } while ((qstate->kevent_watermark == 0) &&
351 (qstate->process_func != NULL) &&
355 qstate->process_func = NULL;
358 if ((qstate->use_alternate_io != 0) &&
359 (qstate->io_buffer_filter == EVFILT_WRITE)) {
360 io_res = query_socket_write(qstate, qstate->io_buffer_p,
361 qstate->io_buffer_watermark);
363 qstate->use_alternate_io = 0;
364 qstate->process_func = NULL;
366 qstate->io_buffer_p += io_res;
369 /* assuming that socket was closed */
370 qstate->process_func = NULL;
371 qstate->use_alternate_io = 0;
374 if (((qstate->process_func == NULL) &&
375 (qstate->use_alternate_io == 0)) ||
376 (eof_res != 0) || (res != 0)) {
377 destroy_query_state(qstate);
378 close(event_data->ident);
379 TRACE_OUT(process_socket_event);
383 /* updating the query_state lifetime variable */
384 get_time_func(&query_timeout);
385 query_timeout.tv_usec = 0;
386 query_timeout.tv_sec -= qstate->creation_time.tv_sec;
387 if (query_timeout.tv_sec > qstate->timeout.tv_sec)
388 query_timeout.tv_sec = 0;
390 query_timeout.tv_sec = qstate->timeout.tv_sec -
391 query_timeout.tv_sec;
393 if ((qstate->use_alternate_io != 0) && (qstate->io_buffer_p ==
394 qstate->io_buffer + qstate->io_buffer_size))
395 qstate->use_alternate_io = 0;
397 if (qstate->use_alternate_io == 0) {
399 * If we must send/receive the large block of data,
400 * we should prepare the query_state's io_XXX fields.
401 * We should also substitute its write_func and read_func
402 * with the query_io_buffer_write and query_io_buffer_read,
403 * which will allow us to implicitly send/receive this large
404 * buffer later (in the subsequent calls to the
405 * process_socket_event).
407 if (qstate->kevent_watermark > MAX_SOCKET_IO_SIZE) {
408 if (qstate->io_buffer != NULL)
409 free(qstate->io_buffer);
411 qstate->io_buffer = calloc(1,
412 qstate->kevent_watermark);
413 assert(qstate->io_buffer != NULL);
415 qstate->io_buffer_p = qstate->io_buffer;
416 qstate->io_buffer_size = qstate->kevent_watermark;
417 qstate->io_buffer_filter = qstate->kevent_filter;
419 qstate->write_func = query_io_buffer_write;
420 qstate->read_func = query_io_buffer_read;
422 if (qstate->kevent_filter == EVFILT_READ)
423 qstate->use_alternate_io = 1;
425 qstate->io_buffer_watermark = MAX_SOCKET_IO_SIZE;
426 EV_SET(&eventlist[1], event_data->ident,
427 qstate->kevent_filter, EV_ADD | EV_ONESHOT,
428 NOTE_LOWAT, MAX_SOCKET_IO_SIZE, qstate);
430 EV_SET(&eventlist[1], event_data->ident,
431 qstate->kevent_filter, EV_ADD | EV_ONESHOT,
432 NOTE_LOWAT, qstate->kevent_watermark, qstate);
435 if (qstate->io_buffer + qstate->io_buffer_size -
436 qstate->io_buffer_p <
437 MAX_SOCKET_IO_SIZE) {
438 qstate->io_buffer_watermark = qstate->io_buffer +
439 qstate->io_buffer_size - qstate->io_buffer_p;
440 EV_SET(&eventlist[1], event_data->ident,
441 qstate->io_buffer_filter,
442 EV_ADD | EV_ONESHOT, NOTE_LOWAT,
443 qstate->io_buffer_watermark,
446 qstate->io_buffer_watermark = MAX_SOCKET_IO_SIZE;
447 EV_SET(&eventlist[1], event_data->ident,
448 qstate->io_buffer_filter, EV_ADD | EV_ONESHOT,
449 NOTE_LOWAT, MAX_SOCKET_IO_SIZE, qstate);
452 EV_SET(&eventlist[0], event_data->ident, EVFILT_TIMER,
453 EV_ADD | EV_ONESHOT, 0, query_timeout.tv_sec * 1000, qstate);
454 kevent(env->queue, eventlist, 2, NULL, 0, &kevent_timeout);
456 TRACE_OUT(process_socket_event);
460 * This routine is called if timer event has been signaled in the kqueue. It
461 * just closes the socket and destroys the query_state.
464 process_timer_event(struct kevent *event_data, struct runtime_env *env,
465 struct configuration *config)
467 struct query_state *qstate;
469 TRACE_IN(process_timer_event);
470 qstate = (struct query_state *)event_data->udata;
471 destroy_query_state(qstate);
472 close(event_data->ident);
473 TRACE_OUT(process_timer_event);
477 * Processing loop is the basic processing routine, that forms a body of each
481 processing_loop(cache the_cache, struct runtime_env *env,
482 struct configuration *config)
484 struct timespec timeout;
485 const int eventlist_size = 1;
486 struct kevent eventlist[eventlist_size];
489 TRACE_MSG("=> processing_loop");
490 memset(&timeout, 0, sizeof(struct timespec));
491 memset(&eventlist, 0, sizeof(struct kevent) * eventlist_size);
494 nevents = kevent(env->queue, NULL, 0, eventlist,
495 eventlist_size, NULL);
497 * we can only receive 1 event on success
500 struct kevent *event_data;
501 event_data = &eventlist[0];
503 if ((int)event_data->ident == env->sockfd) {
504 for (i = 0; i < event_data->data; ++i)
505 accept_connection(event_data, env, config);
507 EV_SET(eventlist, s_runtime_env->sockfd,
508 EVFILT_READ, EV_ADD | EV_ONESHOT,
511 sizeof(struct timespec));
512 kevent(s_runtime_env->queue, eventlist,
513 1, NULL, 0, &timeout);
516 switch (event_data->filter) {
519 process_socket_event(event_data,
523 process_timer_event(event_data,
531 /* this branch shouldn't be currently executed */
535 TRACE_MSG("<= processing_loop");
539 * Wrapper above the processing loop function. It sets the thread signal mask
540 * to avoid SIGPIPE signals (which can happen if the client works incorrectly).
543 processing_thread(void *data)
545 struct processing_thread_args *args;
548 TRACE_MSG("=> processing_thread");
549 args = (struct processing_thread_args *)data;
552 sigaddset(&new, SIGPIPE);
553 if (pthread_sigmask(SIG_BLOCK, &new, NULL) != 0)
554 LOG_ERR_1("processing thread",
555 "thread can't block the SIGPIPE signal");
557 processing_loop(args->the_cache, args->the_runtime_env,
558 args->the_configuration);
560 TRACE_MSG("<= processing_thread");
566 get_time_func(struct timeval *time)
569 memset(&res, 0, sizeof(struct timespec));
570 clock_gettime(CLOCK_MONOTONIC, &res);
572 time->tv_sec = res.tv_sec;
577 * The idea of _nss_cache_cycle_prevention_function is that nsdispatch
578 * will search for this symbol in the executable. This symbol is the
579 * attribute of the caching daemon. So, if it exists, nsdispatch won't try
580 * to connect to the caching daemon and will just ignore the 'cache'
581 * source in the nsswitch.conf. This method helps to avoid cycles and
582 * organize self-performing requests.
584 * (not actually a function; it used to be, but it doesn't make any
585 * difference, as long as it has external linkage)
587 void *_nss_cache_cycle_prevention_function;
590 main(int argc, char *argv[])
592 struct processing_thread_args *thread_args;
595 struct pidfh *pidfile;
598 char const *config_file;
599 char const *error_str;
603 int trace_mode_enabled;
604 int force_single_threaded;
605 int do_not_daemonize;
606 int clear_user_cache_entries, clear_all_cache_entries;
607 char *user_config_entry_name, *global_config_entry_name;
609 int daemon_mode, interactive_mode;
612 /* by default all debug messages are omitted */
615 /* parsing command line arguments */
616 trace_mode_enabled = 0;
617 force_single_threaded = 0;
618 do_not_daemonize = 0;
619 clear_user_cache_entries = 0;
620 clear_all_cache_entries = 0;
622 user_config_entry_name = NULL;
623 global_config_entry_name = NULL;
624 while ((res = getopt(argc, argv, "nstdi:I:")) != -1) {
627 do_not_daemonize = 1;
630 force_single_threaded = 1;
633 trace_mode_enabled = 1;
636 clear_user_cache_entries = 1;
638 if (strcmp(optarg, "all") != 0)
639 user_config_entry_name = strdup(optarg);
642 clear_all_cache_entries = 1;
644 if (strcmp(optarg, "all") != 0)
645 global_config_entry_name =
658 daemon_mode = do_not_daemonize | force_single_threaded |
660 interactive_mode = clear_user_cache_entries | clear_all_cache_entries |
663 if ((daemon_mode != 0) && (interactive_mode != 0)) {
664 LOG_ERR_1("main", "daemon mode and interactive_mode arguments "
665 "can't be used together");
669 if (interactive_mode != 0) {
670 FILE *pidfin = fopen(DEFAULT_PIDFILE_PATH, "r");
673 struct nscd_connection_params connection_params;
674 nscd_connection connection;
679 errx(EXIT_FAILURE, "There is no daemon running.");
681 memset(pidbuf, 0, sizeof(pidbuf));
682 fread(pidbuf, sizeof(pidbuf) - 1, 1, pidfin);
685 if (ferror(pidfin) != 0)
686 errx(EXIT_FAILURE, "Can't read from pidfile.");
688 if (sscanf(pidbuf, "%d", &pid) != 1)
689 errx(EXIT_FAILURE, "Invalid pidfile.");
690 LOG_MSG_1("main", "daemon PID is %d", pid);
693 memset(&connection_params, 0,
694 sizeof(struct nscd_connection_params));
695 connection_params.socket_path = DEFAULT_SOCKET_PATH;
696 connection = open_nscd_connection__(&connection_params);
697 if (connection == INVALID_NSCD_CONNECTION)
698 errx(EXIT_FAILURE, "Can't connect to the daemon.");
700 if (clear_user_cache_entries != 0) {
701 result = nscd_transform__(connection,
702 user_config_entry_name, TT_USER);
705 "user cache transformation failed");
708 "user cache_transformation "
712 if (clear_all_cache_entries != 0) {
714 errx(EXIT_FAILURE, "Only root can initiate "
715 "global cache transformation.");
717 result = nscd_transform__(connection,
718 global_config_entry_name, TT_ALL);
721 "global cache transformation "
725 "global cache transformation "
729 close_nscd_connection__(connection);
731 free(user_config_entry_name);
732 free(global_config_entry_name);
733 return (EXIT_SUCCESS);
736 pidfile = pidfile_open(DEFAULT_PIDFILE_PATH, 0644, &pid);
737 if (pidfile == NULL) {
739 errx(EXIT_FAILURE, "Daemon already running, pid: %d.",
741 warn("Cannot open or create pidfile");
744 if (trace_mode_enabled == 1)
747 /* blocking the main thread from receiving SIGPIPE signal */
748 sigblock(sigmask(SIGPIPE));
751 if (do_not_daemonize == 0) {
752 res = daemon(0, trace_mode_enabled == 0 ? 0 : 1);
754 LOG_ERR_1("main", "can't daemonize myself: %s",
756 pidfile_remove(pidfile);
759 LOG_MSG_1("main", "successfully daemonized");
762 pidfile_write(pidfile);
764 s_agent_table = init_agent_table();
765 register_agent(s_agent_table, init_passwd_agent());
766 register_agent(s_agent_table, init_passwd_mp_agent());
767 register_agent(s_agent_table, init_group_agent());
768 register_agent(s_agent_table, init_group_mp_agent());
769 register_agent(s_agent_table, init_services_agent());
770 register_agent(s_agent_table, init_services_mp_agent());
771 LOG_MSG_1("main", "request agents registered successfully");
774 * Hosts agent can't work properly until we have access to the
775 * appropriate dtab structures, which are used in nsdispatch
778 register_agent(s_agent_table, init_hosts_agent());
781 /* configuration initialization */
782 s_configuration = init_configuration();
783 fill_configuration_defaults(s_configuration);
787 config_file = CONFIG_PATH;
789 res = parse_config_file(s_configuration, config_file, &error_str,
791 if ((res != 0) && (error_str == NULL)) {
792 config_file = DEFAULT_CONFIG_PATH;
793 res = parse_config_file(s_configuration, config_file,
794 &error_str, &error_line);
798 if (error_str != NULL) {
799 LOG_ERR_1("main", "error in configuration file(%s, %d): %s\n",
800 config_file, error_line, error_str);
802 LOG_ERR_1("main", "no configuration file found "
803 "- was looking for %s and %s",
804 CONFIG_PATH, DEFAULT_CONFIG_PATH);
806 destroy_configuration(s_configuration);
810 if (force_single_threaded == 1)
811 s_configuration->threads_num = 1;
813 /* cache initialization */
814 s_cache = init_cache_(s_configuration);
815 if (s_cache == NULL) {
816 LOG_ERR_1("main", "can't initialize the cache");
817 destroy_configuration(s_configuration);
821 /* runtime environment initialization */
822 s_runtime_env = init_runtime_env(s_configuration);
823 if (s_runtime_env == NULL) {
824 LOG_ERR_1("main", "can't initialize the runtime environment");
825 destroy_configuration(s_configuration);
826 destroy_cache_(s_cache);
830 if (s_configuration->threads_num > 1) {
831 threads = calloc(s_configuration->threads_num,
833 for (i = 0; i < s_configuration->threads_num; ++i) {
834 thread_args = malloc(
835 sizeof(*thread_args));
836 thread_args->the_cache = s_cache;
837 thread_args->the_runtime_env = s_runtime_env;
838 thread_args->the_configuration = s_configuration;
840 LOG_MSG_1("main", "thread #%d was successfully created",
842 pthread_create(&threads[i], NULL, processing_thread,
848 for (i = 0; i < s_configuration->threads_num; ++i)
849 pthread_join(threads[i], NULL);
851 LOG_MSG_1("main", "working in single-threaded mode");
852 processing_loop(s_cache, s_runtime_env, s_configuration);
856 /* runtime environment destruction */
857 destroy_runtime_env(s_runtime_env);
859 /* cache destruction */
860 destroy_cache_(s_cache);
862 /* configuration destruction */
863 destroy_configuration(s_configuration);
865 /* agents table destruction */
866 destroy_agent_table(s_agent_table);
868 pidfile_remove(pidfile);
869 return (EXIT_SUCCESS);