]> git.ipfire.org Git - thirdparty/snort3.git/blobdiff - configure_cmake.sh
Pull request #4336: appid: appid cpu profiler table rows limit and totals
[thirdparty/snort3.git] / configure_cmake.sh
index 5a8130a81bb4efe9370d49340bfc27fa6fd17f81..9b312d6c5e79e84f18854fad104425b0f5724886 100755 (executable)
@@ -1,6 +1,7 @@
 #!/bin/sh
 # Convenience wrapper for easily viewing/setting options that
 # the project's CMake scripts will recognize
+
 set -e
 command="$0 $*"
 
@@ -21,12 +22,15 @@ Usage: $0 [OPTION]... [VAR=VALUE]...
         --prefix=     Snort++ installation prefix
 
 Optional Features:
+    --build-type=[Debug|Release|RelWithDebInfo|MinSizeRel]
+                            set cmake build type (defaults to RelWithDebInfo if neither
+                            CFLAGS nor CXXFLAGS are set)
     --disable-FEATURE       do not include FEATURE (same as --enable-FEATURE=no)
     --enable-FEATURE[=ARG]  include FEATURE [ARG=yes]
     --enable-code-coverage  Whether to enable code coverage support
     --enable-hardened-build Detect and use compile-time hardening options
     --enable-pie            Attempt to produce a position-independent executable
-    --disable-safec         do not use libsafec bounds checking  even if available
+    --disable-safec         do not use libsafec bounds checking even if available
     --disable-static-ips-actions
                             do not include ips actions in binary
     --disable-static-inspectors
@@ -40,23 +44,40 @@ Optional Features:
     --disable-static-codecs do not include codecs in binary
     --enable-shell          enable command line shell support
     --enable-large-pcap     enable support for pcaps larger than 2 GB
-    --enable-tsc-clock      use timestamp counter register clock (x86 only)
+    --enable-stdlog         use file descriptor 3 instead of stdout for alerts
+    --enable-tsc-clock      use timestamp counter register clock (x86 and arm only)
     --enable-debug-msgs     enable debug printing options (bugreports and
                             developers only)
     --enable-debug          enable debugging options (bugreports and developers
                             only)
-    --enable-gdb            enable gdb debugging information
+    --disable-gdb           disable gdb debugging information
     --enable-gprof-profile  enable gprof profiling options (developers only)
+    --disable-snort-profiler
+                            disable snort performance profiling (cpu and memory) (developers only)
+    --enable-memory-profiler
+                            enable memory profiler
+    --enable-rule-profiler  enable rule keyword profiler (developers only)
+    --enable-deep-profiling enable deep (multi-level) profiling (developers only)
     --disable-corefiles     prevent Snort from generating core files
     --enable-address-sanitizer
                             enable address sanitizer support
     --enable-thread-sanitizer
                             enable thread sanitizer support
+    --enable-ub-sanitizer   enable undefined behavior sanitizer support
+    --enable-tcmalloc       enable using tcmalloc for dynamic memory management
+    --enable-jemalloc       enable using jemalloc for dynamic memory management
+    --enable-jemalloc-static
+                            same as --enable-jemalloc but linked statically
+    --enable-luajit-static  enable luajit linked statically
+    --enable-appid-third-party
+                            enable third party appid
     --enable-unit-tests     build unit tests
-    --enable-piglet         build piglet test harness
+    --enable-ccache         enable ccache support
     --disable-static-daq    link static DAQ modules
     --disable-html-docs     don't create the HTML documentation
     --disable-pdf-docs      don't create the PDF documentation
+    --disable-text-docs     don't create the TEXT documentation
+    --disable-docs          don't create documentation
 
 Optional Packages:
     --with-PACKAGE[=ARG]    use PACKAGE [ARG=yes]
@@ -85,16 +106,37 @@ Optional Packages:
                             libhs include directory
     --with-hyperscan-libraries=DIR
                             libhs library directory
+    --with-atomic-libraries=DIR
+                            atomic library directory
+    --with-flex-prefix=DIR
+                            flex prefix directory
+    --with-flex-includes=DIR
+                            flex include directory
+    --with-iconv-includes=DIR
+                            libiconv include directory
+    --with-iconv-libraries=DIR
+                            libiconv library directory
+    --with-uuid-includes=DIR
+                            libuuid include directory
+    --with-uuid-libraries=DIR
+                            libuuid library directory
+    --with-libml-includes=DIR
+                            libml include directory
+    --with-libml-libraries=DIR
+                            libml library directory
+    --without-libml         build Snort ML with mock of LibML
 
