experimental/status-code/nt_code.hpp

0001 /* Proposed SG14 status_code
0002 (C) 2018-2024 Niall Douglas <http://www.nedproductions.biz/> (5 commits)
0003 File Created: Feb 2018
0004
0005
0006 Boost Software License - Version 1.0 - August 17th, 2003
0007
0008 Permission is hereby granted, free of charge, to any person or organization
0009 obtaining a copy of the software and accompanying documentation covered by
0010 this license (the "Software") to use, reproduce, display, distribute,
0011 execute, and transmit the Software, and to prepare derivative works of the
0012 Software, and to permit third-parties to whom the Software is furnished to
0013 do so, all subject to the following:
0014
0015 The copyright notices in the Software and this entire statement, including
0016 the above license grant, this restriction and the following disclaimer,
0017 must be included in all copies of the Software, in whole or in part, and
0018 all derivative works of the Software, unless such copies or derivative
0019 works are solely in the form of machine-executable object code generated by
0020 a source language processor.
0021
0022 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
0023 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
0024 FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
0025 SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
0026 FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
0027 ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
0028 DEALINGS IN THE SOFTWARE.
0029 */
0030
0031 #ifndef BOOST_OUTCOME_SYSTEM_ERROR2_NT_CODE_HPP
0032 #define BOOST_OUTCOME_SYSTEM_ERROR2_NT_CODE_HPP
0033
0034 #if !defined(_WIN32) && !defined(BOOST_OUTCOME_STANDARDESE_IS_IN_THE_HOUSE)
0035 #error This file should only be included on Windows
0036 #endif
0037
0038 #include "win32_code.hpp"
0039
0040 BOOST_OUTCOME_SYSTEM_ERROR2_NAMESPACE_BEGIN
0041
0042 //! \exclude
0043 namespace win32
0044 {
0045 #ifdef __MINGW32__
0046   extern "C"
0047   {
0048 #endif
0049     // A Win32 NTSTATUS
0050     using NTSTATUS = long;
0051     // A Win32 HMODULE
0052     using HMODULE = void *;
0053     // Used to retrieve where the NTDLL DLL is mapped into memory
0054     extern HMODULE __stdcall GetModuleHandleW(const wchar_t *lpModuleName);
0055 #ifdef __MINGW32__
0056   }
0057 #else
0058 #pragma comment(lib, "kernel32.lib")
0059 #if(defined(__x86_64__) || defined(_M_X64)) || (defined(__aarch64__) || defined(_M_ARM64))
0060 #pragma comment(linker, "/alternatename:?GetModuleHandleW@win32@system_error2@@YAPEAXPEB_W@Z=GetModuleHandleW")
0061 #elif defined(__x86__) || defined(_M_IX86) || defined(__i386__)
0062 #pragma comment(linker, "/alternatename:?GetModuleHandleW@win32@system_error2@@YGPAXPB_W@Z=_GetModuleHandleW@4")
0063 #elif defined(__arm__) || defined(_M_ARM)
0064 #pragma comment(linker, "/alternatename:?GetModuleHandleW@win32@system_error2@@YAPAXPB_W@Z=GetModuleHandleW")
0065 #else
0066 #error Unknown architecture
0067 #endif
0068 #endif
0069 }  // namespace win32
0070
0071 class _nt_code_domain;
0072 //! (Windows only) A NT error code, those returned by NT kernel functions.
0073 using nt_code = status_code<_nt_code_domain>;
0074 //! (Windows only) A specialisation of `status_error` for the NT error code domain.
0075 using nt_error = status_error<_nt_code_domain>;
0076
0077 /*! (Windows only) The implementation of the domain for NT error codes, those returned by NT kernel functions.
0078  */
0079 class _nt_code_domain : public status_code_domain
0080 {
0081   template <class DomainType> friend class status_code;
0082   friend class _com_code_domain;
0083   using _base = status_code_domain;
0084   static int _nt_code_to_errno(win32::NTSTATUS c)
0085   {
0086     if(c >= 0)
0087     {
0088       return 0;  // success
0089     }
0090     switch(static_cast<unsigned>(c))
0091     {
0092 #include "detail/nt_code_to_generic_code.ipp"
0093     }
0094     return -1;
0095   }
0096   static win32::DWORD _nt_code_to_win32_code(win32::NTSTATUS c)  // NOLINT
0097   {
0098     if(c >= 0)
0099     {
0100       return 0;  // success
0101     }
0102     switch(static_cast<unsigned>(c))
0103     {
0104 #include "detail/nt_code_to_win32_code.ipp"
0105     }
0106     return static_cast<win32::DWORD>(-1);
0107   }
0108   //! Construct from a NT error code
0109   static _base::string_ref _make_string_ref(win32::NTSTATUS c) noexcept
0110   {
0111     wchar_t buffer[32768];
0112     static win32::HMODULE ntdll = win32::GetModuleHandleW(L"NTDLL.DLL");
0113     win32::DWORD wlen =
0114     win32::FormatMessageW(0x00000800 /*FORMAT_MESSAGE_FROM_HMODULE*/ | 0x00001000 /*FORMAT_MESSAGE_FROM_SYSTEM*/ | 0x00000200 /*FORMAT_MESSAGE_IGNORE_INSERTS*/,
0115                           ntdll, c, (1 << 10) /*MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT)*/, buffer, 32768, nullptr);
0116     size_t allocation = wlen + (wlen >> 1);
0117     win32::DWORD bytes;
0118     if(wlen == 0)
0119     {
0120       return _base::string_ref("failed to get message from system");
0121     }
0122     for(;;)
0123     {
0124       auto *p = static_cast<char *>(malloc(allocation));  // NOLINT
0125       if(p == nullptr)
0126       {
0127         return _base::string_ref("failed to get message from system");
0128       }
0129       bytes = win32::WideCharToMultiByte(65001 /*CP_UTF8*/, 0, buffer, (int) (wlen + 1), p, (int) allocation, nullptr, nullptr);
0130       if(bytes != 0)
0131       {
0132         char *end = strchr(p, 0);
0133         while(end[-1] == 10 || end[-1] == 13)
0134         {
0135           --end;
0136         }
0137         *end = 0;  // NOLINT
0138         return _base::atomic_refcounted_string_ref(p, end - p);
0139       }
0140       free(p);  // NOLINT
0141       if(win32::GetLastError() == 0x7a /*ERROR_INSUFFICIENT_BUFFER*/)
0142       {
0143         allocation += allocation >> 2;
0144         continue;
0145       }
0146       return _base::string_ref("failed to get message from system");
0147     }
0148   }
0149
0150 public:
0151   //! The value type of the NT code, which is a `win32::NTSTATUS`
0152   using value_type = win32::NTSTATUS;
0153   using _base::string_ref;
0154
0155 public:
0156   //! Default constructor
0157   constexpr explicit _nt_code_domain(typename _base::unique_id_type id = 0x93f3b4487e4af25b) noexcept
0158       : _base(id)
0159   {
0160   }
0161   _nt_code_domain(const _nt_code_domain &) = default;
0162   _nt_code_domain(_nt_code_domain &&) = default;
0163   _nt_code_domain &operator=(const _nt_code_domain &) = default;
0164   _nt_code_domain &operator=(_nt_code_domain &&) = default;
0165   ~_nt_code_domain() = default;
0166
0167   //! Constexpr singleton getter. Returns the constexpr nt_code_domain variable.
0168   static inline constexpr const _nt_code_domain &get();
0169
0170   virtual string_ref name() const noexcept override { return string_ref("NT domain"); }  // NOLINT
0171
0172   virtual payload_info_t payload_info() const noexcept override
0173   {
0174     return {sizeof(value_type), sizeof(status_code_domain *) + sizeof(value_type),
0175             (alignof(value_type) > alignof(status_code_domain *)) ? alignof(value_type) : alignof(status_code_domain *)};
0176   }
0177
0178 protected:
0179   virtual bool _do_failure(const status_code<void> &code) const noexcept override  // NOLINT
0180   {
0181     assert(code.domain() == *this);
0182     return static_cast<const nt_code &>(code).value() < 0;  // NOLINT
0183   }
0184   virtual bool _do_equivalent(const status_code<void> &code1, const status_code<void> &code2) const noexcept override  // NOLINT
0185   {
0186     assert(code1.domain() == *this);
0187     const auto &c1 = static_cast<const nt_code &>(code1);  // NOLINT
0188     if(code2.domain() == *this)
0189     {
0190       const auto &c2 = static_cast<const nt_code &>(code2);  // NOLINT
0191       return c1.value() == c2.value();
0192     }
0193     if(code2.domain() == generic_code_domain)
0194     {
0195       const auto &c2 = static_cast<const generic_code &>(code2);  // NOLINT
0196       if(static_cast<int>(c2.value()) == _nt_code_to_errno(c1.value()))
0197       {
0198         return true;
0199       }
0200     }
0201     if(code2.domain() == win32_code_domain)
0202     {
0203       const auto &c2 = static_cast<const win32_code &>(code2);  // NOLINT
0204       if(c2.value() == _nt_code_to_win32_code(c1.value()))
0205       {
0206         return true;
0207       }
0208     }
0209     return false;
0210   }
0211   virtual generic_code _generic_code(const status_code<void> &code) const noexcept override  // NOLINT
0212   {
0213     assert(code.domain() == *this);
0214     const auto &c = static_cast<const nt_code &>(code);  // NOLINT
0215     return generic_code(static_cast<errc>(_nt_code_to_errno(c.value())));
0216   }
0217   virtual string_ref _do_message(const status_code<void> &code) const noexcept override  // NOLINT
0218   {
0219     assert(code.domain() == *this);
0220     const auto &c = static_cast<const nt_code &>(code);  // NOLINT
0221     return _make_string_ref(c.value());
0222   }
0223 #if defined(_CPPUNWIND) || defined(__EXCEPTIONS) || defined(BOOST_OUTCOME_STANDARDESE_IS_IN_THE_HOUSE)
0224   BOOST_OUTCOME_SYSTEM_ERROR2_NORETURN virtual void _do_throw_exception(const status_code<void> &code) const override  // NOLINT
0225   {
0226     assert(code.domain() == *this);
0227     const auto &c = static_cast<const nt_code &>(code);  // NOLINT
0228     throw status_error<_nt_code_domain>(c);
0229   }
0230 #endif
0231 };
0232 //! (Windows only) A constexpr source variable for the NT code domain, which is that of NT kernel functions. Returned by `_nt_code_domain::get()`.
0233 constexpr _nt_code_domain nt_code_domain;
0234 inline constexpr const _nt_code_domain &_nt_code_domain::get()
0235 {
0236   return nt_code_domain;
0237 }
0238
0239 BOOST_OUTCOME_SYSTEM_ERROR2_NAMESPACE_END
0240
0241 #endif