PxxxxR0
Retrieval of Exception Information

1. Introduction

Inside a catch(...) block, we should have access to the type_info of what was thrown. Currently there is no portable way to get the type_info from a exception_ptr, and so if an object is thrown of intrinsic type or a non-polymorphic class type, and caught in a catch(...) block, the type of the exception object is unknown. It is also impossible to get the address of the exception object itself.

2. Motivation

2.1. catch(...)

A C++ program can link with a shared library which has incomplete or inaccurate documentation for the exceptions it throws, or the program may link at runtime using LoadLibrary or dlopen to link with a library which it knows very little about. Code in the main program may handle an exception thrown from within the shared library as follows:

#include <exception>  // exception, exception_ptr
#include <new>        // bad_alloc
#include <typeinfo>   // typeid, type_info

extern void SomeLibraryFunction(void) noexcept(false);

int main(void)
{
    try
    {
        SomeLibraryFunction();
    }
    catch(std::bad_alloc const&)
    {
        // Attempt safe shutdown when memory is depleted
    }
    catch(std::exception const &e)
    {
        std::type_info const &ti = typeid(e);
        // As 'std::exception' has a virtual destructor, it is
        // a polymorphic type, and so 'typeid' will give us the
        // RTTI of the derived class.
    }
    catch(...)
    {
        std::exception_ptr const p = std::current_exception();
        // We can get a pointer to the exception object, but
        // we have no idea of the type of what was thrown
    }
}

This proposal will allow us to access the type_info of the exception object inside a catch(...) block, as follows:

catch(...)
{
    std::type_info const &ti = std::exception_typeid();
}

And also to get the type_info from any exception_ptr, as follows:

void Func(std::exception_ptr const &p)
{
    std::type_info const &ti = std::exception_typeid(p);
    std::puts( ti.what() );
}

int main(void)
{
    std::exception_ptr p;

    try
    {
        throw std::runtime_error("resources depleted");
    }
    catch(...)
    {
        p = std::current_exception();
    }

    Func(p);
}

Once we have the type_info, we can perform checks on the name:

catch(...)
{
    std::type_info const &ti = std::exception_typeid();
    if ( std::strstr( ti.name(), "FieryShadow" ) ) return EXIT_FAILURE;
}

The name of the type will of course be mangled and therefore be different on different compilers, but if a class is named 'FieryShadow', then its mangled name will contain 'FieryShadow', hence the function std::strstr will work here. However, until a name mangling library is added to the standard library, code to distinguish specifically between type names (e.g. where one class is inside an anonymous namespace) will be platform-specific and non-portable.

2.2. Runtime plugins

A massive program such as 3D modelling software for a desktop computer may allow the installation of 3rd party plugins. These plugins come in the form of a dynamic shared library (e.g. '.dll' on Microsoft Windows, or '.so' on Apple macOS) which is loaded at runtime using LoadLibrary or dlopen, and the plugin must export a list of functions expected by the main program, e.g. Plugin_GetName() and Plugin_GetCategory(). One of these exported functions could be Plugin_GetExceptions() as follows:

   std::type_info const *const *Plugin_GetExceptions();
   

Plugin_GetExceptions() returns a pointer to a null-terminated array of pointers to the type_info's of bespoke exceptions thrown from the plugin. When the main program first loads the plugin, the main program populates a global array of these exception types, and the main program consults this array when an exception is caught:

catch(...)
{
    std::type_info const &ti = std::exception_typeid();
    if ( nullptr != plugin_exceptions.find(&ti) )
    {
        // We have caught one of the 'registered' exception types
    }
}

From here, the main program can perform tasks specific to the exception type, such as calling a specific handler function exported by the plugin:

catch(...)
{
    std::type_info const &ti = std::exception_typeid();
    if ( nullptr != plugin_exceptions.find(&ti) )
    {
        void (*const handler)(void*) = handlers[ std::type_index(ti) ];
        handler( std::exception_object() );
    }
}