-Some influential environment variables:
-    SIGNAL_SNORT_RELOAD=<value>
-                set the SIGNAL_SNORT_RELOAD value
-    SIGNAL_SNORT_DUMP_STATS<value>
-                set the SIGNAL_SNORT_DUMP_STATS value
-    SIGNAL_SNORT_ROTATE_STATS<value>
-                set the SIGNAL_SNORT_ROTATE_STATS value
-    SIGNAL_SNORT_READ_ATTR_TBL<value>
-                set the SIGNAL_SNORT_READ_ATTR_TBL value
+Some influential variable definitions:
+    SIGNAL_SNORT_RELOAD=<int>
+                            override the signal used to reload configuration (default: SIGHUP)
+    SIGNAL_SNORT_DUMP_STATS=<int>
+                            override the signal used to dump run-time statistics (default: SIGUSR1)
+    SIGNAL_SNORT_ROTATE_STATS=<int>
+                            override the signal used to force rotation of stats files (default: SIGUSR2)
+    SIGNAL_SNORT_READ_ATTR_TBL=<int>
+                            override the signal used to reload the host attributes table (default: SIGURG)
+    SNORT_BUILD_NUMBER=<int>
+                            define a build number for this build of Snort
 "
 
 sourcedir="$( cd "$( dirname "$0" )" && pwd )"
@@ -108,31 +150,20 @@ append_cache_entry () {
     CMakeCacheEntries="$CMakeCacheEntries -D $1:$2=$3"
 }
 
-check_and_append_cache_entry() {
-    if [ -f $3 ]; then
-        append_cache_entry $1 $2 $3
-    else 
-        echo ""
-        echo "the $1 variable, which is specified using a --with-* options,"
-        echo "requires an absolute path to the library.  Could not stat the"
-        echo "the library:"
-        echo "    $3"
-        echo ""
-        exit 1
-    fi
-}
-
 # set defaults
 builddir=build
 prefix=/usr/local/snort
 CMakeCacheEntries=""
 append_cache_entry CMAKE_INSTALL_PREFIX PATH   $prefix
 
+build_type=""
+[ -z "$CFLAGS" ] && [ -z "$CXXFLAGS" ] && build_type="RelWithDebInfo"
+
 
 # parse arguments
 while [ $# -ne 0 ]; do
     case "$1" in
-        -*=*) optarg=`echo "$1" | sed 's/[-_a-zA-Z0-9]*=//'` ;;
+        *=*) optarg=`echo "$1" | sed 's/[-_a-zA-Z0-9]*=//'` ;;
         *) optarg= ;;
     esac
 
@@ -144,6 +175,9 @@ while [ $# -ne 0 ]; do
         --builddir=*)
             builddir=$optarg
             ;;
+        --define=*)
+            CMakeCacheEntries="$CMakeCacheEntries -D$optarg"
+            ;;
         --generator=*)
             CMakeGenerator="$optarg"
             ;;
@@ -220,9 +254,24 @@ while [ $# -ne 0 ]; do
         --enable-large-pcap)
             append_cache_entry ENABLE_LARGE_PCAP        BOOL true
             ;;
+        --enable-stdlog)
+            append_cache_entry ENABLE_STDLOG            BOOL true
+            ;;
         --enable-tsc-clock)
             append_cache_entry ENABLE_TSC_CLOCK         BOOL true
             ;;
+        --disable-snort-profiler)
+            append_cache_entry DISABLE_SNORT_PROFILER   BOOL false
+            ;;
+        --enable-memory-profiler)
+            append_cache_entry ENABLE_MEMORY_PROFILER   BOOL true
+            ;;
+        --enable-rule-profiler)
+            append_cache_entry ENABLE_RULE_PROFILER     BOOL true
+            ;;
+        --enable-deep-profiling)
+            append_cache_entry DEEP_PROFILING           BOOL true
+            ;;
         --disable-large-pcap)
             append_cache_entry ENABLE_LARGE_PCAP        BOOL false
             ;;
