aboutsummaryrefslogtreecommitdiffstats
path: root/contrib/libs/llvm12/include/llvm/BinaryFormat/AMDGPUMetadataVerifier.h
blob: 69137bd0c11e3c0e2aec8d4a5faae3d810a59b12 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
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
77
78
79
80
#pragma once 
 
#ifdef __GNUC__ 
#pragma GCC diagnostic push 
#pragma GCC diagnostic ignored "-Wunused-parameter" 
#endif 
 
//===- AMDGPUMetadataVerifier.h - MsgPack Types -----------------*- C++ -*-===// 
// 
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. 
// See https://llvm.org/LICENSE.txt for license information. 
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception 
// 
//===----------------------------------------------------------------------===// 
// 
/// \file 
/// This is a verifier for AMDGPU HSA metadata, which can verify both 
/// well-typed metadata and untyped metadata. When verifying in the non-strict 
/// mode, untyped metadata is coerced into the correct type if possible. 
// 
//===----------------------------------------------------------------------===// 
 
#ifndef LLVM_BINARYFORMAT_AMDGPUMETADATAVERIFIER_H 
#define LLVM_BINARYFORMAT_AMDGPUMETADATAVERIFIER_H 
 
#include "llvm/BinaryFormat/MsgPackDocument.h" 
 
namespace llvm { 
namespace AMDGPU { 
namespace HSAMD { 
namespace V3 { 
 
/// Verifier for AMDGPU HSA metadata. 
/// 
/// Operates in two modes: 
/// 
/// In strict mode, metadata must already be well-typed. 
/// 
/// In non-strict mode, metadata is coerced into expected types when possible. 
class MetadataVerifier { 
  bool Strict; 
 
  bool verifyScalar(msgpack::DocNode &Node, msgpack::Type SKind, 
                    function_ref<bool(msgpack::DocNode &)> verifyValue = {}); 
  bool verifyInteger(msgpack::DocNode &Node); 
  bool verifyArray(msgpack::DocNode &Node, 
                   function_ref<bool(msgpack::DocNode &)> verifyNode, 
                   Optional<size_t> Size = None); 
  bool verifyEntry(msgpack::MapDocNode &MapNode, StringRef Key, bool Required, 
                   function_ref<bool(msgpack::DocNode &)> verifyNode); 
  bool 
  verifyScalarEntry(msgpack::MapDocNode &MapNode, StringRef Key, bool Required, 
                    msgpack::Type SKind, 
                    function_ref<bool(msgpack::DocNode &)> verifyValue = {}); 
  bool verifyIntegerEntry(msgpack::MapDocNode &MapNode, StringRef Key, 
                          bool Required); 
  bool verifyKernelArgs(msgpack::DocNode &Node); 
  bool verifyKernel(msgpack::DocNode &Node); 
 
public: 
  /// Construct a MetadataVerifier, specifying whether it will operate in \p 
  /// Strict mode. 
  MetadataVerifier(bool Strict) : Strict(Strict) {} 
 
  /// Verify given HSA metadata. 
  /// 
  /// \returns True when successful, false when metadata is invalid. 
  bool verify(msgpack::DocNode &HSAMetadataRoot); 
}; 
 
} // end namespace V3 
} // end namespace HSAMD 
} // end namespace AMDGPU 
} // end namespace llvm 
 
#endif // LLVM_BINARYFORMAT_AMDGPUMETADATAVERIFIER_H 
 
#ifdef __GNUC__ 
#pragma GCC diagnostic pop 
#endif