mainloop-worker.h

Go to the documentation of this file.

/*
 * Copyright (c) 2002-2013 Balabit
 * Copyright (c) 1998-2013 Balázs Scheidler
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 *
 * As an additional exemption you are allowed to compile & link against the
 * OpenSSL libraries as published by the OpenSSL project. See the file
 * COPYING for details.
 *
 */
#ifndef MAINLOOP_WORKER_H_INCLUDED
#define MAINLOOP_WORKER_H_INCLUDED 1
 
#include "mainloop.h"
 
#include <iv_list.h>
 
#define MAIN_LOOP_MIN_WORKER_THREADS 2
#define MAIN_LOOP_MAX_WORKER_THREADS 256
 
typedef enum
{
  MLW_UNKNOWN,
  MLW_ASYNC_WORKER = 1,
  MLW_THREADED_OUTPUT_WORKER,
  MLW_THREADED_INPUT_WORKER,
  MAIN_LOOP_WORKER_TYPE_MAX
} MainLoopWorkerType;
 
/*
 * A batch callback is registered during the processing of messages in a
 * given thread.  Batch callbacks are invoked when the batch is complete.
 *
 * This mechanism is used by LogQueueFifo implementation, that consumes
 * messages into a per-thread, unlocked queue first and once the whole batch
 * is in, it grabs a lock and propagates the elements towards the consumer.
 */
 
typedef struct _WorkerBatchCallback
{
  struct iv_list_head list;
  MainLoopTaskFunc func;
  gpointer user_data;
} WorkerBatchCallback;
 
static inline void
worker_batch_callback_init(WorkerBatchCallback *self)
{
  INIT_IV_LIST_HEAD(&self->list);
}
 
void main_loop_worker_register_batch_callback(WorkerBatchCallback *cb);
void main_loop_worker_invoke_batch_callbacks(void);
void main_loop_worker_assert_batch_callbacks_were_processed(void);
 
typedef void (*WorkerExitNotificationFunc)(gpointer user_data);
 
gint main_loop_worker_get_thread_index(void);
 
void main_loop_worker_job_start(void);
void main_loop_worker_job_complete(void);
 
void main_loop_worker_thread_start(MainLoopWorkerType worker_type);
void main_loop_worker_thread_stop(void);
void main_loop_worker_run_gc(void);
void main_loop_worker_register_exit_notification_callback(WorkerExitNotificationFunc func, gpointer user_data);
gboolean main_loop_worker_is_worker_thread(void);
 
void main_loop_worker_sync_call(void (*func)(void *user_data), void *user_data);
void main_loop_sync_worker_startup_and_teardown(void);
 
gboolean is_reloading_scheduled(void);
void set_reloading_scheduled(gboolean scheduled);
 
gboolean main_loop_worker_job_quit(void);
 
gdouble mainloop_sleep_time(const gdouble delay);
/* NOTE: If any of the threads using these and the return value
*        (a.k.a the value of main_loop_workers_quit) is TURE,
 *       the callers must ensure that the thread will exit as soon as possible, and
 *       never call these function again.
 *       (as the exit condition might not be signaled anymore, and the wait would block forever)
 */
gboolean main_loop_worker_wait_for_exit_until(gdouble wait_time);
void main_loop_worker_wait_for_exit(void);
 
void main_loop_worker_init(void);
void main_loop_worker_deinit(void);
 
gint main_loop_worker_get_max_number_of_threads(void);
void main_loop_worker_allocate_thread_space(gint num_threads);
void main_loop_worker_finalize_thread_space(void);
 
static inline void
main_loop_assert_worker_thread(void)
{
#if SYSLOG_NG_ENABLE_DEBUG
  g_assert(main_loop_worker_is_worker_thread());
#endif
}
 
#endif