clues::ErrnoResult Class Reference

An errno system call result. More...

#include <ErrnoResult.hxx>

Public Member Functions
	ErrnoResult (const cosmos::Errno code)
std::string	str () const
std::optional< cosmos::Errno >	errorCode () const
std::optional< KernelErrno >	kernelErrorCode () const
bool	hasErrorCode () const
bool	hasKernelErrorCode () const

Protected Attributes
std::optional< cosmos::Errno >	m_errno
std::optional< KernelErrno >	m_kernel_errno

Detailed Description

An errno system call result.

When a system call fails then the kernel provides a dedicated errno result via PTRACE_GET_SYSCALL_INFO. This type wraps the information provided by the kernel.

During tracing error codes can appear that aren't usually visible in user space. These are modeled via the dedicated KernelErrno type. For this reason only std::optional returns are provided.

Definition at line 24 of file ErrnoResult.hxx.

Constructor & Destructor Documentation

ErrnoResult()

clues::ErrnoResult::ErrnoResult ( const cosmos::Errno code )

explicit

Definition at line 11 of file ErrnoResult.cxx.

                                               {
        const auto kernel_code = KernelErrno{cosmos::to_integral(code)};
 
        if (kernel_code >= KernelErrno::RESTART_SYS &&
                        kernel_code <= KernelErrno::RESTART_RESTARTBLOCK) {
                m_kernel_errno = kernel_code;
        } else {
                m_errno = code;
        }
}

Member Function Documentation

errorCode()

std::optional< cosmos::Errno > clues::ErrnoResult::errorCode ( ) const

inline

Definition at line 31 of file ErrnoResult.hxx.

                                                   {
                return m_errno;
        }

hasErrorCode()

bool clues::ErrnoResult::hasErrorCode ( ) const

inline

Definition at line 39 of file ErrnoResult.hxx.

                                  {
                return m_errno != std::nullopt;
        }

hasKernelErrorCode()

bool clues::ErrnoResult::hasKernelErrorCode ( ) const

inline

Definition at line 43 of file ErrnoResult.hxx.

                                        {
                return m_kernel_errno != std::nullopt;
        }

kernelErrorCode()

std::optional< KernelErrno > clues::ErrnoResult::kernelErrorCode ( ) const

inline

Definition at line 35 of file ErrnoResult.hxx.

                                                         {
                return m_kernel_errno;
        }

str()

std::string clues::ErrnoResult::str

(

)

const

Definition at line 22 of file ErrnoResult.cxx.

                                 {
 
        if (m_errno) {
                const auto code = *m_errno;
                return cosmos::sprintf("%d (%s)",
                                cosmos::to_integral(code), get_errno_label(code));
        } else {
                const auto code = *m_kernel_errno;
                return cosmos::sprintf("%d (%s)",
                                cosmos::to_integral(code), get_kernel_errno_label(code));
        }
}

Member Data Documentation

m_errno

std::optional<cosmos::Errno> clues::ErrnoResult::m_errno

protected

Definition at line 49 of file ErrnoResult.hxx.

m_kernel_errno

std::optional<KernelErrno> clues::ErrnoResult::m_kernel_errno

protected

Definition at line 50 of file ErrnoResult.hxx.

---

The documentation for this class was generated from the following files:

• include/ErrnoResult.hxx
• src/ErrnoResult.cxx