staq_compiler.cpp 10.6 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
/*******************************************************************************
 * Copyright (c) 2020 UT-Battelle, LLC.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * and Eclipse Distribution License v1.0 which accompanies this
 * distribution. The Eclipse Public License is available at
 * http://www.eclipse.org/legal/epl-v10.html and the Eclipse Distribution
 *License is available at https://eclipse.org/org/documents/edl-v10.php
 *
 * Contributors:
 *   Alexander J. McCaskey - initial API and implementation
 *******************************************************************************/
#include "staq_compiler.hpp"

#include "xacc.hpp"
#include "xacc_service.hpp"

#include "InstructionIterator.hpp"
#include "AcceleratorBuffer.hpp"

21
22
#include "staq_visitors.hpp"

23
24
25
26
27
#include "transformations/desugar.hpp"
#include "transformations/inline.hpp"
#include "transformations/oracle_synthesizer.hpp"
#include "optimization/simplify.hpp"

28
29
#include "output/cirq.hpp"

30
31
#include <streambuf>

32
33
34
35
36
37
using namespace staq::ast;

namespace xacc {

StaqCompiler::StaqCompiler() {}

38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
bool StaqCompiler::canParse(const std::string &src) {
  std::string _src = src;
  bool isXaccKernel = false;
  std::string prototype;
  auto xasm = xacc::getCompiler("xasm");

  /** staq prints to cerr, override this **/
  class buffer_override {
    std::ostream &os;
    std::streambuf *buf;

  public:
    buffer_override(std::ostream &os) : os(os), buf(os.rdbuf()) {}

    ~buffer_override() { os.rdbuf(buf); }
  };

  buffer_override b(std::cerr);
  std::stringstream xx;

  std::cerr.rdbuf(xx.rdbuf());

  /** --------------------------------- **/

  if (src.find("__qpu__") != std::string::npos) {
    prototype = _src.substr(0, _src.find_first_of("{")) + "{}";
    auto bufferNames = xasm->getKernelBufferNames(prototype);

    isXaccKernel = true;

    std::string tmp = "";
    auto first = _src.find_first_of("{");
    auto last = _src.find_last_of("}");
    auto sub = _src.substr(first + 1, last - first - 1);
    auto lines = xacc::split(sub, '\n');
    bool addedNames = false;
    for (auto &l : lines) {
      xacc::trim(l);
      if (l.find("measure") != std::string::npos) {
77
78
        // don't add measures
        continue;
79
80
81
82
83
84
85
86
87
88
89
90
91
      }
      tmp += l + "\n";
      if (l.find("include") != std::string::npos) {
        for (auto &b : bufferNames) {
          auto size = std::numeric_limits<int>::max();
          tmp += "qreg " + b + "[" + std::to_string(size) + "];\n";
        }
        addedNames = true;
      }
    }
    _src = tmp;
    if (!addedNames) {
      for (auto &b : bufferNames) {
92
        auto size = std::numeric_limits<int>::max();
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
        _src = "qreg " + b + "[" + std::to_string(size) + "];\n" + _src;
      }
    }
  }

  // we allow users to leave out OPENQASM 2.0 and include qelib.inc
  // If they did we need to add it for them
  std::string tmp = "";
  auto lines = xacc::split(_src, '\n');
  bool foundOpenQasm = false, foundInclude = false;
  for (auto &l : lines) {
    if (l.find("OPENQASM") != std::string::npos) {
      foundOpenQasm = true;
    }
    if (l.find("include") != std::string::npos) {
      foundInclude = true;
    }
  }

  if (!foundInclude) {
    _src = "include \"qelib1.inc\";\n" + _src;
  }
  if (!foundOpenQasm) {
    _src = "OPENQASM 2.0;\n" + _src;
  }

119
  // std::cout << " HELLO:\n" << _src << "\n";
120
121
122
123
124
125
126
127
128
129
  using namespace staq;

  try {
    auto prog = parser::parse_string(_src);
    return true;
  } catch (std::exception &e) {
    return false;
  }
}

130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
std::shared_ptr<IR> StaqCompiler::compile(const std::string &src,
                                          std::shared_ptr<Accelerator> acc) {
  // IF src contains typical xacc quantum kernel prototype, then take
  // buffers names and add qreg declarations before parsing
  // IF it does not, then assume qreg decls already declared.
  auto xasm = xacc::getCompiler("xasm");
  std::string prototype;

  std::string _src = src;
  bool isXaccKernel = false;
  if (src.find("__qpu__") != std::string::npos) {
    prototype = _src.substr(0, _src.find_first_of("{")) + "{}";
    auto bufferNames = xasm->getKernelBufferNames(prototype);

    isXaccKernel = true;

    std::string tmp = "";
    auto first = _src.find_first_of("{");
    auto last = _src.find_last_of("}");
    auto sub = _src.substr(first + 1, last - first - 1);
    auto lines = xacc::split(sub, '\n');
151
    bool addedNames = false;
152
153
154
155
156
157
158
159
    for (auto &l : lines) {
      xacc::trim(l);
      tmp += l + "\n";
      if (l.find("include") != std::string::npos) {
        for (auto &b : bufferNames) {
          auto size = xacc::getBuffer(b)->size();
          tmp += "qreg " + b + "[" + std::to_string(size) + "];\n";
        }
160
        addedNames = true;
161
162
163
      }
    }
    _src = tmp;
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
    if (!addedNames) {
      for (auto &b : bufferNames) {
        auto size = xacc::getBuffer(b)->size();
        _src = "qreg " + b + "[" + std::to_string(size) + "];\n" + _src;
      }
    }
  }

  // we allow users to leave out OPENQASM 2.0 and include qelib.inc
  // If they did we need to add it for them
  std::string tmp = "";
  auto lines = xacc::split(_src, '\n');
  bool foundOpenQasm = false, foundInclude = false;
  for (auto &l : lines) {
    if (l.find("OPENQASM") != std::string::npos) {
      foundOpenQasm = true;
    }
    if (l.find("include") != std::string::npos) {
      foundInclude = true;
    }
184
185
  }

186
187
188
189
190
191
  if (!foundInclude) {
    _src = "include \"qelib1.inc\";\n" + _src;
  }
  if (!foundOpenQasm) {
    _src = "OPENQASM 2.0;\n" + _src;
  }
192

193
  //   std::cout << " HELLO:\n" << _src << "\n";
194
  using namespace staq;
195
196
197
198
199
200
201
202
203
204
205
  ast::ptr<ast::Program> prog;
  try {
    prog = parser::parse_string(src);
    transformations::desugar(*prog);
    transformations::synthesize_oracles(*prog);
  } catch (std::exception &e) {
    std::stringstream ss;
    ss << e.what();
    ss << "\nXACC Error in Staq Compiler, here was the src:\n" << src << "\n";
    xacc::error(ss.str());
  }
206

207
208
  if (run_staq_optimize)
    optimization::simplify(*prog);
209

210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
  // at this point we have to find out if we have any ancilla
  // registers
  internal_staq::CountAncillas ancillas;
  dynamic_cast<ast::Traverse &>(ancillas).visit(*prog);

  // add ancilla registers to xacc
  for (auto &kv : ancillas.ancillas) {
    if (!xacc::hasBuffer(kv.first)) {
      auto q = xacc::qalloc(kv.second);
      q->setName(kv.first);
      xacc::storeBuffer(q);
    } else {
      xacc::getBuffer(kv.first)->resetBuffer();
    }
  }

  transformations::inline_ast(
      *prog, {false, transformations::default_overrides, "anc"});

229
  //   std::cout <<"PROG: " << *prog << "\n";
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
  // Visit Program to find out how many qreg there are and
  // use that to build up openqasm xacc function prototype

  internal_staq::StaqToXasm translate;
  translate.visit(*prog);

  std::string kernel;
  if (isXaccKernel) {
    if (!ancillas.ancillas.empty()) {
      kernel = prototype.substr(0, prototype.find_first_of(")"));
      for (auto &kv : ancillas.ancillas) {
        kernel += ", qreg " + kv.first;
      }
      kernel += ") {\n" + translate.ss.str() + "}";
    } else {
      kernel = prototype.substr(0, prototype.length() - 1) + "\n" +
               translate.ss.str() + "}";
    }
  } else {
    internal_staq::CountQregs c;
    dynamic_cast<ast::Traverse &>(c).visit(*prog);

    std::stringstream xx;
    std::string name = "tmp";
    if (xacc::hasCompiled(name)) {
255
256
257
258
259
      int counter = 0;
      while (true) {
        name = "tmp" + std::to_string(counter);
        if (!xacc::hasCompiled(name)) {
          break;
260
        }
261
262
        counter++;
      }
263
    }
264
    xx << "__qpu__ void " << name << "(";
265
266
267
268
269
270
271
272
273
274
    xx << "qreg " << c.qregs[0];
    for (int i = 1; i < c.qregs.size(); i++) {
      xx << ", qreg " << c.qregs[i];
    }
    for (auto &kv : ancillas.ancillas) {
      xx << ", qreg " << kv.first;
    }
    xx << ") {\n" << translate.ss.str() << "}";
    kernel = xx.str();
  }
275
  // std::cout << "\n\nFinal:\n" << kernel << "\n";
276
277
278
279
280
281
282
283
284
  return xasm->compile(kernel, acc);
}

std::shared_ptr<IR> StaqCompiler::compile(const std::string &src) {
  return compile(src, nullptr);
}

const std::string
StaqCompiler::translate(std::shared_ptr<xacc::CompositeInstruction> function) {
285
  std::map<std::string, int> bufNamesToSize;
286
  InstructionIterator iter(function);
287
  // First search buffer names and see if we have
288
  while (iter.hasNext()) {
289
290
    auto &next = *iter.next();
    if (next.isEnabled()) {
291
292
293
294
295
296
297
298
299
      for (int i = 0; i < next.nRequiredBits(); i++) {
        auto bufName = next.getBufferName(i);
        int size = next.bits()[i] + 1;
        if (bufNamesToSize.count(bufName)) {
          if (bufNamesToSize[bufName] < size) {
            bufNamesToSize[bufName] = size;
          }
        } else {
          bufNamesToSize.insert({bufName, size});
300
        }
301
      }
302
303
304
    }
  }

305
306
  auto translate =
      std::make_shared<internal_staq::XACCToStaqOpenQasm>(bufNamesToSize);
307
  InstructionIterator iter2(function);
308
  while (iter2.hasNext()) {
309
310
    auto &next = *iter2.next();
    if (next.isEnabled()) {
311
      next.accept(translate);
312
313
314
315
    }
  }

  return translate->ss.str();
316
}
317
318
319

const std::string
StaqCompiler::translate(std::shared_ptr<CompositeInstruction> program,
320
                        HeterogeneousMap &options) {
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
  if (options.stringExists("lang-type")) {
    auto langType = options.getString("lang-type");

    // map xacc to staq program
    std::map<std::string, int> bufNamesToSize;
    InstructionIterator iter(program);
    // First search buffer names and see if we have
    while (iter.hasNext()) {
      auto &next = *iter.next();
      if (next.isEnabled()) {
        for (int i = 0; i < next.nRequiredBits(); i++) {
          auto bufName = next.getBufferName(i);
          int size = next.bits()[i] + 1;
          if (bufNamesToSize.count(bufName)) {
            if (bufNamesToSize[bufName] < size) {
              bufNamesToSize[bufName] = size;
            }
          } else {
            bufNamesToSize.insert({bufName, size});
          }
        }
      }
    }
    auto translate =
        std::make_shared<internal_staq::XACCToStaqOpenQasm>(bufNamesToSize);
    InstructionIterator iter2(program);
    while (iter2.hasNext()) {
      auto &next = *iter2.next();
      if (next.isEnabled()) {
        next.accept(translate);
      }
    }
    // std::cout << "HELLO:\n" << translate->ss.str() << "\n";
    using namespace staq;
    auto prog = parser::parse_string(translate->ss.str());
    transformations::desugar(*prog);
    transformations::synthesize_oracles(*prog);

    optimization::simplify(*prog);

    std::stringstream ss;
    if (langType == "cirq") {
      staq::output::CirqOutputter outputter(ss);
      outputter.run(*prog);
    }

    return ss.str();

  } else {
    return translate(program);
  }
}

374
} // namespace xacc