@@ -268,17 +317,54 @@ while [ $# -ne 0 ]; do
         --disable-thread-sanitizer)
             append_cache_entry ENABLE_THREAD_SANITIZER  BOOL false
             ;;
+        --enable-ub-sanitizer)
+            append_cache_entry ENABLE_UB_SANITIZER      BOOL true
+            ;;
+        --disable-ub-sanitizer)
+            append_cache_entry ENABLE_UB_SANITIZER      BOOL false
+            ;;
+        --enable-tcmalloc)
+            append_cache_entry ENABLE_TCMALLOC          BOOL true
+            tcm=1
+            ;;
+        --disable-tcmalloc)
+            append_cache_entry ENABLE_TCMALLOC          BOOL false
+            ;;
+        --enable-jemalloc)
+            append_cache_entry ENABLE_JEMALLOC          BOOL true
+            append_cache_entry STATIC_JEMALLOC          BOOL false
+            jem=1
+            ;;
+        --disable-jemalloc)
+            append_cache_entry ENABLE_JEMALLOC          BOOL false
+            ;;
+        --enable-jemalloc-static)
+            append_cache_entry ENABLE_JEMALLOC          BOOL true
+            append_cache_entry STATIC_JEMALLOC          BOOL true
+            ;;
+        --enable-luajit-static)
+            append_cache_entry STATIC_LUAJIT            BOOL true
+            ;;
+        --disable-jemalloc-static)
+            append_cache_entry ENABLE_JEMALLOC          BOOL false
+            ;;
+        --enable-appid-third-party)
+            ;;
         --enable-unit-tests)
             append_cache_entry ENABLE_UNIT_TESTS        BOOL true
             ;;
         --disable-unit-tests)
             append_cache_entry ENABLE_UNIT_TESTS        BOOL false
             ;;
-        --enable-piglet)
-            append_cache_entry ENABLE_PIGLET            BOOL true
+        --enable-benchmark-tests)
+            append_cache_entry ENABLE_BENCHMARK_TESTS   BOOL true
             ;;
-        --disable-piglet)
-            append_cache_entry ENABLE_PIGLET            BOOL false
+        --disable-benchmark-tests)
+            append_cache_entry ENABLE_BENCHMARK_TESTS   BOOL false
+            ;;
+        --enable-ccache)
+            append_cache_entry CMAKE_CXX_COMPILER_LAUNCHER STRING ccache
+            append_cache_entry CMAKE_C_COMPILER_LAUNCHER STRING ccache
             ;;
         --disable-static-daq)
             append_cache_entry ENABLE_STATIC_DAQ        BOOL false
@@ -298,11 +384,32 @@ while [ $# -ne 0 ]; do
         --enable-pdf-docs)
             append_cache_entry MAKE_PDF_DOC             BOOL true
             ;;
+        --disable-text-docs)
+            append_cache_entry MAKE_TEXT_DOC            BOOL false
+            ;;
+        --enable-text-docs)
+            append_cache_entry MAKE_TEXT_DOC            BOOL true
+            ;;
+        --disable-docs)
+            append_cache_entry MAKE_DOC                 BOOL false
+            ;;
+        --enable-docs)
+            append_cache_entry MAKE_DOC                 BOOL true
+            ;;
+        --build-type=*)
+            if [ $optarg = "Debug" ] || [ $optarg = "Release" ] ||
+            [ $optarg = "RelWithDebInfo" ] || [ $optarg = "MinSizeRel" ]; then
+                build_type=$optarg
+            else
+                echo "Invalid build type '$optarg'. Try $0 --help to see available build types."
+                exit 1
+            fi
+            ;;
         --with-pcap-includes=*)
-            append_cache_entry PCAP_INCLUDE_DIR PATH $optarg
+            append_cache_entry PCAP_INCLUDE_DIR_HINT PATH $optarg
             ;;
         --with-pcap-libraries=*)
-            append_cache_entry PCAP_LIBRARIES_DIR PATH $optarg
+            append_cache_entry PCAP_LIBRARIES_DIR_HINT PATH $optarg
             ;;
         --with-luajit-includes=*)
             append_cache_entry LUAJIT_INCLUDE_DIR_HINT PATH $optarg
