Add ntl::Irql.

Add ntl::spin_lock.
Add ntl::resource.

Author: ntoskrnl7

README.md

@@ -161,6 +161,25 @@ Provides features to support a better development environment in the kernel.
     * ntl::rpc::client [(tested)](./test/app/src/main.cpp#L4) [(tested)](./test/common/rpc.hpp)
       * I did not have enough time to implement the data serialization part myself, so I referred to the contents of the project below. thank you! :-)
         * [Eyal Z/zpp serializer](https://github.com/eyalz800/serializer)
+* ntl::irql
+  * Class for KIRQL
+  * Classes
+    * ntl::irql [(tested)](./test/driver/src/ntl.cpp#L46)
+  * Functions
+    * ntl::raise_irql [(tested)](./test/driver/src/ntl.cpp#L49)
+    * raise_irql_to_dpc_level [(tested)](./test/driver/src/ntl.cpp#L62)
+    * raise_irql_to_synch_level [(tested)](./test/driver/src/ntl.cpp#L71)
+* ntl::spin_lock
+  * Class for KSPIN_LOCK
+  * Classes
+    * ntl::spin_lock [(tested)](./test/driver/src/ntl.cpp#L80)
+    * ntl::unique_lock [(tested)](./test/driver/src/ntl.cpp#L99)
+* ntl::resource
+  * Class for ERESOURCE
+  * Classes
+    * ntl::resource [(tested)](./test/driver/src/ntl.cpp#L117)
+    * ntl::unique_lock [(tested)](./test/driver/src/ntl.cpp#L156)
+    * ntl::shared_lock [(tested)](./test/driver/src/ntl.cpp#L179)
 
 ## Requirements
 
@@ -187,7 +206,7 @@ Provides features to support a better development environment in the kernel.
   * 14.26.28801
   * 14.29.30133
   * 14.31.31103
-* Windows Kit (SDK, WDK)
+* Windows Kits (SDK, WDK)
   * 10.0.17763.0
   * 10.0.18362.0
   * 10.0.22000.0
@@ -281,7 +300,7 @@ If the SDK and WDK versions are different, builds are more likely to fail. **If
         include(cmake/CPM.cmake)
 
         set(CRTSYS_NTL_MAIN ON) # use ntl::main
-        CPMAddPackage("gh:ntoskrnl7/[email protected].8")
+        CPMAddPackage("gh:ntoskrnl7/[email protected].9")
         include(${crtsys_SOURCE_DIR}/cmake/CrtSys.cmake)
 
         # add driver

docs/ko-kr.md

@@ -147,7 +147,7 @@ crtsys의 장점은 아래와 같습니다.
     * [x] Create device [(tested)](../test/driver/src/main.cpp#L44)
 * ntl::device
   * DEVICE_OBJECT에 대한 클래스
-  * Features
+  * 기능
     * [x] Device Extension [(tested)](../test/driver/src/main.cpp#L33)
     * [ ] IRP_MJ_CREATE
     * [ ] IRP_MJ_CLOSE
@@ -161,6 +161,25 @@ crtsys의 장점은 아래와 같습니다.
     * ntl::rpc::client [(tested)](../test/app/src/main.cpp#L4) [(tested)](../test/common/rpc.hpp)
       * 데이터 직렬화 부분을 직접 구현하기에는 시간이 부족하여 아래 프로젝트 내용을 참고했습니다. 감사합니다! :-)
         * [Eyal Z/zpp serializer](https://github.com/eyalz800/serializer)
+* ntl::irql
+  * KIRQL에 대한 클래스
+  * 클래스
+    * ntl::irql [(tested)](../test/driver/src/ntl.cpp#L46)
+  * 함수
+    * ntl::raise_irql [(tested)](../test/driver/src/ntl.cpp#L49)
+    * raise_irql_to_dpc_level [(tested)](../test/driver/src/ntl.cpp#L62)
+    * raise_irql_to_synch_level [(tested)](../test/driver/src/ntl.cpp#L71)
+* ntl::spin_lock
+  * KSPIN_LOCK에 대한 클래스
+  * 클래스
+    * ntl::spin_lock [(tested)](../test/driver/src/ntl.cpp#L80)
+    * ntl::unique_lock [(tested)](../test/driver/src/ntl.cpp#L99)
+* ntl::resource
+  * ERESOURCE에 대한 클래스
+  * 클래스
+    * ntl::resource [(tested)](../test/driver/src/ntl.cpp#L117)
+    * ntl::unique_lock [(tested)](../test/driver/src/ntl.cpp#L156)
+    * ntl::shared_lock [(tested)](../test/driver/src/ntl.cpp#L179)
 
 ## Requirements
 
@@ -187,7 +206,7 @@ crtsys의 장점은 아래와 같습니다.
   * 14.26.28801
   * 14.29.30133
   * 14.31.31103
-* Windows Kit (SDK, WDK)
+* Windows Kits (SDK, WDK)
   * 10.0.17763.0
   * 10.0.18362.0
   * 10.0.22000.0
@@ -281,7 +300,7 @@ SDK와 WDK의 버전이 다르면 빌드가 실패할 가능성이 높으므로
         include(cmake/CPM.cmake)
 
         set(CRTSYS_NTL_MAIN ON) # use ntl::main
-        CPMAddPackage("gh:ntoskrnl7/[email protected].8")
+        CPMAddPackage("gh:ntoskrnl7/[email protected].9")
         include(${crtsys_SOURCE_DIR}/cmake/CrtSys.cmake)
 
         # add driver

include/.internal/version

@@ -26,6 +26,6 @@ Environment:
 
 #define CRTSYS_VERSION_MAJOR 0
 #define CRTSYS_VERSION_MINOR 1
-#define CRTSYS_VERSION_PATCH 8
+#define CRTSYS_VERSION_PATCH 9
 
 #endif // _CRTSYS_VERSION_

include/ntl/irql

@@ -0,0 +1,73 @@
+/**
+ * @file irql
+ * @author jungkwang.lee ([email protected])
+ * @brief KIRQL Helper features.
+ *
+ * @copyright Copyright (c) 2022 NT Template Library Authoers.
+ *
+ */
+
+#ifndef _NTDDK_
+#include <wdm.h>
+#endif
+
+namespace ntl {
+enum irql : KIRQL {
+  passive = PASSIVE_LEVEL,
+  low = passive,
+  apc = APC_LEVEL,
+  dispatch = DISPATCH_LEVEL,
+  dpc = dispatch,
+#if defined(_X86_) || defined(_AMD64_)
+  cmci = CMCI_LEVEL,
+#endif
+  clock = CLOCK_LEVEL,
+  ipi = IPI_LEVEL,
+  drs = DRS_LEVEL,
+  power = POWER_LEVEL,
+  profile = PROFILE_LEVEL,
+#if defined(_X86_)
+  clock1 = CLOCK1_LEVEL,
+  clock2 = CLOCK2_LEVEL,
+#endif
+  high = HIGH_LEVEL
+};
+
+struct to_dpc_level_t {
+  explicit to_dpc_level_t() = default;
+};
+
+struct to_synch_level_t {
+  explicit to_synch_level_t() = default;
+};
+
+_INLINE_VAR constexpr to_dpc_level_t to_dpc_level{};
+_INLINE_VAR constexpr to_synch_level_t to_synch_level{};
+
+class raised_irql {
+public:
+  raised_irql(to_dpc_level_t) : old_irql_(KeRaiseIrqlToDpcLevel()) {}
+  raised_irql(to_synch_level_t) : old_irql_(KeRaiseIrqlToSynchLevel()) {}
+  raised_irql(irql irql) { KeRaiseIrql(static_cast<KIRQL>(irql), &old_irql_); }
+
+  ~raised_irql() { KeLowerIrql(old_irql_); }
+
+  raised_irql(const raised_irql &) = delete;
+  raised_irql &operator=(const raised_irql &) = delete;
+
+  irql old() const { return static_cast<irql>(old_irql_); }
+
+private:
+  KIRQL old_irql_;
+};
+
+raised_irql raise_irql(KIRQL irql) {
+  return raised_irql{static_cast<ntl::irql>(irql)};
+}
+
+raised_irql raise_irql_to_dpc_level() { return raised_irql{to_dpc_level}; }
+
+raised_irql raise_irql_to_synch_level() { return raised_irql{to_synch_level}; }
+
+ntl::irql current_irql() { return static_cast<ntl::irql>(KeGetCurrentIrql()); }
+} // namespace ntl