2.3. As a stepping stone

There has been recent discussion about making major additions to std::type_info, for example to record the sizeof, alignof and std::is_polymorphic_v of the type. There is the hope that if this current proposal is accepted, it will be used as a stepping stone for future papers, for example to log unknown exceptions and give a hexdump of the exception object. For example we could get a print-out such as the following:

Type of exception object: 5Dummy
Size of exception object: 32
  Hex: 46726f6773313233000000000000000000000000000000000000000000000000
ASCII: Frogs123  

struct Dummy {
    char buf[32];
    Dummy(void) : buf("Frogs123") {}
};

try
{
    throw Dummy();
}
catch(...)
{
    using std::exception_object;
    using std::sizeof_type_info;

    std::type_info const &ti = std::exception_typeid();
    printf("Type of exception object: %s\n" , ti.name());

    if ( (0u==sizeof_type_info(ti)) || (-1==sizeof_type_info(ti)) ) return;
    printf("Size of exception object: %zu\n", sizeof_type_info(ti));

    char unsigned const *const p = static_cast<char unsigned*>(exception_object(p));
    printf("  Hex: ");
    for ( size_t i = 0u; i < sizeof_type_info(ti); ++i )
    {
        printf("%02x", static_cast(p[i]) );
    }
    printf("\nASCII: ");
    for ( size_t i = 0u; i < sizeof_type_info(ti); ++i )
    {
        char c = p[i];
        if ( !isprint(c) || isspace(c) ) c = ' ';
        putchar(c);
    }
    putchar('\n');
}

This would greatly aid in logging exceptions in both Debug and Release builds, even where C++ code is linked with another language such as Java or C#.

3. Impact on the standard

This proposal is a pure library extension. It does not require changes to the standard components. Four short paragraphs are to be appended to Section 17.9.7 [support.exception.propagation]. The text addition is 139 words, and the addition has no effect on any other part of the standard.

4. Impact on existing code

No existing code becomes ill-formed. The behaviour of all exisiting code is unaffected by this addition to the standard library.

5. Design considerations

5.1. Microsoft SEH

The Microsoft C++ compiler has two kinds of exception:

• C++ exceptions
• SEH exceptions

// Compile with Microsoft C++ compiler with option /EHa
#include <cstdio>      // std::puts, ::sprintf_s
#include <exception>   // exception
#include <eh.h>        // _set_se_translator, _EXCEPTION_POINTERS

class SEH_Exception : public std::exception {
private:
    unsigned const var_number;
    mutable char var_what[14u + 1u];  // +1 for null terminator
public:
    SEH_Exception(unsigned const arg) noexcept : var_number(arg) {}
    char const *what(void) const noexcept override
    {
        static_assert( 0xFFFFFFFF == (unsigned)-1, "unsigned int must be 32-Bit" );
        ::sprintf_s(this->var_what, "SEH 0x%08x", this->var_number);
        return this->var_what;
    }
    unsigned number(void) const noexcept { return var_number; }
};

void DivideByZero(void)     // Throws an SEH exception
{
    int volatile x, y = 0;
    x = 5 / y;              // division by zero throws 0xc0000094
}

void translator(unsigned const u, ::_EXCEPTION_POINTERS*)
{
    throw SEH_Exception(u);
}

int main(void)
{
    ::_set_se_translator( translator );

    try
    {
        DivideByZero();
    }
    catch(std::exception const &e)
    {
        std::puts( e.what() );
    }
}

5.2. Forced unwinding

The throwing of an exception results in unwinding of the stack, and so normally stack unwinding is accompanied by the presence of an exception object. There are circumstances however in which stack unwinding can take place without an accompanying exception object, and one such circumstance is a forced unwinding. An example of a forced unwinding is where the execution of a thread is abruptly stopped by the invocation of pthread_cancel, as follows:

