ARMeilleure/CodeGen/CompiledFunction.cs


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56

using ARMeilleure.CodeGen.Linking;
using ARMeilleure.CodeGen.Unwinding;
using ARMeilleure.Translation.Cache;
using System;
using System.Runtime.InteropServices;

namespace ARMeilleure.CodeGen
{
    /// <summary>
    /// Represents a compiled function.
    /// </summary>
    readonly struct CompiledFunction
    {
        /// <summary>
        /// Gets the machine code of the <see cref="CompiledFunction"/>.
        /// </summary>
        public byte[] Code { get; }

        /// <summary>
        /// Gets the <see cref="Unwinding.UnwindInfo"/> of the <see cref="CompiledFunction"/>.
        /// </summary>
        public UnwindInfo UnwindInfo { get; }

        /// <summary>
        /// Gets the <see cref="Linking.RelocInfo"/> of the <see cref="CompiledFunction"/>.
        /// </summary>
        public RelocInfo RelocInfo { get; }

        /// <summary>
        /// Initializes a new instance of the <see cref="CompiledFunction"/> struct with the specified machine code,
        /// unwind info and relocation info.
        /// </summary>
        /// <param name="code">Machine code</param>
        /// <param name="unwindInfo">Unwind info</param>
        /// <param name="relocInfo">Relocation info</param>
        internal CompiledFunction(byte[] code, UnwindInfo unwindInfo, RelocInfo relocInfo)
        {
            Code       = code;
            UnwindInfo = unwindInfo;
            RelocInfo  = relocInfo;
        }

        /// <summary>
        /// Maps the <see cref="CompiledFunction"/> onto the <see cref="JitCache"/> and returns a delegate of type
        /// <typeparamref name="T"/> pointing to the mapped function.
        /// </summary>
        /// <typeparam name="T">Type of delegate</typeparam>
        /// <returns>A delegate of type <typeparamref name="T"/> pointing to the mapped function</returns>
        public T Map<T>()
        {
            IntPtr codePtr = JitCache.Map(this);

            return Marshal.GetDelegateForFunctionPointer<T>(codePtr);
        }
    }
}