runmode-lib.h

Go to the documentation of this file.

/* Copyright (C) 2023-2024 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 Angelo Mirabella <angelo.mirabella@broadcom.com>
 *
 *  Library runmode.
 */
 
#ifndef SURICATA_RUNMODE_LIB_H
#define SURICATA_RUNMODE_LIB_H
 
#include "threadvars.h"
 
/** \brief register runmodes for suricata as a library */
void SCRunModeLibIdsRegister(void);
 
/** \brief runmode for live packet processing */
int SCRunModeLibIdsLive(void);
 
/** \brief runmode for offline packet processing (pcap files) */
int SCRunModeLibIdsOffline(void);
 
/** \brief runmode default mode (live) */
const char *SCRunModeLibGetDefaultMode(void);
 
/**
 * \brief Create ThreadVars for use by a user provided thread.
 *
 * Unlike other runmodes, this does not spawn a thread, as the threads
 * are controlled by the application using Suricata as a library.
 *
 * \param worker_id an ID to give this ThreadVars instance
 *
 * \return Pointer to allocated ThreadVars or NULL on failure
 */
ThreadVars *SCRunModeLibCreateThreadVars(int worker_id);
 
/** \brief start the "fake" worker.
 *
 *  This method performs all the initialization tasks.
 */
int SCRunModeLibSpawnWorker(void *);
 
#endif /* SURICATA_RUNMODE_LIB_H */