Embed.cmake 7.15 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
#####################################################################################
# The MIT License (MIT)
#
# Copyright (c) 2015-2022 Advanced Micro Devices, Inc. All rights reserved.
#
# 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.
#####################################################################################
Paul Fultz II's avatar
Paul Fultz II committed
24
25
26
find_program(EMBED_LD ld)
find_program(EMBED_OBJCOPY objcopy)

27
option(EMBED_USE_LD "Use ld to embed data files" OFF)
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

function(wrap_string)
    set(options)
    set(oneValueArgs VARIABLE AT_COLUMN)
    set(multiValueArgs)
    cmake_parse_arguments(PARSE "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN})

    string(LENGTH ${${PARSE_VARIABLE}} string_length)
    math(EXPR offset "0")

    while(string_length GREATER 0)

        if(string_length GREATER ${PARSE_AT_COLUMN})
            math(EXPR length "${PARSE_AT_COLUMN}")
        else()
            math(EXPR length "${string_length}")
        endif()

        string(SUBSTRING ${${PARSE_VARIABLE}} ${offset} ${length} line)
        set(lines "${lines}\n${line}")

        math(EXPR string_length "${string_length} - ${length}")
        math(EXPR offset "${offset} + ${length}")
    endwhile()

    set(${PARSE_VARIABLE} "${lines}" PARENT_SCOPE)
endfunction()

56
function(generate_embed_source EMBED_NAME SRC_FILE HEADER_FILE BASE_DIRECTORY)
Paul Fultz II's avatar
Paul Fultz II committed
57
    set(options)
58
59
    set(oneValueArgs "")
    set(multiValueArgs SYMBOLS FILES)
Paul Fultz II's avatar
Paul Fultz II committed
60
61
    cmake_parse_arguments(PARSE "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN})

62
    foreach(SYMBOL FILE IN ZIP_LISTS PARSE_SYMBOLS PARSE_FILES)
Paul Fultz II's avatar
Paul Fultz II committed
63
        set(START_SYMBOL "_binary_${SYMBOL}_start")
64
        set(LENGTH_SYMBOL "_binary_${SYMBOL}_length")
65
66
        if(EMBED_USE_LD)
            string(APPEND EXTERNS "
67
68
69
extern const char ${START_SYMBOL}[];
extern const size_t _binary_${SYMBOL}_size;
const auto ${LENGTH_SYMBOL} = reinterpret_cast<size_t>(&_binary_${SYMBOL}_size);
70
71
72
            ")
        else()
            string(APPEND EXTERNS "
73
74
extern const char ${START_SYMBOL}[];
extern const size_t ${LENGTH_SYMBOL};
75
76
            ")
        endif()
77
        cmake_path(RELATIVE_PATH FILE BASE_DIRECTORY ${BASE_DIRECTORY} OUTPUT_VARIABLE BASE_NAME)
Paul Fultz II's avatar
Paul Fultz II committed
78
        string(APPEND INIT_KERNELS "
79
            { \"${BASE_NAME}\", { ${START_SYMBOL}, ${LENGTH_SYMBOL}} },")
Paul Fultz II's avatar
Paul Fultz II committed
80
81
    endforeach()

82
    file(WRITE "${HEADER_FILE}" "
83
#include <string_view>
84
85
86
#include <unordered_map>
#include <utility>
std::unordered_map<std::string_view, std::string_view> ${EMBED_NAME}();
Paul Fultz II's avatar
Paul Fultz II committed
87
88
")

89
    file(WRITE "${SRC_FILE}" "
Paul Fultz II's avatar
Paul Fultz II committed
90
91
#include <${EMBED_NAME}.hpp>
${EXTERNS}
92
std::unordered_map<std::string_view, std::string_view> ${EMBED_NAME}()
Paul Fultz II's avatar
Paul Fultz II committed
93
{
94
    static std::unordered_map<std::string_view, std::string_view> result = {${INIT_KERNELS}};
Paul Fultz II's avatar
Paul Fultz II committed
95
96
97
98
99
    return result;
}
")
endfunction()

100
function(embed_file FILE BASE_DIRECTORY)
101
    message(STATUS "    ${FILE}")
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
    cmake_path(RELATIVE_PATH FILE BASE_DIRECTORY ${BASE_DIRECTORY} OUTPUT_VARIABLE REL_FILE)
    string(MAKE_C_IDENTIFIER "${REL_FILE}" OUTPUT_SYMBOL)
    get_filename_component(OUTPUT_FILE_DIR "${REL_FILE}" DIRECTORY)
    file(MAKE_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}/${OUTPUT_FILE_DIR}")
    if(EMBED_USE_LD)
        set(OUTPUT_FILE "${CMAKE_CURRENT_BINARY_DIR}/${REL_FILE}.o")
        add_custom_command(
            OUTPUT ${OUTPUT_FILE}
            COMMAND ${EMBED_LD} -r -o "${OUTPUT_FILE}" -z noexecstack --format=binary "${REL_FILE}"
            COMMAND ${EMBED_OBJCOPY} --rename-section .data=.rodata,alloc,load,readonly,data,contents "${OUTPUT_FILE}"
            WORKING_DIRECTORY ${BASE_DIRECTORY}
            DEPENDS ${FILE}
            VERBATIM)
    else()
        set(OUTPUT_FILE "${CMAKE_CURRENT_BINARY_DIR}/${REL_FILE}.cpp")
        # reads source file contents as hex string
        file(READ ${FILE} HEX_STRING HEX)
        # wraps the hex string into multiple lines
        wrap_string(VARIABLE HEX_STRING AT_COLUMN 80)
        # adds '0x' prefix and comma suffix before and after every byte respectively
        string(REGEX REPLACE "([0-9a-f][0-9a-f])" "0x\\1, " ARRAY_VALUES ${HEX_STRING})
        # removes trailing comma
        string(REGEX REPLACE ", $" "" ARRAY_VALUES ${ARRAY_VALUES})
        file(WRITE "${OUTPUT_FILE}" "
#include <cstddef>
extern const char _binary_${OUTPUT_SYMBOL}_start[] = { ${ARRAY_VALUES} };
128
                extern const char* _binary_${SYMBOL}_end = _binary_${SYMBOL}_start + sizeof(_binary_${SYMBOL}_start);
129
130
131
132
133
")
    endif()
    set(OUTPUT_FILE ${OUTPUT_FILE} PARENT_SCOPE)
    set(OUTPUT_SYMBOL ${OUTPUT_SYMBOL} PARENT_SCOPE)
endfunction()
Paul Fultz II's avatar
Paul Fultz II committed
134
135

function(add_embed_library EMBED_NAME)
136
    set(options)
137
    set(oneValueArgs BASE_DIRECTORY)
138
139
    set(multiValueArgs)
    cmake_parse_arguments(PARSE "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN})
Paul Fultz II's avatar
Paul Fultz II committed
140
    set(EMBED_DIR ${CMAKE_CURRENT_BINARY_DIR}/embed/${EMBED_NAME})
141
    file(MAKE_DIRECTORY ${EMBED_DIR})
Paul Fultz II's avatar
Paul Fultz II committed
142
143
    set(SRC_FILE "${EMBED_DIR}/${EMBED_NAME}.cpp")
    set(HEADER_FILE "${EMBED_DIR}/include/${EMBED_NAME}.hpp")
144
    message(STATUS "Embedding kernel files:")
145
    foreach(FILE ${PARSE_UNPARSED_ARGUMENTS})
146
        embed_file(${FILE} ${PARSE_BASE_DIRECTORY})
Paul Fultz II's avatar
Paul Fultz II committed
147
148
149
        list(APPEND OUTPUT_FILES ${OUTPUT_FILE})
        list(APPEND SYMBOLS ${OUTPUT_SYMBOL})
    endforeach()
150
    message(STATUS "Generating embedding library '${EMBED_NAME}'")
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
    generate_embed_source(${EMBED_NAME} ${SRC_FILE} ${HEADER_FILE} "${PARSE_BASE_DIRECTORY}" SYMBOLS ${SYMBOLS} FILES ${PARSE_UNPARSED_ARGUMENTS})
    add_library(embed_lib_${EMBED_NAME} OBJECT ${SRC_FILE} ${HEADER_FILE})
    if(NOT EMBED_USE_LD)
        target_sources(embed_lib_${EMBED_NAME} PRIVATE ${OUTPUT_FILES})
    endif()
    target_include_directories(embed_lib_${EMBED_NAME} PUBLIC ${EMBED_DIR}/include)
    target_compile_options(embed_lib_${EMBED_NAME} PRIVATE
            -Wno-reserved-identifier -Wno-extern-initializer -Wno-missing-variable-declarations)
    set_target_properties(embed_lib_${EMBED_NAME} PROPERTIES POSITION_INDEPENDENT_CODE ON)
    add_library(${EMBED_NAME} INTERFACE $<TARGET_OBJECTS:embed_lib_${EMBED_NAME}> ${OUTPUT_FILES})
    target_link_libraries(${EMBED_NAME} INTERFACE $<TARGET_OBJECTS:embed_lib_${EMBED_NAME}>)
    if(EMBED_USE_LD)
        target_link_libraries(${EMBED_NAME} INTERFACE ${OUTPUT_FILES})
    endif()
    target_include_directories(${EMBED_NAME} INTERFACE ${EMBED_DIR}/include)
Paul Fultz II's avatar
Paul Fultz II committed
166
endfunction()