detect-engine-loader.h

Go to the documentation of this file.

/* Copyright (C) 2015 Open Information Security Foundation
 *
 * You can copy, redistribute or modify this Program under the terms of
 * the GNU General Public License version 2 as published by the Free
 * Software Foundation.
 *
 * This program 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * version 2 along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
 * 02110-1301, USA.
 */
 
/**
 * \file
 *
 * \author Victor Julien <victor@inliniac.net>
 *
 * Detect loader API, for using multiple 'loader' threads
 * that can load multiple detection engines in parallel.
 */
 
#ifndef SURICATA_DETECT_ENGINE_LOADER_H
#define SURICATA_DETECT_ENGINE_LOADER_H
 
/**
 * \param ctx function specific data
 * \param loader_id id of the loader that executed the task
 */
typedef int (*LoaderFunc)(void *ctx, int loader_id);
typedef void (*LoaderFreeFunc)(void *ctx);
 
typedef struct DetectLoaderTask_ {
    LoaderFunc Func;
    void *ctx;
    LoaderFreeFunc FreeFunc;
    TAILQ_ENTRY(DetectLoaderTask_) next;
} DetectLoaderTask;
 
typedef struct DetectLoaderControl_ {
    int id;
    ThreadVars *tv; /**< loader threads threadvars - for waking them up */
 
    /** struct to group members and mutex */
    struct {
        SCMutex m;  /**< mutex protects result and task_list */
        int result; /**< 0 for ok, error otherwise */
        TAILQ_HEAD(, DetectLoaderTask_) task_list;
    };
} DetectLoaderControl;
 
int DetectLoaderQueueTask(int loader_id, LoaderFunc Func, void *func_ctx, LoaderFreeFunc FreeFunc);
int DetectLoadersSync(void);
void DetectLoadersInit(void);
 
void TmThreadContinueDetectLoaderThreads(void);
void DetectLoaderThreadSpawn(void);
void TmModuleDetectLoaderRegister (void);
 
#endif /* SURICATA_DETECT_ENGINE_LOADER_H */