1//===-- SnippetFile.cpp -----------------------------------------*- C++ -*-===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8///
9/// \file
10/// Utilities to read a snippet file.
11/// Snippet files are just asm files with additional comments to specify which
12/// registers should be defined or are live on entry.
13///
14//===----------------------------------------------------------------------===//
15
16#ifndef LLVM_TOOLS_LLVM_EXEGESIS_SNIPPETFILE_H
17#define LLVM_TOOLS_LLVM_EXEGESIS_SNIPPETFILE_H
18
19#include "BenchmarkCode.h"
20#include "LlvmState.h"
21#include "llvm/Support/Error.h"
22
23#include <vector>
24
25namespace llvm {
26namespace exegesis {
27
28// Reads code snippets from file `Filename`.
29Expected<std::vector<BenchmarkCode>> readSnippets(const LLVMState &State,
30                                                  StringRef Filename);
31
32} // namespace exegesis
33} // namespace llvm
34
35#endif
36