@@ -331,19 +438,45 @@ while [ $# -ne 0 ]; do
         --with-openssl=*)
             append_cache_entry OPENSSL_ROOT_DIR PATH $optarg
             ;;
-#  Currently unsupported
-#        --with-intel-soft-cpm-includes=*)
-#            append_cache_entry INTEL_SOFT_CPM_INCLUDE_DIR PATH $optarg
-#            ;;
-#        --with-intel-soft-cpm-libraries=*)
-#            append_cache_entry INTEL_SOFT_CPM_LIBRARIES_DIR PATH $optarg
-#            ;;
         --with-hyperscan-includes=*)
             append_cache_entry HS_INCLUDE_DIR PATH $optarg
             ;;
         --with-hyperscan-libraries=*)
             append_cache_entry HS_LIBRARIES_DIR PATH $optarg
             ;;
+        --with-atomic-libraries=*)
+            append_cache_entry ATOMIC_LIBRARIES_DIR_HINT PATH $optarg
+            ;;
+        --with-flex-prefix=*)
+            append_cache_entry CMAKE_PREFIX_PATH PATH $optarg
+            ;;
+        --with-flex-includes=*)
+            append_cache_entry FLEX_INCLUDE_DIR_HINT PATH $optarg
+            ;;
+        --with-iconv-includes=*)
+            append_cache_entry ICONV_INCLUDE_DIR_HINT PATH $optarg
+            ;;
+        --with-iconv-libraries=*)
+            append_cache_entry ICONV_LIBRARIES_DIR_HINT PATH $optarg
+            ;;
+        --with-uuid-includes=*)
+            append_cache_entry UUID_INCLUDE_DIR_HINT PATH $optarg
+            ;;
+        --with-uuid-libraries=*)
+            append_cache_entry UUID_LIBRARIES_DIR_HINT PATH $optarg
+            ;;
+        --with-toolchain=*)
+            append_cache_entry CMAKE_TOOLCHAIN_FILE PATH $optarg
+            ;;
+        --with-libml-includes=*)
+            append_cache_entry ML_INCLUDE_DIR_HINT PATH $optarg
+            ;;
+        --with-libml-libraries=*)
+            append_cache_entry ML_LIBRARIES_DIR_HINT PATH $optarg
+            ;;
+        --without-libml)
+            append_cache_entry ENABLE_KAIZEN_MOCK BOOL true
+            ;;
         SIGNAL_SNORT_RELOAD=*)
             append_cache_entry SIGNAL_SNORT_RELOAD STRING $optarg
             ;;
@@ -356,6 +489,9 @@ while [ $# -ne 0 ]; do
         SIGNAL_SNORT_READ_ATTR_TBL=*)
             append_cache_entry SIGNAL_SNORT_READ_ATTR_TBL STRING $optarg
             ;;
+        SNORT_BUILD_NUMBER=*)
+            append_cache_entry VERSION_BUILD STRING $optarg
+            ;;
         *)
             echo "Invalid option '$1'.  Try $0 --help to see available options."
             exit 1
@@ -364,6 +500,11 @@ while [ $# -ne 0 ]; do
     shift
 done
 
+if [ "$tcm" -eq 1 -a "$jem" -eq 1 ] ; then
+    echo "--enable-jemalloc and --enable-tcmalloc are mutually exclusive; enable at most one"
+    exit 2
+fi
+
 if [ -d $builddir ]; then
     # If build directory exists, check if it has a CMake cache
     if [ -f $builddir/CMakeCache.txt ]; then
@@ -380,12 +521,13 @@ echo "Build Directory : $builddir"
 echo "Source Directory: $sourcedir"
 cd $builddir
 
-gen=""
-[ "$CMakeGenerator" ] && gen+=" -G $CMakeGenerator"
+[ "$CMakeGenerator" ] && gen="-G $CMakeGenerator"
 
-cmake $gen \
+cmake "$gen" \
     -DCMAKE_CXX_FLAGS:STRING="$CXXFLAGS $CPPFLAGS" \
     -DCMAKE_C_FLAGS:STRING="$CFLAGS $CPPFLAGS" \
+    -DCMAKE_EXPORT_COMPILE_COMMANDS=ON \
+    -DCMAKE_BUILD_TYPE:STRING=$build_type \
     $CMakeCacheEntries $sourcedir
 
 echo "# This is the command used to configure this build" > config.status