#include <cstdio>            // puts
#include <exception>         // exception_ptr
#include <pthread.h>         // pthread_create
#include <unistd.h>          // sleep

void *Thread_Entry_Point(void*)
{
    try
    {
        for (; /* ever */ ;)
        {
            std::puts("*");
            ::sleep(1u);
        }
    }
    catch(...)
    {
        std::exception_ptr const p = std::current_exception();
        if ( false == static_cast<bool>(p) )
        {
            std::puts("exception_ptr is invalid - might be forced unwinding");
            throw;
        }
    }

    return nullptr;
}

int main(void)
{
    ::pthread_t h;
    ::pthread_create(&h, nullptr, Thread_Entry_Point, nullptr);
    ::sleep(3u);
    ::pthread_cancel(h);
    ::pthread_join(h, nullptr);
}

6. Possible implementations

6.1. Apple macOS, Linux, FreeBSD

#include <exception>   // exception_ptr, rethrow_exception
#include <memory>      // addressof
#include <typeinfo>    // type_info
#include <cxxabi.h>    // __cxa_current_exception_type

namespace std {
    type_info const &exception_typeid() noexcept
    {
        type_info const *const p = abi::__cxa_current_exception_type();
        if ( nullptr == p ) return typeid(void);
        return *p;
    }

    type_info const &exception_typeid(exception_ptr const &p) noexcept
    {
        if ( false == static_cast<bool>(p) ) return typeid(void);
        try { rethrow_exception(p); }
        catch(...) { return exception_typeid(); }
        return typeid(void);  // not needed - but belt and braces
    }

    void *exception_object(exception_ptr const &p) noexcept
    {
        if ( false == static_cast<bool>(p) ) return nullptr;
        return *(void**)addressof(p);
    }

    void *exception_object() noexcept
    {
        return exception_object( current_exception() );
    }
}

6.2. Microsoft Windows

#include <cstdint>       // uintptr_t
#include <exception>     // exception_ptr, rethrow_exception
#include <memory>        // addressof
#include <typeinfo>      // type_info

#include <Windows.h>     // AddVectoredExceptionHandler
#include <ehdata.h>      // ThrowInfo, CatchableType, EXCEPTION_POINTERS

thread_local std::type_info const *pti = &typeid(void);

namespace std {
    type_info const &exception_typeid() noexcept
    {
        return *pti;
    }

    type_info const &exception_typeid(exception_ptr const &p) noexcept
    {
        if ( false == static_cast<bool>(p) ) return typeid(void);
        try { rethrow_exception(p); }
        catch(...) { return exception_typeid(); }
        return typeid(void);  // not needed - but belt and braces
    }

    void *exception_object(exception_ptr const &p) noexcept
    {
        if ( false == static_cast<bool>(p) ) return nullptr;
        return *(void**)addressof(p);
    }

    void *exception_object() noexcept
    {
        return exception_object( current_exception() );
    }
}

