aboutsummaryrefslogtreecommitdiff
path: root/llvm/unittests/Bitstream/BitstreamWriterTest.cpp
blob: 933965abdbadf75911dda1212972570e144141ac (plain)
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
81
82
83
84
85
86
87
88
89
90
91
92
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
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
//===- BitstreamWriterTest.cpp - Tests for BitstreamWriter ----------------===//
//
// 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
//
//===----------------------------------------------------------------------===//

#include "llvm/Bitstream/BitstreamWriter.h"
#include "llvm/ADT/STLExtras.h"
#include "llvm/ADT/SmallString.h"
#include "llvm/Bitstream/BitCodeEnums.h"
#include "llvm/Bitstream/BitstreamReader.h"
#include "llvm/Support/Error.h"
#include "llvm/Support/MemoryBuffer.h"
#include "llvm/Testing/Support/SupportHelpers.h"
#include "gmock/gmock.h"
#include "gtest/gtest.h"

using namespace llvm;

namespace {

TEST(BitstreamWriterTest, emitBlob) {
  SmallString<64> Buffer;
  BitstreamWriter W(Buffer);
  W.emitBlob("str", /* ShouldEmitSize */ false);
  EXPECT_EQ(StringRef("str\0", 4), Buffer);
}

TEST(BitstreamWriterTest, emitBlobWithSize) {
  SmallString<64> Buffer;
  {
    BitstreamWriter W(Buffer);
    W.emitBlob("str");
  }
  SmallString<64> Expected;
  {
    BitstreamWriter W(Expected);
    W.EmitVBR(3, 6);
    W.FlushToWord();
    W.Emit('s', 8);
    W.Emit('t', 8);
    W.Emit('r', 8);
    W.Emit(0, 8);
  }
  EXPECT_EQ(Expected.str(), Buffer);
}

TEST(BitstreamWriterTest, emitBlobEmpty) {
  SmallString<64> Buffer;
  BitstreamWriter W(Buffer);
  W.emitBlob("", /* ShouldEmitSize */ false);
  EXPECT_EQ(StringRef(""), Buffer);
}

TEST(BitstreamWriterTest, emitBlob4ByteAligned) {
  SmallString<64> Buffer;
  BitstreamWriter W(Buffer);
  W.emitBlob("str0", /* ShouldEmitSize */ false);
  EXPECT_EQ(StringRef("str0"), Buffer);
}

class BitstreamWriterFlushTest : public ::testing::TestWithParam<int> {
protected:
  // Any value after bitc::FIRST_APPLICATION_BLOCKID is good, but let's pick a
  // distinctive one.
  const unsigned BlkID = bitc::FIRST_APPLICATION_BLOCKID + 17;

  void write(StringRef TestFilePath, int FlushThreshold,
             llvm::function_ref<void(BitstreamWriter &)> Action) {
    std::error_code EC;
    raw_fd_stream Out(TestFilePath, EC);
    ASSERT_FALSE(EC);
    BitstreamWriter W(Out, FlushThreshold);
    Action(W);
  }
};

TEST_P(BitstreamWriterFlushTest, simpleExample) {
  llvm::unittest::TempFile TestFile("bitstream", "", "",
                                    /*Unique*/ true);
  write(TestFile.path(), GetParam(),
        [&](BitstreamWriter &W) { W.EmitVBR(42, 2); });

  ErrorOr<std::unique_ptr<MemoryBuffer>> MB =
      MemoryBuffer::getFile(TestFile.path());
  ASSERT_TRUE(!!MB);
  ASSERT_NE(*MB, nullptr);
  BitstreamCursor Cursor((*MB)->getBuffer());
  auto V = Cursor.ReadVBR(2);
  EXPECT_TRUE(!!V);
  EXPECT_EQ(*V, 42U);
}

TEST_P(BitstreamWriterFlushTest, subBlock) {
  llvm::unittest::TempFile TestFile("bitstream", "", "",
                                    /*Unique*/ true);
  write(TestFile.path(), GetParam(), [&](BitstreamWriter &W) {
    W.EnterSubblock(BlkID, 2);
    W.EmitVBR(42, 2);
    W.ExitBlock();
  });
  ErrorOr<std::unique_ptr<MemoryBuffer>> MB =
      MemoryBuffer::getFile(TestFile.path());
  ASSERT_TRUE(!!MB);
  ASSERT_NE(*MB, nullptr);
  BitstreamCursor Cursor((*MB)->getBuffer());
  auto Blk = Cursor.advance(BitstreamCursor::AF_DontAutoprocessAbbrevs);
  ASSERT_TRUE(!!Blk);
  EXPECT_EQ(Blk->Kind, BitstreamEntry::SubBlock);
  EXPECT_EQ(Blk->ID, BlkID);
  EXPECT_FALSE(Cursor.EnterSubBlock(BlkID));
  auto V = Cursor.ReadVBR(2);
  EXPECT_TRUE(!!V);
  EXPECT_EQ(*V, 42U);
  // ReadBlockEnd() returns false if it actually read the block end.
  EXPECT_FALSE(Cursor.ReadBlockEnd());
  EXPECT_TRUE(Cursor.AtEndOfStream());
}

TEST_P(BitstreamWriterFlushTest, blobRawRead) {
  llvm::unittest::TempFile TestFile("bitstream", "", "",
                                    /*Unique*/ true);
  write(TestFile.path(), GetParam(), [&](BitstreamWriter &W) {
    W.emitBlob("str", /* ShouldEmitSize */ false);
  });

  ErrorOr<std::unique_ptr<MemoryBuffer>> MB =
      MemoryBuffer::getFile(TestFile.path());
  ASSERT_TRUE(!!MB);
  ASSERT_NE(*MB, nullptr);
  EXPECT_EQ(StringRef("str\0", 4), (*MB)->getBuffer());
}

INSTANTIATE_TEST_SUITE_P(BitstreamWriterFlushCases, BitstreamWriterFlushTest,
                         ::testing::Values(0, 1 /*MB*/));
} // end namespace