Atmosphere/libraries/libmesosphere/include/mesosphere/init/kern_init_elf64.hpp

/*
 * Copyright (c) Atmosphère-NX
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms and conditions of the GNU General Public License,
 * version 2, as published by the Free Software Foundation.
 *
 * This program is distributed in the hope it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
 * more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
/*
From musl include/elf.h

Copyright © 2005-2014 Rich Felker, et al.

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 <vapours.hpp>

namespace ams::kern::init::Elf::Elf64 {

    /* Type declarations required to perform relocations */
    using Half   = u16;
    using Word   = u32;
    using Sword  = s32;
    using Xword  = u64;
    using SXword = s64;

    using Addr = u64;
    using Off  = u64;

    class Dyn {
        private:
            SXword m_tag;
            union {
                Xword m_value;
                Addr m_ptr;
            };
        public:
            constexpr ALWAYS_INLINE SXword GetTag() const {
                return m_tag;
            }

            constexpr ALWAYS_INLINE Xword GetValue() const {
                return m_value;
            }

            constexpr ALWAYS_INLINE Addr GetPtr() const {
                return m_ptr;
            }
    };

    class Rel {
        private:
            Addr m_offset;
            Xword m_info;
        public:
            constexpr ALWAYS_INLINE Addr GetOffset() const {
                return m_offset;
            }

            constexpr ALWAYS_INLINE Xword GetSym() const {
                return m_info >> 32;
            }

            constexpr ALWAYS_INLINE Xword GetType() const {
                return m_info & 0xFFFFFFFF;
            }
    };

    class Rela {
        private:
            Addr m_offset;
            Xword m_info;
            SXword m_addend;
        public:
            constexpr ALWAYS_INLINE Addr GetOffset() const {
                return m_offset;
            }

            constexpr ALWAYS_INLINE Xword GetSym() const {
                return m_info >> 32;
            }

            constexpr ALWAYS_INLINE Xword GetType() const {
                return m_info & 0xFFFFFFFF;
            }

            constexpr ALWAYS_INLINE SXword GetAddend() const {
                return m_addend;
            }
    };

    class Relr {
        private:
            Xword m_info;
        public:
            constexpr ALWAYS_INLINE bool IsLocation() const {
                return (m_info & 1) == 0;
            }

            constexpr ALWAYS_INLINE Xword GetLocation() const {
                return m_info;
            }

            constexpr ALWAYS_INLINE Xword GetBitmap() const {
                return m_info >> 1;
            }
    };

    enum DynamicTag {
        DT_NULL    = 0,
        DT_RELA    = 7,
        DT_RELAENT = 9,
        DT_REL     = 17,
        DT_RELENT  = 19,

        DT_RELRSZ  = 35,
        DT_RELR    = 36,
        DT_RELRENT = 37,

        DT_RELACOUNT = 0x6ffffff9,
        DT_RELCOUNT  = 0x6ffffffa
    };

}