1 //===- llvm/unittest/Support/raw_ostream_test.cpp - raw_ostream tests -----===// 2 // 3 // The LLVM Compiler Infrastructure 4 // 5 // This file is distributed under the University of Illinois Open Source 6 // License. See LICENSE.TXT for details. 7 // 8 //===----------------------------------------------------------------------===// 9 10 #include "gtest/gtest.h" 11 #include "llvm/ADT/SmallString.h" 12 #include "llvm/Support/Format.h" 13 #include "llvm/Support/raw_ostream.h" 14 15 using namespace llvm; 16 17 namespace { 18 19 template<typename T> std::string printToString(const T &Value) { 20 std::string res; 21 llvm::raw_string_ostream(res) << Value; 22 return res; 23 } 24 25 /// printToString - Print the given value to a stream which only has \arg 26 /// BytesLeftInBuffer bytes left in the buffer. This is useful for testing edge 27 /// cases in the buffer handling logic. 28 template<typename T> std::string printToString(const T &Value, 29 unsigned BytesLeftInBuffer) { 30 // FIXME: This is relying on internal knowledge of how raw_ostream works to 31 // get the buffer position right. 32 SmallString<256> SVec; 33 assert(BytesLeftInBuffer < 256 && "Invalid buffer count!"); 34 llvm::raw_svector_ostream OS(SVec); 35 unsigned StartIndex = 256 - BytesLeftInBuffer; 36 for (unsigned i = 0; i != StartIndex; ++i) 37 OS << '?'; 38 OS << Value; 39 return OS.str().substr(StartIndex); 40 } 41 42 template<typename T> std::string printToStringUnbuffered(const T &Value) { 43 std::string res; 44 llvm::raw_string_ostream OS(res); 45 OS.SetUnbuffered(); 46 OS << Value; 47 return res; 48 } 49 50 TEST(raw_ostreamTest, Types_Buffered) { 51 // Char 52 EXPECT_EQ("c", printToString('c')); 53 54 // String 55 EXPECT_EQ("hello", printToString("hello")); 56 EXPECT_EQ("hello", printToString(std::string("hello"))); 57 58 // Int 59 EXPECT_EQ("0", printToString(0)); 60 EXPECT_EQ("2425", printToString(2425)); 61 EXPECT_EQ("-2425", printToString(-2425)); 62 63 // Long long 64 EXPECT_EQ("0", printToString(0LL)); 65 EXPECT_EQ("257257257235709", printToString(257257257235709LL)); 66 EXPECT_EQ("-257257257235709", printToString(-257257257235709LL)); 67 68 // Double 69 EXPECT_EQ("1.100000e+00", printToString(1.1)); 70 71 // void* 72 EXPECT_EQ("0x0", printToString((void*) nullptr)); 73 EXPECT_EQ("0xbeef", printToString((void*) 0xbeefLL)); 74 EXPECT_EQ("0xdeadbeef", printToString((void*) 0xdeadbeefLL)); 75 76 // Min and max. 77 EXPECT_EQ("18446744073709551615", printToString(UINT64_MAX)); 78 EXPECT_EQ("-9223372036854775808", printToString(INT64_MIN)); 79 } 80 81 TEST(raw_ostreamTest, Types_Unbuffered) { 82 // Char 83 EXPECT_EQ("c", printToStringUnbuffered('c')); 84 85 // String 86 EXPECT_EQ("hello", printToStringUnbuffered("hello")); 87 EXPECT_EQ("hello", printToStringUnbuffered(std::string("hello"))); 88 89 // Int 90 EXPECT_EQ("0", printToStringUnbuffered(0)); 91 EXPECT_EQ("2425", printToStringUnbuffered(2425)); 92 EXPECT_EQ("-2425", printToStringUnbuffered(-2425)); 93 94 // Long long 95 EXPECT_EQ("0", printToStringUnbuffered(0LL)); 96 EXPECT_EQ("257257257235709", printToStringUnbuffered(257257257235709LL)); 97 EXPECT_EQ("-257257257235709", printToStringUnbuffered(-257257257235709LL)); 98 99 // Double 100 EXPECT_EQ("1.100000e+00", printToStringUnbuffered(1.1)); 101 102 // void* 103 EXPECT_EQ("0x0", printToStringUnbuffered((void*) nullptr)); 104 EXPECT_EQ("0xbeef", printToStringUnbuffered((void*) 0xbeefLL)); 105 EXPECT_EQ("0xdeadbeef", printToStringUnbuffered((void*) 0xdeadbeefLL)); 106 107 // Min and max. 108 EXPECT_EQ("18446744073709551615", printToStringUnbuffered(UINT64_MAX)); 109 EXPECT_EQ("-9223372036854775808", printToStringUnbuffered(INT64_MIN)); 110 } 111 112 TEST(raw_ostreamTest, BufferEdge) { 113 EXPECT_EQ("1.20", printToString(format("%.2f", 1.2), 1)); 114 EXPECT_EQ("1.20", printToString(format("%.2f", 1.2), 2)); 115 EXPECT_EQ("1.20", printToString(format("%.2f", 1.2), 3)); 116 EXPECT_EQ("1.20", printToString(format("%.2f", 1.2), 4)); 117 EXPECT_EQ("1.20", printToString(format("%.2f", 1.2), 10)); 118 } 119 120 TEST(raw_ostreamTest, TinyBuffer) { 121 std::string Str; 122 raw_string_ostream OS(Str); 123 OS.SetBufferSize(1); 124 OS << "hello"; 125 OS << 1; 126 OS << 'w' << 'o' << 'r' << 'l' << 'd'; 127 EXPECT_EQ("hello1world", OS.str()); 128 } 129 130 TEST(raw_ostreamTest, WriteEscaped) { 131 std::string Str; 132 133 Str = ""; 134 raw_string_ostream(Str).write_escaped("hi"); 135 EXPECT_EQ("hi", Str); 136 137 Str = ""; 138 raw_string_ostream(Str).write_escaped("\\\t\n\""); 139 EXPECT_EQ("\\\\\\t\\n\\\"", Str); 140 141 Str = ""; 142 raw_string_ostream(Str).write_escaped("\1\10\200"); 143 EXPECT_EQ("\\001\\010\\200", Str); 144 } 145 146 TEST(raw_ostreamTest, Justify) { 147 EXPECT_EQ("xyz ", printToString(left_justify("xyz", 6), 6)); 148 EXPECT_EQ("abc", printToString(left_justify("abc", 3), 3)); 149 EXPECT_EQ("big", printToString(left_justify("big", 1), 3)); 150 EXPECT_EQ(" xyz", printToString(right_justify("xyz", 6), 6)); 151 EXPECT_EQ("abc", printToString(right_justify("abc", 3), 3)); 152 EXPECT_EQ("big", printToString(right_justify("big", 1), 3)); 153 } 154 155 TEST(raw_ostreamTest, FormatHex) { 156 EXPECT_EQ("0x1234", printToString(format_hex(0x1234, 6), 6)); 157 EXPECT_EQ("0x001234", printToString(format_hex(0x1234, 8), 8)); 158 EXPECT_EQ("0x00001234", printToString(format_hex(0x1234, 10), 10)); 159 EXPECT_EQ("0x1234", printToString(format_hex(0x1234, 4), 6)); 160 EXPECT_EQ("0xff", printToString(format_hex(255, 4), 4)); 161 EXPECT_EQ("0xFF", printToString(format_hex(255, 4, true), 4)); 162 EXPECT_EQ("0x1", printToString(format_hex(1, 3), 3)); 163 EXPECT_EQ("0x12", printToString(format_hex(0x12, 3), 4)); 164 EXPECT_EQ("0x123", printToString(format_hex(0x123, 3), 5)); 165 EXPECT_EQ("FF", printToString(format_hex_no_prefix(0xFF, 2, true), 4)); 166 EXPECT_EQ("ABCD", printToString(format_hex_no_prefix(0xABCD, 2, true), 4)); 167 EXPECT_EQ("0xffffffffffffffff", 168 printToString(format_hex(UINT64_MAX, 18), 18)); 169 EXPECT_EQ("0x8000000000000000", 170 printToString(format_hex((INT64_MIN), 18), 18)); 171 } 172 173 TEST(raw_ostreamTest, FormatDecimal) { 174 EXPECT_EQ(" 0", printToString(format_decimal(0, 4), 4)); 175 EXPECT_EQ(" -1", printToString(format_decimal(-1, 4), 4)); 176 EXPECT_EQ(" -1", printToString(format_decimal(-1, 6), 6)); 177 EXPECT_EQ("1234567890", printToString(format_decimal(1234567890, 10), 10)); 178 EXPECT_EQ(" 9223372036854775807", 179 printToString(format_decimal(INT64_MAX, 21), 21)); 180 EXPECT_EQ(" -9223372036854775808", 181 printToString(format_decimal(INT64_MIN, 21), 21)); 182 } 183 184 static std::string formatted_bytes_str(ArrayRef<uint8_t> Bytes, 185 llvm::Optional<uint64_t> Offset = None, 186 uint32_t NumPerLine = 16, 187 uint8_t ByteGroupSize = 4) { 188 std::string S; 189 raw_string_ostream Str(S); 190 Str << format_bytes(Bytes, Offset, NumPerLine, ByteGroupSize); 191 Str.flush(); 192 return S; 193 } 194 195 static std::string format_bytes_with_ascii_str(ArrayRef<uint8_t> Bytes, 196 Optional<uint64_t> Offset = None, 197 uint32_t NumPerLine = 16, 198 uint8_t ByteGroupSize = 4) { 199 std::string S; 200 raw_string_ostream Str(S); 201 Str << format_bytes_with_ascii(Bytes, Offset, NumPerLine, ByteGroupSize); 202 Str.flush(); 203 return S; 204 } 205 206 TEST(raw_ostreamTest, FormattedHexBytes) { 207 std::vector<uint8_t> Buf = {'a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 208 'j', 'k', 'l', 'm', 'n', 'o', 'p', 'q', 'r', 209 's', 't', 'u', 'v', 'w', 'x', 'y', 'z', '0', 210 '1', '2', '3', '4', '5', '6', '7', '8', '9'}; 211 ArrayRef<uint8_t> B(Buf); 212 213 // Test invalid input. 214 EXPECT_EQ("", formatted_bytes_str(ArrayRef<uint8_t>())); 215 EXPECT_EQ("", format_bytes_with_ascii_str(ArrayRef<uint8_t>())); 216 //---------------------------------------------------------------------- 217 // Test hex byte output with the default 4 byte groups 218 //---------------------------------------------------------------------- 219 EXPECT_EQ("61", formatted_bytes_str(B.take_front())); 220 EXPECT_EQ("61626364 65", formatted_bytes_str(B.take_front(5))); 221 // Test that 16 bytes get written to a line correctly. 222 EXPECT_EQ("61626364 65666768 696a6b6c 6d6e6f70", 223 formatted_bytes_str(B.take_front(16))); 224 // Test raw bytes with default 16 bytes per line wrapping. 225 EXPECT_EQ("61626364 65666768 696a6b6c 6d6e6f70\n71", 226 formatted_bytes_str(B.take_front(17))); 227 // Test raw bytes with 1 bytes per line wrapping. 228 EXPECT_EQ("61\n62\n63\n64\n65\n66", 229 formatted_bytes_str(B.take_front(6), None, 1)); 230 // Test raw bytes with 7 bytes per line wrapping. 231 EXPECT_EQ("61626364 656667\n68696a6b 6c6d6e\n6f7071", 232 formatted_bytes_str(B.take_front(17), None, 7)); 233 // Test raw bytes with 8 bytes per line wrapping. 234 EXPECT_EQ("61626364 65666768\n696a6b6c 6d6e6f70\n71", 235 formatted_bytes_str(B.take_front(17), None, 8)); 236 //---------------------------------------------------------------------- 237 // Test hex byte output with the 1 byte groups 238 //---------------------------------------------------------------------- 239 EXPECT_EQ("61 62 63 64 65", 240 formatted_bytes_str(B.take_front(5), None, 16, 1)); 241 // Test that 16 bytes get written to a line correctly. 242 EXPECT_EQ("61 62 63 64 65 66 67 68 69 6a 6b 6c 6d 6e 6f 70", 243 formatted_bytes_str(B.take_front(16), None, 16, 1)); 244 // Test raw bytes with default 16 bytes per line wrapping. 245 EXPECT_EQ("61 62 63 64 65 66 67 68 69 6a 6b 6c 6d 6e 6f 70\n71", 246 formatted_bytes_str(B.take_front(17), None, 16, 1)); 247 // Test raw bytes with 7 bytes per line wrapping. 248 EXPECT_EQ("61 62 63 64 65 66 67\n68 69 6a 6b 6c 6d 6e\n6f 70 71", 249 formatted_bytes_str(B.take_front(17), None, 7, 1)); 250 // Test raw bytes with 8 bytes per line wrapping. 251 EXPECT_EQ("61 62 63 64 65 66 67 68\n69 6a 6b 6c 6d 6e 6f 70\n71", 252 formatted_bytes_str(B.take_front(17), None, 8, 1)); 253 254 //---------------------------------------------------------------------- 255 // Test hex byte output with the 2 byte groups 256 //---------------------------------------------------------------------- 257 EXPECT_EQ("6162 6364 65", formatted_bytes_str(B.take_front(5), None, 16, 2)); 258 // Test that 16 bytes get written to a line correctly. 259 EXPECT_EQ("6162 6364 6566 6768 696a 6b6c 6d6e 6f70", 260 formatted_bytes_str(B.take_front(16), None, 16, 2)); 261 // Test raw bytes with default 16 bytes per line wrapping. 262 EXPECT_EQ("6162 6364 6566 6768 696a 6b6c 6d6e 6f70\n71", 263 formatted_bytes_str(B.take_front(17), None, 16, 2)); 264 // Test raw bytes with 7 bytes per line wrapping. 265 EXPECT_EQ("6162 6364 6566 67\n6869 6a6b 6c6d 6e\n6f70 71", 266 formatted_bytes_str(B.take_front(17), None, 7, 2)); 267 // Test raw bytes with 8 bytes per line wrapping. 268 EXPECT_EQ("6162 6364 6566 6768\n696a 6b6c 6d6e 6f70\n71", 269 formatted_bytes_str(B.take_front(17), None, 8, 2)); 270 271 //---------------------------------------------------------------------- 272 // Test hex bytes with offset with the default 4 byte groups. 273 //---------------------------------------------------------------------- 274 EXPECT_EQ("0000: 61", formatted_bytes_str(B.take_front(), 0x0)); 275 EXPECT_EQ("1000: 61", formatted_bytes_str(B.take_front(), 0x1000)); 276 EXPECT_EQ("1000: 61\n1001: 62", 277 formatted_bytes_str(B.take_front(2), 0x1000, 1)); 278 //---------------------------------------------------------------------- 279 // Test hex bytes with ASCII with the default 4 byte groups. 280 //---------------------------------------------------------------------- 281 EXPECT_EQ("61626364 65666768 696a6b6c 6d6e6f70 |abcdefghijklmnop|", 282 format_bytes_with_ascii_str(B.take_front(16))); 283 EXPECT_EQ("61626364 65666768 |abcdefgh|\n" 284 "696a6b6c 6d6e6f70 |ijklmnop|", 285 format_bytes_with_ascii_str(B.take_front(16), None, 8)); 286 EXPECT_EQ("61626364 65666768 |abcdefgh|\n696a6b6c |ijkl|", 287 format_bytes_with_ascii_str(B.take_front(12), None, 8)); 288 std::vector<uint8_t> Unprintable = {'a', '\x1e', 'b', '\x1f'}; 289 // Make sure the ASCII is still lined up correctly when fewer bytes than 16 290 // bytes per line are available. The ASCII should still be aligned as if 16 291 // bytes of hex might be displayed. 292 EXPECT_EQ("611e621f |a.b.|", 293 format_bytes_with_ascii_str(Unprintable)); 294 //---------------------------------------------------------------------- 295 // Test hex bytes with ASCII with offsets with the default 4 byte groups. 296 //---------------------------------------------------------------------- 297 EXPECT_EQ("0000: 61626364 65666768 " 298 "696a6b6c 6d6e6f70 |abcdefghijklmnop|", 299 format_bytes_with_ascii_str(B.take_front(16), 0)); 300 EXPECT_EQ("0000: 61626364 65666768 |abcdefgh|\n" 301 "0008: 696a6b6c 6d6e6f70 |ijklmnop|", 302 format_bytes_with_ascii_str(B.take_front(16), 0, 8)); 303 EXPECT_EQ("0000: 61626364 656667 |abcdefg|\n" 304 "0007: 68696a6b 6c |hijkl|", 305 format_bytes_with_ascii_str(B.take_front(12), 0, 7)); 306 307 //---------------------------------------------------------------------- 308 // Test hex bytes with ASCII with offsets with the default 2 byte groups. 309 //---------------------------------------------------------------------- 310 EXPECT_EQ("0000: 6162 6364 6566 6768 " 311 "696a 6b6c 6d6e 6f70 |abcdefghijklmnop|", 312 format_bytes_with_ascii_str(B.take_front(16), 0, 16, 2)); 313 EXPECT_EQ("0000: 6162 6364 6566 6768 |abcdefgh|\n" 314 "0008: 696a 6b6c 6d6e 6f70 |ijklmnop|", 315 format_bytes_with_ascii_str(B.take_front(16), 0, 8, 2)); 316 EXPECT_EQ("0000: 6162 6364 6566 67 |abcdefg|\n" 317 "0007: 6869 6a6b 6c |hijkl|", 318 format_bytes_with_ascii_str(B.take_front(12), 0, 7, 2)); 319 320 //---------------------------------------------------------------------- 321 // Test hex bytes with ASCII with offsets with the default 1 byte groups. 322 //---------------------------------------------------------------------- 323 EXPECT_EQ("0000: 61 62 63 64 65 66 67 68 " 324 "69 6a 6b 6c 6d 6e 6f 70 |abcdefghijklmnop|", 325 format_bytes_with_ascii_str(B.take_front(16), 0, 16, 1)); 326 EXPECT_EQ("0000: 61 62 63 64 65 66 67 68 |abcdefgh|\n" 327 "0008: 69 6a 6b 6c 6d 6e 6f 70 |ijklmnop|", 328 format_bytes_with_ascii_str(B.take_front(16), 0, 8, 1)); 329 EXPECT_EQ("0000: 61 62 63 64 65 66 67 |abcdefg|\n" 330 "0007: 68 69 6a 6b 6c |hijkl|", 331 format_bytes_with_ascii_str(B.take_front(12), 0, 7, 1)); 332 } 333 } 334