DML release v0.1.6-beta

intel · Dec 10, 2021 · 64ce5ff · 64ce5ff
1 parent 69fbcfb
commit 64ce5ff
Show file tree

Hide file tree

Showing 177 changed files with 8,742 additions and 9,531 deletions.
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -14,7 +14,7 @@
 #
 
 cmake_minimum_required(VERSION 3.12 FATAL_ERROR)
-project(Dml VERSION 0.1.5 LANGUAGES C CXX)
+project(Dml VERSION 0.1.6 LANGUAGES C CXX)
 
 set(PROJECT_SOVERSION 0)
 
@@ -28,7 +28,6 @@ else()
 endif()
 
 # TODO: Remove all options below
-option(LIB_ACCEL_3_2 "Use libaccel-3.2" OFF)
 option(LOG_HW_INIT "Enables HW initialization log" OFF)
 option(EFFICIENT_WAIT "Enables usage of umonitor/umwait" OFF)
 
@@ -61,14 +60,13 @@ message(STATUS "Build type: ${CMAKE_BUILD_TYPE}")
 # TODO: Remove when option is removed
 if (DML_HW)
     message(STATUS "HW path: ON")
+    message(STATUS "Hardware initialization logging: ${LOG_HW_INIT}")
 endif()
 
 # TODO: Remove
 get_git_revision()
 
 add_subdirectory(sources)
-
-# Testing
 add_subdirectory(examples)
 
 # Install rules

diff --git a/CODEOWNERS b/CODEOWNERS
@@ -12,7 +12,3 @@
 # express or implied warranties, other than those that are expressly
 # stated in the License.
 #
-
-# Repository Control Files
-.gitignore      [email protected]
-CODEOWNERS      [email protected]
diff --git a/Doxyfile b/Doxyfile
@@ -53,7 +53,7 @@ PROJECT_NAME           = "Intel DML Library"
 # could be handy for archiving the generated documentation or if some version
 # control system is used.
 
-PROJECT_NUMBER         = "v0.1.5-beta"
+PROJECT_NUMBER         = "v0.1.6-beta"
 
 # Using the PROJECT_BRIEF tag one can provide an optional one line description
 # for a project that appears at the top of each page and should give viewer a
@@ -831,8 +831,9 @@ WARN_LOGFILE           =
 # Note: If this tag is empty the current directory is searched.
 
 INPUT                  = examples \
-                         sources \
                          README.md \
+                         CONTRIBUTING.md \
+                         SECURITY.md \
                          include \
                          doc/LOW_LEVEL_API_GUIDE.md \
                          doc/HIGH_LEVEL_API_GUIDE.md \
@@ -922,9 +923,7 @@ RECURSIVE              = YES
 # Note that relative paths are relative to the directory from which doxygen is
 # run.
 
-EXCLUDE                = sources/hw-path/include/libaccel_config.h \
-                         include/dml/cpp/middle_layer/\
-                         sources/middle_layer/
+EXCLUDE                = include/dml/detail
 
 # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
 # directories that are symbolic links (a Unix file system feature) are excluded
@@ -961,15 +960,12 @@ EXCLUDE_SYMBOLS        = *_H__ \
                          DML_CORE_CHECK_* \
                          DML_BAD_* \
                          DML_PACKED_STRUCT_DECLARATION* \
-                         TEST_REGISTER* \
                          NULL \
                          DML_FUN \
                          OWN_API \
                          OWN_FUN \
                          OWN_API_INLINE \
-                         OWN_FUN_INLINE \
-                         DML_JOB_API_TEST_REGISTER \
-                         DML_UNIT_TEST_REGISTER
+                         OWN_FUN_INLINE
 
 # The EXAMPLE_PATH tag can be used to specify one or more files or directories
 # that contain example code fragments that are included (see the \include

diff --git a/README.md b/README.md
@@ -68,11 +68,6 @@ Note:
 cmake -DCMAKE_BUILD_TYPE=Release -DDML_HW=ON <path_to_cmake_folder>
 ```
 
-```shell
-# Enable libaccel-config-3.2 support for hardware path
-cmake -DCMAKE_BUILD_TYPE=Release -DDML_HW=ON -DLIB_ACCEL_3_2=ON <path_to_cmake_folder> 
-```
-
 - To enable `-frecord-gcc-switches` flag, use the DML_RECORD_SWITCHES option as follows:
 
 ```shell
@@ -85,7 +80,7 @@ The resulting library is available in the `<install_dir>/lib` folder.
 ## Documentation
 
 - [Intel DML Reference Manual](./doc/DML_REFERENCE_MANUAL.md)
-- [Security Policy](doc/SECURITY.md) 
+- [Security Policy](./SECURITY.md) 
 
 To generate full documentation from sources with Doxygen, use the following commands:
 
