|
| 1 | +/******************************************************************************* |
| 2 | + * Copyright (c) 2022 - 2023 NVIDIA Corporation & Affiliates. * |
| 3 | + * All rights reserved. * |
| 4 | + * * |
| 5 | + * This source code and the accompanying materials are made available under * |
| 6 | + * the terms of the Apache License 2.0 which accompanies this distribution. * |
| 7 | + ******************************************************************************/ |
| 8 | + |
| 9 | +/// The fixup-linkage tool is used to rewrite the LLVM IR produced by clang for |
| 10 | +/// the classical compute code such that it can be linked correctly with the |
| 11 | +/// LLVM IR that is generated for the quantum code. This avoids linker errors |
| 12 | +/// such as "duplicate symbol definition". |
| 13 | + |
| 14 | +#include <fstream> |
| 15 | +#include <iostream> |
| 16 | +#include <regex> |
| 17 | + |
| 18 | +int main(int argc, char *argv[]) { |
| 19 | + if (argc != 4) { |
| 20 | + std::cerr << "Usage:\n\tfixup-linkage <Quake-file> <LLVM-file> <output>\n"; |
| 21 | + return 1; |
| 22 | + } |
| 23 | + |
| 24 | + // 1. Look for all the mangled kernel names. These will be found in the |
| 25 | + // mangled_name_map in the quake file. Add these names to `funcs`. |
| 26 | + std::ifstream modFile(argv[1]); |
| 27 | + std::string line; |
| 28 | + std::vector<std::string> funcs; |
| 29 | + { |
| 30 | + std::regex mapRegex{"quake\\.mangled_name_map[^\"]*"}; |
| 31 | + std::regex stringRegex{"\"(.*?)\""}; |
| 32 | + while (std::getline(modFile, line) && funcs.empty()) { |
| 33 | + auto funcsBegin = |
| 34 | + std::sregex_iterator(line.begin(), line.end(), mapRegex); |
| 35 | + auto rgxEnd = std::sregex_iterator(); |
| 36 | + if (funcsBegin == rgxEnd) |
| 37 | + continue; |
| 38 | + auto names = line.substr(funcsBegin->str().size() - 1); |
| 39 | + auto namesBegin = |
| 40 | + std::sregex_iterator(names.begin(), names.end(), stringRegex); |
| 41 | + for (std::sregex_iterator i = namesBegin; i != rgxEnd; ++i) { |
| 42 | + auto s = i->str(); |
| 43 | + funcs.push_back(s.substr(1, s.size() - 2)); |
| 44 | + } |
| 45 | + } |
| 46 | + modFile.close(); |
| 47 | + if (funcs.empty()) { |
| 48 | + std::cerr << "No mangled name map in the quake file.\n"; |
| 49 | + return 1; |
| 50 | + } |
| 51 | + } |
| 52 | + |
| 53 | + // 2. Scan the LLVM file looking for the mangled kernel names. Where these |
| 54 | + // kernels are defined, they have their linkage modified to `linkonce_odr` if |
| 55 | + // that is not already the linkage. This change will prevent the duplicate |
| 56 | + // symbols defined error from the linker. |
| 57 | + std::ifstream llFile(argv[2]); |
| 58 | + std::ofstream outFile(argv[3]); |
| 59 | + std::regex filterRegex("^define (dso_local|internal) "); |
| 60 | + auto rgxEnd = std::sregex_iterator(); |
| 61 | + while (std::getline(llFile, line)) { |
| 62 | + auto iter = std::sregex_iterator(line.begin(), line.end(), filterRegex); |
| 63 | + if (iter == rgxEnd) { |
| 64 | + outFile << line << std::endl; |
| 65 | + continue; |
| 66 | + } |
| 67 | + bool replaced = false; |
| 68 | + for (auto fn : funcs) { |
| 69 | + auto pos = line.find(fn); |
| 70 | + if (pos == std::string::npos) |
| 71 | + continue; |
| 72 | + auto ms = (*iter)[1].str(); |
| 73 | + pos = (ms == "internal") ? sizeof("define internal") |
| 74 | + : sizeof("define dso_local"); |
| 75 | + outFile << "define linkonce_odr dso_preemptable " << line.substr(pos) |
| 76 | + << std::endl; |
| 77 | + replaced = true; |
| 78 | + break; |
| 79 | + } |
| 80 | + if (!replaced) |
| 81 | + outFile << line << std::endl; |
| 82 | + } |
| 83 | + llFile.close(); |
| 84 | + outFile.close(); |
| 85 | + return 0; |
| 86 | +} |
0 commit comments