1 /*
2  * Copyright (C) 2013 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *      http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 #include <android-base/logging.h>
18 
19 #include "base/macros.h"
20 #include "base/unix_file/fd_file.h"
21 #include "common_runtime_test.h"
22 #include "stream/buffered_output_stream.h"
23 #include "stream/file_output_stream.h"
24 #include "stream/vector_output_stream.h"
25 
26 namespace art {
27 namespace linker {
28 
29 class OutputStreamTest : public CommonRuntimeTest {
30  protected:
CheckOffset(off_t expected)31   void CheckOffset(off_t expected) {
32     off_t actual = output_stream_->Seek(0, kSeekCurrent);
33     EXPECT_EQ(expected, actual);
34   }
35 
SetOutputStream(OutputStream & output_stream)36   void SetOutputStream(OutputStream& output_stream) {
37     output_stream_ = &output_stream;
38   }
39 
GenerateTestOutput()40   void GenerateTestOutput() {
41     EXPECT_EQ(3, output_stream_->Seek(3, kSeekCurrent));
42     CheckOffset(3);
43     EXPECT_EQ(2, output_stream_->Seek(2, kSeekSet));
44     CheckOffset(2);
45     uint8_t buf[] = { 1, 2, 3, 4, 5, 6, 7, 8, 9 };
46     EXPECT_TRUE(output_stream_->WriteFully(buf, 2));
47     CheckOffset(4);
48     EXPECT_EQ(6, output_stream_->Seek(2, kSeekEnd));
49     CheckOffset(6);
50     EXPECT_TRUE(output_stream_->WriteFully(buf, 4));
51     CheckOffset(10);
52     EXPECT_TRUE(output_stream_->WriteFully(buf, 6));
53     EXPECT_TRUE(output_stream_->Flush());
54   }
55 
CheckTestOutput(const std::vector<uint8_t> & actual)56   void CheckTestOutput(const std::vector<uint8_t>& actual) {
57     uint8_t expected[] = {
58         0, 0, 1, 2, 0, 0, 1, 2, 3, 4, 1, 2, 3, 4, 5, 6
59     };
60     EXPECT_EQ(sizeof(expected), actual.size());
61     EXPECT_EQ(0, memcmp(expected, &actual[0], actual.size()));
62   }
63 
64   OutputStream* output_stream_;
65 };
66 
TEST_F(OutputStreamTest,File)67 TEST_F(OutputStreamTest, File) {
68   ScratchFile tmp;
69   FileOutputStream output_stream(tmp.GetFile());
70   SetOutputStream(output_stream);
71   GenerateTestOutput();
72   std::unique_ptr<File> in(OS::OpenFileForReading(tmp.GetFilename().c_str()));
73   EXPECT_TRUE(in.get() != nullptr);
74   std::vector<uint8_t> actual(in->GetLength());
75   bool readSuccess = in->ReadFully(&actual[0], actual.size());
76   EXPECT_TRUE(readSuccess);
77   CheckTestOutput(actual);
78 }
79 
TEST_F(OutputStreamTest,Buffered)80 TEST_F(OutputStreamTest, Buffered) {
81   ScratchFile tmp;
82   {
83     BufferedOutputStream buffered_output_stream(std::make_unique<FileOutputStream>(tmp.GetFile()));
84     SetOutputStream(buffered_output_stream);
85     GenerateTestOutput();
86   }
87   std::unique_ptr<File> in(OS::OpenFileForReading(tmp.GetFilename().c_str()));
88   EXPECT_TRUE(in.get() != nullptr);
89   std::vector<uint8_t> actual(in->GetLength());
90   bool readSuccess = in->ReadFully(&actual[0], actual.size());
91   EXPECT_TRUE(readSuccess);
92   CheckTestOutput(actual);
93 }
94 
TEST_F(OutputStreamTest,Vector)95 TEST_F(OutputStreamTest, Vector) {
96   std::vector<uint8_t> output;
97   VectorOutputStream output_stream("test vector output", &output);
98   SetOutputStream(output_stream);
99   GenerateTestOutput();
100   CheckTestOutput(output);
101 }
102 
TEST_F(OutputStreamTest,BufferedFlush)103 TEST_F(OutputStreamTest, BufferedFlush) {
104   struct CheckingOutputStream : OutputStream {
105     CheckingOutputStream()
106         : OutputStream("dummy"),
107           flush_called(false) { }
108     ~CheckingOutputStream() override {}
109 
110     bool WriteFully(const void* buffer ATTRIBUTE_UNUSED,
111                     size_t byte_count ATTRIBUTE_UNUSED) override {
112       LOG(FATAL) << "UNREACHABLE";
113       UNREACHABLE();
114     }
115 
116     off_t Seek(off_t offset ATTRIBUTE_UNUSED, Whence whence ATTRIBUTE_UNUSED) override {
117       LOG(FATAL) << "UNREACHABLE";
118       UNREACHABLE();
119     }
120 
121     bool Flush() override {
122       flush_called = true;
123       return true;
124     }
125 
126     bool flush_called;
127   };
128 
129   std::unique_ptr<CheckingOutputStream> cos = std::make_unique<CheckingOutputStream>();
130   CheckingOutputStream* checking_output_stream = cos.get();
131   BufferedOutputStream buffered(std::move(cos));
132   ASSERT_FALSE(checking_output_stream->flush_called);
133   bool flush_result = buffered.Flush();
134   ASSERT_TRUE(flush_result);
135   ASSERT_TRUE(checking_output_stream->flush_called);
136 }
137 
138 }  // namespace linker
139 }  // namespace art
140