compile_hip.cpp 10.9 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
#include <migraphx/gpu/compile_hip.hpp>
#include <migraphx/errors.hpp>
26
#include <migraphx/stringutils.hpp>
Shucai Xiao's avatar
Shucai Xiao committed
27
#include <migraphx/ranges.hpp>
28
#include <migraphx/env.hpp>
Paul Fultz II's avatar
Paul Fultz II committed
29
#include <cassert>
30
31
#include <iostream>

Umang Yadav's avatar
Umang Yadav committed
32
#ifdef MIGRAPHX_USE_HIPRTC
33
34
#include <hip/hiprtc.h>
#include <migraphx/manage_ptr.hpp>
35
36
37
38
39
40
41
#include <migraphx/value.hpp>
#include <migraphx/tmp_dir.hpp>
#include <migraphx/dynamic_loader.hpp>
#include <migraphx/process.hpp>
#include <migraphx/msgpack.hpp>
#include <migraphx/serialize.hpp>
#include <migraphx/file_buffer.hpp>
42
43
44
45
#else
#include <migraphx/compile_src.hpp>
#include <migraphx/process.hpp>
#endif
Paul Fultz II's avatar
Paul Fultz II committed
46
47
48
49
50

namespace migraphx {
inline namespace MIGRAPHX_INLINE_NS {
namespace gpu {

51
MIGRAPHX_DECLARE_ENV_VAR(MIGRAPHX_GPU_DEBUG);
52
MIGRAPHX_DECLARE_ENV_VAR(MIGRAPHX_GPU_DEBUG_SYM);
53
MIGRAPHX_DECLARE_ENV_VAR(MIGRAPHX_GPU_OPTIMIZE);
54
MIGRAPHX_DECLARE_ENV_VAR(MIGRAPHX_GPU_DUMP_ASM);
55
MIGRAPHX_DECLARE_ENV_VAR(MIGRAPHX_GPU_DUMP_SRC);
56

Umang Yadav's avatar
Umang Yadav committed
57
#ifdef MIGRAPHX_USE_HIPRTC
58

Umang Yadav's avatar
Umang Yadav committed
59
60
MIGRAPHX_DECLARE_ENV_VAR(MIGRAPHX_TRACE_HIPRTC);
MIGRAPHX_DECLARE_ENV_VAR(MIGRAPHX_ENABLE_HIPRTC_WORKAROUNDS);
61
62
63
64
65
66
67
68
69
70
71
72

std::string hiprtc_error(hiprtcResult err, const std::string& msg)
{
    return "hiprtc: " + (hiprtcGetErrorString(err) + (": " + msg));
}

void hiprtc_check_error(hiprtcResult err, const std::string& msg, const std::string& ctx)
{
    if(err != HIPRTC_SUCCESS)
        throw make_exception(ctx, hiprtc_error(err, msg));
}

73
// NOLINTNEXTLINE
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
#define MIGRAPHX_HIPRTC(...) \
    hiprtc_check_error(__VA_ARGS__, #__VA_ARGS__, MIGRAPHX_MAKE_SOURCE_CTX())

#define MIGRAPHX_HIPRTC_THROW(error, msg) MIGRAPHX_THROW(hiprtc_error(error, msg))

// Workaround hiprtc's broken API
void hiprtc_program_destroy(hiprtcProgram prog) { hiprtcDestroyProgram(&prog); }
using hiprtc_program_ptr = MIGRAPHX_MANAGE_PTR(hiprtcProgram, hiprtc_program_destroy);

template <class... Ts>
hiprtc_program_ptr hiprtc_program_create(Ts... xs)
{
    hiprtcProgram prog = nullptr;
    auto result        = hiprtcCreateProgram(&prog, xs...);
    hiprtc_program_ptr p{prog};
    if(result != HIPRTC_SUCCESS)
        MIGRAPHX_HIPRTC_THROW(result, "Create program failed.");
    return p;
}

struct hiprtc_program
{
    struct string_array
    {
        std::vector<std::string> strings{};
        std::vector<const char*> c_strs{};

        string_array() {}
        string_array(const string_array&) = delete;

        std::size_t size() const { return strings.size(); }

        const char** data() { return c_strs.data(); }

        void push_back(std::string s)
        {
            strings.push_back(std::move(s));
            c_strs.push_back(strings.back().c_str());
        }
    };

    hiprtc_program_ptr prog = nullptr;
    string_array headers{};
    string_array include_names{};
    std::string cpp_src  = "";
    std::string cpp_name = "";

121
    hiprtc_program(std::vector<hiprtc_src_file> srcs)
122
123
124
    {
        for(auto&& src : srcs)
        {
125
            if(ends_with(src.path, ".cpp"))
126
            {
127
128
                cpp_src  = std::move(src.content);
                cpp_name = std::move(src.path);
129
130
131
            }
            else
            {
132
133
                headers.push_back(std::move(src.content));
                include_names.push_back(std::move(src.path));
134
135
136
137
138
139
140
141
142
            }
        }
        prog = hiprtc_program_create(cpp_src.c_str(),
                                     cpp_name.c_str(),
                                     headers.size(),
                                     headers.data(),
                                     include_names.data());
    }

143
    void compile(const std::vector<std::string>& options) const
144
145
146
147
148
149
150
151
    {
        if(enabled(MIGRAPHX_TRACE_HIPRTC{}))
            std::cout << "hiprtc " << join_strings(options, " ") << " " << cpp_name << std::endl;
        std::vector<const char*> c_options;
        std::transform(options.begin(),
                       options.end(),
                       std::back_inserter(c_options),
                       [](const std::string& s) { return s.c_str(); });
Umang Yadav's avatar
Umang Yadav committed
152
153
154
155
156
157
        auto result   = hiprtcCompileProgram(prog.get(), c_options.size(), c_options.data());
        auto prog_log = log();
        if(not prog_log.empty())
        {
            std::cerr << prog_log << std::endl;
        }
158
159
160
161
        if(result != HIPRTC_SUCCESS)
            MIGRAPHX_HIPRTC_THROW(result, "Compilation failed.");
    }

Umang Yadav's avatar
Umang Yadav committed
162
    std::string log() const
163
164
165
    {
        std::size_t n = 0;
        MIGRAPHX_HIPRTC(hiprtcGetProgramLogSize(prog.get(), &n));
Umang Yadav's avatar
Umang Yadav committed
166
        if(n == 0)
167
            return {};
Umang Yadav's avatar
Umang Yadav committed
168
        std::string buffer(n, '\0');
169
        MIGRAPHX_HIPRTC(hiprtcGetProgramLog(prog.get(), buffer.data()));
Umang Yadav's avatar
Umang Yadav committed
170
171
        assert(buffer.back() != 0);
        return buffer;
172
173
    }

Umang Yadav's avatar
Umang Yadav committed
174
    std::vector<char> get_code_obj() const
175
176
177
178
179
180
181
182
183
    {
        std::size_t n = 0;
        MIGRAPHX_HIPRTC(hiprtcGetCodeSize(prog.get(), &n));
        std::vector<char> buffer(n);
        MIGRAPHX_HIPRTC(hiprtcGetCode(prog.get(), buffer.data()));
        return buffer;
    }
};

184
185
186
std::vector<std::vector<char>> compile_hip_src_with_hiprtc(std::vector<hiprtc_src_file> srcs,
                                                           std::string params,
                                                           const std::string& arch)
187
{
188
    hiprtc_program prog(std::move(srcs));
189
    auto options = split_string(params, ' ');
Umang Yadav's avatar
Umang Yadav committed
190
191
192
193
194
195
196
197
198
199
200
    options.push_back("-DMIGRAPHX_USE_HIPRTC=1");
    // remove following three compilation flags for HIPRTC once fixes from hipRTC are available in
    if(enabled(MIGRAPHX_ENABLE_HIPRTC_WORKAROUNDS{}))
    {
        options.push_back("-DMIGRAPHX_HAS_DPP=0");
        options.push_back("-DMIGRAPHX_ENABLE_HIPRTC_WORKAROUNDS=1");
        options.push_back("-Wno-reserved-identifier");
        options.push_back("-Wno-gnu-line-marker");
        options.push_back("-Wno-old-style-cast");
    }

201
202
203
204
205
206
207
    if(enabled(MIGRAPHX_GPU_DEBUG{}))
        options.push_back("-DMIGRAPHX_DEBUG");
    if(std::none_of(options.begin(), options.end(), [](const std::string& s) {
           return starts_with(s, "--std=") or starts_with(s, "-std=");
       }))
        options.push_back("-std=c++17");
    options.push_back("-fno-gpu-rdc");
Umang Yadav's avatar
Umang Yadav committed
208
    options.push_back("-O" + string_value_of(MIGRAPHX_GPU_OPTIMIZE{}, "3"));
209
    options.push_back("-Wno-cuda-compat");
Umang Yadav's avatar
Umang Yadav committed
210
    options.push_back("--offload-arch=" + arch);
211
212
213
214
    prog.compile(options);
    return {prog.get_code_obj()};
}

215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
std::vector<std::vector<char>>
compile_hip_src(const std::vector<src_file>& srcs, std::string params, const std::string& arch)
{
    std::vector<hiprtc_src_file> hsrcs{srcs.begin(), srcs.end()};
    auto p      = dynamic_loader::path(&compile_hip_src_with_hiprtc);
    auto driver = p.parent_path().parent_path() / "bin" / "migraphx-hiprtc-driver";

    if(fs::exists(driver))
    {
        value v;
        v["srcs"]   = to_value(hsrcs);
        v["params"] = to_value(params);
        v["arch"]   = to_value(arch);

        tmp_dir td{};
        auto out = td.path / "output";

        process(driver.string() + " " + out.string()).write([&](auto writer) {
            to_msgpack(v, writer);
        });
        if(fs::exists(out))
            return {read_buffer(out.string())};
    }
    return compile_hip_src_with_hiprtc(std::move(hsrcs), std::move(params), arch);
}

241
242
#else // MIGRAPHX_USE_HIPRTC

243
244
245
246
247
248
249
std::vector<std::vector<char>> compile_hip_src_with_hiprtc(std::vector<hiprtc_src_file>, // NOLINT
                                                           std::string,                  // NOLINT
                                                           const std::string&)
{
    MIGRAPHX_THROW("Not using hiprtc");
}

Paul Fultz II's avatar
Paul Fultz II committed
250
251
252
253
254
255
bool is_hip_clang_compiler()
{
    static const auto result = ends_with(MIGRAPHX_STRINGIZE(MIGRAPHX_HIP_COMPILER), "clang++");
    return result;
}

256
257
258
259
260
261
bool has_compiler_launcher()
{
    static const auto result = fs::exists(MIGRAPHX_STRINGIZE(MIGRAPHX_HIP_COMPILER_LAUNCHER));
    return result;
}

262
263
264
265
266
267
268
src_compiler assemble(src_compiler compiler)
{
    compiler.out_ext = ".S";
    compiler.flags   = replace_string(compiler.flags, " -c", " -S");
    return compiler;
}

Paul Fultz II's avatar
Paul Fultz II committed
269
270
271
std::vector<std::vector<char>>
compile_hip_src(const std::vector<src_file>& srcs, std::string params, const std::string& arch)
{
272
    assert(not srcs.empty());
Umang Yadav's avatar
Umang Yadav committed
273
    if(not is_hip_clang_compiler())
Paul Fultz II's avatar
Paul Fultz II committed
274
275
        MIGRAPHX_THROW("Unknown hip compiler: " +
                       std::string(MIGRAPHX_STRINGIZE(MIGRAPHX_HIP_COMPILER)));
276

Paul Fultz II's avatar
Paul Fultz II committed
277
278
279
    if(params.find("-std=") == std::string::npos)
        params += " --std=c++17";
    params += " -fno-gpu-rdc";
280
281
    if(enabled(MIGRAPHX_GPU_DEBUG_SYM{}))
        params += " -g";
Paul Fultz II's avatar
Paul Fultz II committed
282
    params += " -c";
Umang Yadav's avatar
Umang Yadav committed
283
284
285
    params += " --offload-arch=" + arch;
    params += " --cuda-device-only";
    params += " -O" + string_value_of(MIGRAPHX_GPU_OPTIMIZE{}, "3") + " ";
Paul Fultz II's avatar
Paul Fultz II committed
286

287
288
289
    if(enabled(MIGRAPHX_GPU_DEBUG{}))
        params += " -DMIGRAPHX_DEBUG";

290
    params += " -Wno-unused-command-line-argument -Wno-cuda-compat ";
Paul Fultz II's avatar
Paul Fultz II committed
291
292
    params += MIGRAPHX_STRINGIZE(MIGRAPHX_HIP_COMPILER_FLAGS);

293
294
295
    src_compiler compiler;
    compiler.flags    = params;
    compiler.compiler = MIGRAPHX_STRINGIZE(MIGRAPHX_HIP_COMPILER);
296
297
298
299
#ifdef MIGRAPHX_HIP_COMPILER_LAUNCHER
    if(has_compiler_launcher())
        compiler.launcher = MIGRAPHX_STRINGIZE(MIGRAPHX_HIP_COMPILER_LAUNCHER);
#endif
300
301
302
303
304
305
306
307
308
309
    if(enabled(MIGRAPHX_GPU_DUMP_SRC{}))
    {
        for(const auto& src : srcs)
        {
            if(src.path.extension() != ".cpp")
                continue;
            std::cout << std::string(src.content.first, src.len()) << std::endl;
        }
    }

310
311
312
313
314
315
    if(enabled(MIGRAPHX_GPU_DUMP_ASM{}))
    {

        std::cout << assemble(compiler).compile(srcs).data() << std::endl;
    }

316
    return {compiler.compile(srcs)};
Paul Fultz II's avatar
Paul Fultz II committed
317
318
}

Umang Yadav's avatar
Umang Yadav committed
319
320
#endif // MIGRAPHX_USE_HIPRTC

Shucai Xiao's avatar
Shucai Xiao committed
321
322
323
324
325
326
327
std::string enum_params(std::size_t count, std::string param)
{
    std::vector<std::string> items(count);
    transform(range(count), items.begin(), [&](auto i) { return param + std::to_string(i); });
    return join_strings(items, ",");
}

Paul Fultz II's avatar
Paul Fultz II committed
328
329
330
} // namespace gpu
} // namespace MIGRAPHX_INLINE_NS
} // namespace migraphx