shadow-stack.hh

Go to the documentation of this file.

/*
 
MIT License
 
Copyright (c) 2026 PCSX-Redux authors
 
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
 
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
 
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
 
*/
 
#pragma once
 
#include <stdint.h>
 
namespace psyqo {
 
class ShadowStack {
  public:
    static constexpr unsigned c_capacity = 64;
 
    struct Context {
        uint32_t depth = 0;
        uintptr_t entries[c_capacity] = {};
    };
 
#ifdef PSYQO_SHADOW_STACK
    static constexpr bool enabled = true;
 
    [[gnu::no_instrument_function]] static unsigned depth();
 
    [[gnu::no_instrument_function]] static uintptr_t entry(unsigned index);
 
    [[gnu::no_instrument_function]] static unsigned copy(uintptr_t* out, unsigned max);
 
    [[gnu::no_instrument_function]] static Context* switchTo(Context* context);
#else
    static constexpr bool enabled = false;
    static constexpr unsigned depth() { return 0; }
    static constexpr uintptr_t entry(unsigned) { return 0; }
    static constexpr unsigned copy(uintptr_t*, unsigned) { return 0; }
    static constexpr Context* switchTo(Context*) { return nullptr; }
#endif
};
 
}  // namespace psyqo