namespace detail {

using std::type_info;

type_info const *VectoredExceptionHandler_Proper(EXCEPTION_POINTERS const *const arg)
{
    using std::uintptr_t;

    if ( nullptr == arg ) return nullptr;

    EXCEPTION_RECORD const *const pexc = arg->ExceptionRecord;

    if ( nullptr == pexc ) return nullptr;

    switch ( pexc->ExceptionCode )
    {
    case 0x40010006 /*EXCEPTION_OUTPUT_DEBUG_STRING*/:
    case 0x406D1388 /*EXCEPTION_THREAD_NAME        */:
        return nullptr;
    }

    if ( 0x19930520 /* magic number */ != pexc->ExceptionInformation[0] )
        return nullptr;

    if ( pexc->NumberParameters < 3u ) return nullptr;

    uintptr_t const module =   (pexc->NumberParameters >= 4u)
                             ? pexc->ExceptionInformation[3u]
                             : 0u;

    ThrowInfo const *const pthri =
        static_cast<ThrowInfo const*>(
            reinterpret_cast<void const*>(
                static_cast<uintptr_t>(pexc->ExceptionInformation[2u])));

    if ( nullptr == pthri ) return nullptr;

    if ( 0 == pthri->pCatchableTypeArray ) return nullptr;

    if ( 0u == (0xFFFFFFFFu & pthri->pCatchableTypeArray) ) return nullptr;

    _CatchableTypeArray const *const pcarr =
      static_cast<_CatchableTypeArray const *>(
        reinterpret_cast<void const*>(
          static_cast<uintptr_t>(module + (0xFFFFFFFFu & pthri->pCatchableTypeArray))));

    if ( 0u == ( 0xFFFFFFFFu &
        reinterpret_cast<uintptr_t>(pcarr->arrayOfCatchableTypes[0u])  )  )
           return nullptr;

    CatchableType const *const pct =
      static_cast<CatchableType const*>(
        reinterpret_cast<void const*>(
          static_cast<uintptr_t>(module +
            (0xFFFFFFFFu & reinterpret_cast<uintptr_t>(
              pcarr->arrayOfCatchableTypes[0u])))));

    if ( 0u == (0xFFFFFFFFu & pct->pType) ) return nullptr;

    return static_cast<type_info const *>(
             reinterpret_cast<void const*>(
               static_cast<uintptr_t>(module + (0xFFFFFFFFu & pct->pType))));
}

long WINAPI VectoredExceptionHandler(EXCEPTION_POINTERS *const pointers)
{
    type_info const *const retval = VectoredExceptionHandler_Proper(pointers);

    if ( nullptr == retval ) pti = &typeid(void);
                        else pti = retval;

    return EXCEPTION_CONTINUE_SEARCH;
}

// The next line ensures that 'AddVectoredExceptionHandler' is called before 'main'
void *const dummy = ::AddVectoredExceptionHandler(1u, VectoredExceptionHandler);

} // close namespace 'detail'

7. Proposed wording

The proposed wording is relative to [N4950].

In section 17.9.7 [support.exception.propagation], append:

13   type_info const &exception_typeid() noexcept;
     Returns: A reference to a ‘type_info’ (17.7.3) object for the currently
              handled exception, or ‘typeid(void)’ (7.6.1.8) if the currently
              handled exception is lacking ‘type_info’.

14   type_info const &exception_typeid(exception_ptr const &p) noexcept;
     Returns: A reference to a ‘type_info’ (17.7.3) object for the exception
              object referred by ‘p’ (17.9.7.1), or ‘typeid(void)’ (7.6.1.8)
              if ‘p’ is a null pointer, or ‘typeid(void)’ if the exception
              is lacking ‘type_info’.

15   void *exception_object() noexcept;
     Returns: The address of the exception object for the currently handled
              exception, or a null pointer if the exception is lacking an
              exception object.

16   void *exception_object(exception_ptr const &p) noexcept;
     Returns: The address of the exception object for the exception referred
              by ‘p’ (17.9.7.1), or a null pointer if ‘p’ is a null pointer,
              or a null pointer if the exception is lacking an exception object.

8. Alternatives

8.1. std::exception_ptr::type()

It has been suggested that std::exception_ptr should be given member functions, and that it should be defined in the standard as follows:

class exception_ptr {
public:
    type_info const &type() const noexcept;
    void *object() const noexcept;
};

typedef shared_ptr<void> exception_ptr;

class ExceptionHandle : public std::exception_ptr {
public:
    virtual void output(std::ostream&) const;
};

9. Acknowledgements

For their feedback and contributions on the mailing list std-proposals@lists.isocpp.org:
Tom Honermann, Thiago Macieira, Jens Maurer, Jason McKesson, Arthur O'Dwyer, Peter Olsson, Jan Schultke, Lénárd Szolnoki, Matthew Taylor, Ville Voutilainen, Sebastian Wittmeier and the late Edward Catmur (1982-2024).