@@ -100,12 +95,12 @@ To open the generated HTML Reference, open the `<dml_library>/doc/html/index.htm
 
 ## How to Contribute
 
-See [Contributing document](CONTRIBUTING.md) for details about contribution process.
+See [Contributing document](./CONTRIBUTING.md) for details about contribution process.
 
 ## License
 
 The library is licensed under the MIT license. Refer to the
-"[LICENSE](LICENSE)" file for the full license text.
+"[LICENSE](./LICENSE)" file for the full license text.
 
 This distribution includes third party software governed by separate license
-terms (see "[THIRD-PARTY-PROGRAMS](THIRD-PARTY-PROGRAMS)").
+terms (see "[THIRD-PARTY-PROGRAMS](./third-party-programs.txt)").
diff --git a/cmake/gnu.cmake b/cmake/gnu.cmake
@@ -26,10 +26,13 @@ list(APPEND DML_SECURITY_DEFINITIONS
     $<$<CONFIG:RELEASE>:_FORTIFY_SOURCE=2>)
 
 list(APPEND DML_QUALITY_OPTIONS
-    $<$<BOOL:${DML_WERROR}>:-Werror>
     -Wall
     -Wextra
     -pedantic
     )
 
-list(APPEND DML_AVX512_OPTIONS -march=skylake-avx512) #  -mavx512dq -mavx512vl -mavx512bw -mclflushopt -mclwb
+list(APPEND DML_CPP_PRIVATE_OPTIONS
+        -fno-exceptions
+        -fno-rtti
+        -fno-threadsafe-statics
+        )
diff --git a/cmake/msvc.cmake b/cmake/msvc.cmake
@@ -19,9 +19,6 @@ list(APPEND DML_SECURITY_OPTIONS
 
 list(APPEND DML_SECURITY_DEFINITIONS)
 
-list(APPEND DML_QUALITY_OPTIONS
-    $<$<BOOL:DML_WERROR>:/Wx>>
-    #/Wall MSVC warning level can be set only via CMAKE_CXX_FLAGS
-    )
+list(APPEND DML_QUALITY_OPTIONS /W3)
 
-list(APPEND DML_AVX512_OPTIONS /arch:AVX512)
+list(APPEND DML_CPP_PRIVATE_OPTIONS)
diff --git a/doc/DML_REFERENCE_MANUAL.md b/doc/DML_REFERENCE_MANUAL.md
@@ -119,14 +119,14 @@ Hardware path is required to set up environment to utilize Intel DSA accelerator
 
 ### Build Prerequisites
 - Compiler:
-    - Linux* OS: gcc 8.2 or higher
-    - Windows* OS: MSVC 19 or higher
- - Libraries:    
-    - Linux: Universally Unique ID library: `uuid-dev` version 2.35.2 or higher.
+  - Linux* OS: gcc 8.2 or higher
+  - Windows* OS: MSVC 19 or higher
+- Libraries:
+  - Linux: Universally Unique ID library: `uuid-dev` version 2.35.2 or higher.
 - Cross-platform build tool: CMake* version 3.12 or higher
 - Make: GNU 'make' (Linux* OS) or 'nmake' (Windows*)
-- Documentation generator: 
-    - Doxygen 1.8.17 or higher
+- Documentation generator:
+  - Doxygen 1.8.17 or higher
 
 
 

diff --git a/doc/RELEASE_NOTES.md b/doc/RELEASE_NOTES.md
@@ -1,6 +1,31 @@
 Intel® Data Mover Library (Intel® DML) Release Notes
 ===============================================================================
 
+### Intel® DML v0.1.6-beta
+
+**Date: December 2021**
+
+**Note**: Release introduces bug fixes and several minor improvements
+
+**Features**:
+* Improved incorrect input checking
+* Added check for adjacent buffers for the DIF Strip operation. Status: `DML_STATUS_DIF_STRIP_ADJACENT_ERROR`
+* Reworked hardware related statuses for C API
+* Added new status to indicate submission failure:
+  * `DML_STATUS_WORK_QUEUES_NOT_AVAILABLE` for C API
+  * `dml::status_code::queue_busy` for C++ API
+* Removed LIBACCEL_3_2 cmake option. The supported version of accel-config is now 3.2 and higher
+* NUMA node id is detected before each submission now, so threads are safe to change nodes at any time
+
+**Bug fix**:
+* Fixed the issue when batch operation doesn't work for buffer not aligned on 64 bytes boundary
+* Fixed the issue when current thread NUMA node id is deduced incorrectly
+* Fixed crashes when there are no available devices for the current thread NUMA node id
+* Removed dependencies on C++ runtime from C API
+
+**Warnings**:
+* As NUMA node id of the current thread is now deduced correctly, ensure that accelerators' configuration is compatible. The library does no cross-socket submissions. If there is no available device for the current NUMA node id, then an error status code is reported.
+
 ### Intel® DML v0.1.5-beta
 
 **Date: November 2021**

diff --git a/examples/dml_job_api/job_wrapper_launchers.c b/examples/dml_job_api/job_wrapper_launchers.c
@@ -414,7 +414,8 @@ dml_status_t dif_strip_sample_launcher(dml_job_t *const dml_job_ptr)
            DIF_SAMPLE_REFERENCE_ARRAY_SIZE,
            DIF_SAMPLE_BLOCK_SIZE);
 
-    uint8_t source_array[DIF_SAMPLE_REFERENCE_ARRAY_SIZE];
+    // The same size used because of DML_STATUS_DIF_STRIP_ADJACENT_ERROR
+    uint8_t source_array[DIF_SAMPLE_PROTECTED_ARRAY_SIZE];
     uint8_t destination_array[DIF_SAMPLE_PROTECTED_ARRAY_SIZE];
 
     dml_status_t status = dml_dif_insert_8u(source_array,

diff --git a/include/dml/cpp/detail/make_result.hpp b/include/dml/cpp/detail/make_result.hpp
diff --git a/include/dml/cpp/middle_layer/awaiter.hpp b/include/dml/cpp/middle_layer/awaiter.hpp