api: hs_valid_platform

diff --git a/CMakeLists.txt b/CMakeLists.txt
index 9f953c6ea9ffc59af875419ae1f6e11569adf015..e9e8f3fab2d49774572a479d3ceb2c7000235b7e 100644 (file)
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -1049,7 +1049,7 @@ if (NOT FAT_RUNTIME)
         add_library(hs_exec OBJECT ${hs_exec_common_SRCS} ${hs_exec_SRCS})
     endif()
 
-    add_library(hs_runtime STATIC src/hs_version.c $<TARGET_OBJECTS:hs_exec>)
+    add_library(hs_runtime STATIC src/hs_version.c src/hs_valid_platform.c $<TARGET_OBJECTS:hs_exec>)
     set_target_properties(hs_runtime PROPERTIES LINKER_LANGUAGE C)
 
     if (BUILD_STATIC_AND_SHARED OR BUILD_SHARED_LIBS)
@@ -1131,9 +1131,15 @@ endif()
 
 if (BUILD_STATIC_AND_SHARED OR BUILD_SHARED_LIBS)
     if (NOT FAT_RUNTIME)
-        add_library(hs_runtime_shared SHARED src/hs_version.c $<TARGET_OBJECTS:hs_exec_shared>)
-    else()
-        add_library(hs_runtime_shared SHARED src/hs_version.c $<TARGET_OBJECTS:hs_exec_common_shared> $<TARGET_OBJECTS:hs_exec_shared_core2> $<TARGET_OBJECTS:hs_exec_shared_corei7> $<TARGET_OBJECTS:hs_exec_shared_avx2>)
+        add_library(hs_runtime_shared SHARED src/hs_version.c src/hs_valid_platform.c
+$<TARGET_OBJECTS:hs_exec_shared>)
+            else()
+        add_library(hs_runtime_shared SHARED src/hs_version.c
+            src/hs_valid_platform.c
+            $<TARGET_OBJECTS:hs_exec_common_shared>
+            $<TARGET_OBJECTS:hs_exec_shared_core2>
+            $<TARGET_OBJECTS:hs_exec_shared_corei7>
+            $<TARGET_OBJECTS:hs_exec_shared_avx2>)
     endif()
     set_target_properties(hs_runtime_shared PROPERTIES
         VERSION ${LIB_VERSION}
@@ -1148,10 +1154,12 @@ if (BUILD_STATIC_AND_SHARED OR BUILD_SHARED_LIBS)
 endif()
 
 if (NOT FAT_RUNTIME)
-    add_library(hs STATIC ${hs_SRCS} $<TARGET_OBJECTS:hs_exec>)
+    add_library(hs STATIC ${hs_SRCS} src/hs_valid_platform.c $<TARGET_OBJECTS:hs_exec>)
 else()
-# we want the static lib for testing
-add_library(hs STATIC src/hs_version.c ${hs_SRCS} $<TARGET_OBJECTS:hs_exec_common>  $<TARGET_OBJECTS:hs_exec_core2> $<TARGET_OBJECTS:hs_exec_corei7> $<TARGET_OBJECTS:hs_exec_avx2>)
+    # we want the static lib for testing
+    add_library(hs STATIC src/hs_version.c src/hs_valid_platform.c
+        ${hs_SRCS} $<TARGET_OBJECTS:hs_exec_common> $<TARGET_OBJECTS:hs_exec_core2>
+        $<TARGET_OBJECTS:hs_exec_corei7> $<TARGET_OBJECTS:hs_exec_avx2>)
 endif()
 
 add_dependencies(hs ragel_Parser)
@@ -1162,9 +1170,14 @@ endif()
 
 if (BUILD_STATIC_AND_SHARED OR BUILD_SHARED_LIBS)
     if (NOT FAT_RUNTIME)
-        add_library(hs_shared SHARED src/hs_version.c ${hs_SRCS} $<TARGET_OBJECTS:hs_exec_shared>)
+        add_library(hs_shared SHARED src/hs_version.c src/hs_valid_platform.c
+            ${hs_SRCS} $<TARGET_OBJECTS:hs_exec_shared>)
     else()
-        add_library(hs_shared SHARED src/hs_version.c ${hs_SRCS} $<TARGET_OBJECTS:hs_exec_common_shared> $<TARGET_OBJECTS:hs_exec_shared_core2> $<TARGET_OBJECTS:hs_exec_shared_corei7> $<TARGET_OBJECTS:hs_exec_shared_avx2>)
+        add_library(hs_shared SHARED src/hs_version.c src/hs_valid_platform.c
+            ${hs_SRCS} $<TARGET_OBJECTS:hs_exec_common_shared>
+            $<TARGET_OBJECTS:hs_exec_shared_core2>
+            $<TARGET_OBJECTS:hs_exec_shared_corei7>
+            $<TARGET_OBJECTS:hs_exec_shared_avx2>)
     endif()
     add_dependencies(hs_shared ragel_Parser)
     set_target_properties(hs_shared PROPERTIES

diff --git a/src/hs_common.h b/src/hs_common.h
index ad8d9880e8b836f2ff49be021bc6675289c2a222..b25b1842340eff46829661ffc497b87c24753837 100644 (file)
--- a/src/hs_common.h
+++ b/src/hs_common.h
@@ -435,6 +435,23 @@ hs_error_t hs_set_stream_allocator(hs_alloc_t alloc_func, hs_free_t free_func);
  */
 const char *hs_version(void);
 
+/**
+ * Utility function to test the current system architecture.
+ *
+ * Hyperscan requires the Supplemental Streaming SIMD Extensions 3 instruction
+ * set. This function can be called on any x86 platform to determine if the
+ * system provides the required instruction set.
+ *
+ * This function does not test for more advanced features if Hyperscan has
+ * been built for a more specific architecture, for example the AVX2
+ * instruction set.
+ *
+ * @return
+ *      @ref HS_SUCCESS on success, @ref HS_ARCH_ERROR if system does not
+ *      support Hyperscan.
+ */
+hs_error_t hs_valid_platform(void);
+
 /**
  * @defgroup HS_ERROR hs_error_t values
  *

diff --git a/src/hs_valid_platform.c b/src/hs_valid_platform.c
new file mode 100644 (file)
index 0000000..939cde1
--- /dev/null
+++ b/src/hs_valid_platform.c
@@ -0,0 +1,40 @@
+/*
+ * Copyright (c) 2016, Intel Corporation
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ *  * Redistributions of source code must retain the above copyright notice,
+ *    this list of conditions and the following disclaimer.
+ *  * Redistributions in binary form must reproduce the above copyright
+ *    notice, this list of conditions and the following disclaimer in the
+ *    documentation and/or other materials provided with the distribution.
+ *  * Neither the name of Intel Corporation nor the names of its contributors
+ *    may be used to endorse or promote products derived from this software
+ *    without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
+
+#include "hs_common.h"
+#include "util/cpuid_flags.h"
+
+HS_PUBLIC_API
+hs_error_t hs_valid_platform(void) {
+    /* Hyperscan requires SSSE3, anything else is a bonus */
+    if (check_ssse3()) {
+        return HS_SUCCESS;
+    } else {
+        return HS_ARCH_ERROR;
+    }
+}

diff --git a/unit/hyperscan/arg_checks.cpp b/unit/hyperscan/arg_checks.cpp
index d277a26bf3fcee29c8644ca0105e2a3b80a4223d..8e86cc64d47c301787c39d3ddb8969d361276af4 100644 (file)
--- a/unit/hyperscan/arg_checks.cpp
+++ b/unit/hyperscan/arg_checks.cpp
@@ -84,6 +84,12 @@ void breakDatabaseBytecode(hs_database *db) {
     *bytecode += 3;
 }
 
+// Check that hs_valid_platform says we can run here
+TEST(HyperscanArgChecks, ValidPlatform) {
+    hs_error_t error = hs_valid_platform();
+    ASSERT_EQ(HS_SUCCESS, error) << "hs_valid_platform should return zero";
+}
+
 // Check that hs_version gives us a reasonable string back
 TEST(HyperscanArgChecks, Version) {
     const char *version = hs_version();