xref: /freebsd-src/contrib/llvm-project/llvm/include/llvm/ObjectYAML/OffloadYAML.h (revision 81ad626541db97eb356e2c1d4a20eb2a26a766ab)
1*81ad6265SDimitry Andric //===- OffloadYAML.h - Offload Binary YAMLIO implementation -----*- C++ -*-===//
2*81ad6265SDimitry Andric //
3*81ad6265SDimitry Andric // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4*81ad6265SDimitry Andric // See https://llvm.org/LICENSE.txt for license information.
5*81ad6265SDimitry Andric // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6*81ad6265SDimitry Andric //
7*81ad6265SDimitry Andric //===----------------------------------------------------------------------===//
8*81ad6265SDimitry Andric ///
9*81ad6265SDimitry Andric /// \file
10*81ad6265SDimitry Andric /// This file declares classes for handling the YAML representation of
11*81ad6265SDimitry Andric /// offloading binaries.
12*81ad6265SDimitry Andric ///
13*81ad6265SDimitry Andric //===----------------------------------------------------------------------===//
14*81ad6265SDimitry Andric 
15*81ad6265SDimitry Andric #ifndef LLVM_OBJECTYAML_OFFLOADYAML_H
16*81ad6265SDimitry Andric #define LLVM_OBJECTYAML_OFFLOADYAML_H
17*81ad6265SDimitry Andric 
18*81ad6265SDimitry Andric #include "llvm/ADT/MapVector.h"
19*81ad6265SDimitry Andric #include "llvm/Object/OffloadBinary.h"
20*81ad6265SDimitry Andric #include "llvm/ObjectYAML/YAML.h"
21*81ad6265SDimitry Andric #include "llvm/Support/YAMLTraits.h"
22*81ad6265SDimitry Andric 
23*81ad6265SDimitry Andric namespace llvm {
24*81ad6265SDimitry Andric namespace OffloadYAML {
25*81ad6265SDimitry Andric 
26*81ad6265SDimitry Andric struct Binary {
27*81ad6265SDimitry Andric   struct StringEntry {
28*81ad6265SDimitry Andric     StringRef Key;
29*81ad6265SDimitry Andric     StringRef Value;
30*81ad6265SDimitry Andric   };
31*81ad6265SDimitry Andric 
32*81ad6265SDimitry Andric   struct Member {
33*81ad6265SDimitry Andric     Optional<object::ImageKind> ImageKind;
34*81ad6265SDimitry Andric     Optional<object::OffloadKind> OffloadKind;
35*81ad6265SDimitry Andric     Optional<uint32_t> Flags;
36*81ad6265SDimitry Andric     Optional<std::vector<StringEntry>> StringEntries;
37*81ad6265SDimitry Andric     Optional<yaml::BinaryRef> Content;
38*81ad6265SDimitry Andric   };
39*81ad6265SDimitry Andric 
40*81ad6265SDimitry Andric   Optional<uint32_t> Version;
41*81ad6265SDimitry Andric   Optional<uint64_t> Size;
42*81ad6265SDimitry Andric   Optional<uint64_t> EntryOffset;
43*81ad6265SDimitry Andric   Optional<uint64_t> EntrySize;
44*81ad6265SDimitry Andric   std::vector<Member> Members;
45*81ad6265SDimitry Andric };
46*81ad6265SDimitry Andric 
47*81ad6265SDimitry Andric } // end namespace OffloadYAML
48*81ad6265SDimitry Andric } // end namespace llvm
49*81ad6265SDimitry Andric 
50*81ad6265SDimitry Andric LLVM_YAML_IS_SEQUENCE_VECTOR(llvm::OffloadYAML::Binary::Member)
51*81ad6265SDimitry Andric LLVM_YAML_IS_SEQUENCE_VECTOR(llvm::OffloadYAML::Binary::StringEntry)
52*81ad6265SDimitry Andric 
53*81ad6265SDimitry Andric namespace llvm {
54*81ad6265SDimitry Andric namespace yaml {
55*81ad6265SDimitry Andric 
56*81ad6265SDimitry Andric template <> struct ScalarEnumerationTraits<object::ImageKind> {
57*81ad6265SDimitry Andric   static void enumeration(IO &IO, object::ImageKind &Value);
58*81ad6265SDimitry Andric };
59*81ad6265SDimitry Andric 
60*81ad6265SDimitry Andric template <> struct ScalarEnumerationTraits<object::OffloadKind> {
61*81ad6265SDimitry Andric   static void enumeration(IO &IO, object::OffloadKind &Value);
62*81ad6265SDimitry Andric };
63*81ad6265SDimitry Andric 
64*81ad6265SDimitry Andric template <> struct MappingTraits<OffloadYAML::Binary> {
65*81ad6265SDimitry Andric   static void mapping(IO &IO, OffloadYAML::Binary &O);
66*81ad6265SDimitry Andric };
67*81ad6265SDimitry Andric 
68*81ad6265SDimitry Andric template <> struct MappingTraits<OffloadYAML::Binary::StringEntry> {
69*81ad6265SDimitry Andric   static void mapping(IO &IO, OffloadYAML::Binary::StringEntry &M);
70*81ad6265SDimitry Andric };
71*81ad6265SDimitry Andric 
72*81ad6265SDimitry Andric template <> struct MappingTraits<OffloadYAML::Binary::Member> {
73*81ad6265SDimitry Andric   static void mapping(IO &IO, OffloadYAML::Binary::Member &M);
74*81ad6265SDimitry Andric };
75*81ad6265SDimitry Andric 
76*81ad6265SDimitry Andric } // end namespace yaml
77*81ad6265SDimitry Andric } // end namespace llvm
78*81ad6265SDimitry Andric 
79*81ad6265SDimitry Andric #endif // LLVM_OBJECTYAML_ARCHIVEYAML_H
80