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 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605
use alloc::boxed::Box;
use alloc::vec::Vec;
use crate::common::{Encoding, Register};
use crate::constants::{self, DwOp};
use crate::leb128::write::{sleb128_size, uleb128_size};
use crate::write::{
Address, DebugInfoReference, Error, Reference, Result, UnitEntryId, UnitOffsets, Writer,
};
/// The bytecode for a DWARF expression or location description.
#[derive(Debug, Default, Clone, PartialEq, Eq, Hash)]
pub struct Expression {
operations: Vec<Operation>,
}
impl Expression {
/// Create an empty expression.
#[inline]
pub fn new() -> Self {
Self::default()
}
/// Create an expression from raw bytecode.
///
/// This does not support operations that require references, such as `DW_OP_addr`.
#[inline]
pub fn raw(bytecode: Vec<u8>) -> Self {
Expression {
operations: vec![Operation::Raw(bytecode)],
}
}
/// Add an operation to the expression.
///
/// This should only be used for operations that have no explicit operands.
pub fn op(&mut self, opcode: DwOp) {
self.operations.push(Operation::Simple(opcode));
}
/// Add a `DW_OP_addr` operation to the expression.
pub fn op_addr(&mut self, address: Address) {
self.operations.push(Operation::Address(address));
}
/// Add a `DW_OP_constu` operation to the expression.
///
/// This may be emitted as a smaller equivalent operation.
pub fn op_constu(&mut self, value: u64) {
self.operations.push(Operation::UnsignedConstant(value));
}
/// Add a `DW_OP_consts` operation to the expression.
///
/// This may be emitted as a smaller equivalent operation.
pub fn op_consts(&mut self, value: i64) {
self.operations.push(Operation::SignedConstant(value));
}
/// Add a `DW_OP_const_type` or `DW_OP_GNU_const_type` operation to the expression.
pub fn op_const_type(&mut self, base: UnitEntryId, value: Box<[u8]>) {
self.operations.push(Operation::ConstantType(base, value));
}
/// Add a `DW_OP_fbreg` operation to the expression.
pub fn op_fbreg(&mut self, offset: i64) {
self.operations.push(Operation::FrameOffset(offset));
}
/// Add a `DW_OP_bregx` operation to the expression.
///
/// This may be emitted as a smaller equivalent operation.
pub fn op_breg(&mut self, register: Register, offset: i64) {
self.operations
.push(Operation::RegisterOffset(register, offset));
}
/// Add a `DW_OP_regval_type` or `DW_OP_GNU_regval_type` operation to the expression.
///
/// This may be emitted as a smaller equivalent operation.
pub fn op_regval_type(&mut self, register: Register, base: UnitEntryId) {
self.operations
.push(Operation::RegisterType(register, base));
}
/// Add a `DW_OP_pick` operation to the expression.
///
/// This may be emitted as a `DW_OP_dup` or `DW_OP_over` operation.
pub fn op_pick(&mut self, index: u8) {
self.operations.push(Operation::Pick(index));
}
/// Add a `DW_OP_deref` operation to the expression.
pub fn op_deref(&mut self) {
self.operations.push(Operation::Deref { space: false });
}
/// Add a `DW_OP_xderef` operation to the expression.
pub fn op_xderef(&mut self) {
self.operations.push(Operation::Deref { space: true });
}
/// Add a `DW_OP_deref_size` operation to the expression.
pub fn op_deref_size(&mut self, size: u8) {
self.operations
.push(Operation::DerefSize { size, space: false });
}
/// Add a `DW_OP_xderef_size` operation to the expression.
pub fn op_xderef_size(&mut self, size: u8) {
self.operations
.push(Operation::DerefSize { size, space: true });
}
/// Add a `DW_OP_deref_type` or `DW_OP_GNU_deref_type` operation to the expression.
pub fn op_deref_type(&mut self, size: u8, base: UnitEntryId) {
self.operations.push(Operation::DerefType {
size,
base,
space: false,
});
}
/// Add a `DW_OP_xderef_type` operation to the expression.
pub fn op_xderef_type(&mut self, size: u8, base: UnitEntryId) {
self.operations.push(Operation::DerefType {
size,
base,
space: true,
});
}
/// Add a `DW_OP_plus_uconst` operation to the expression.
pub fn op_plus_uconst(&mut self, value: u64) {
self.operations.push(Operation::PlusConstant(value));
}
/// Add a `DW_OP_skip` operation to the expression.
///
/// Returns the index of the operation. The caller must call `set_target` with
/// this index to set the target of the branch.
pub fn op_skip(&mut self) -> usize {
let index = self.next_index();
self.operations.push(Operation::Skip(!0));
index
}
/// Add a `DW_OP_bra` operation to the expression.
///
/// Returns the index of the operation. The caller must call `set_target` with
/// this index to set the target of the branch.
pub fn op_bra(&mut self) -> usize {
let index = self.next_index();
self.operations.push(Operation::Branch(!0));
index
}
/// Return the index that will be assigned to the next operation.
///
/// This can be passed to `set_target`.
#[inline]
pub fn next_index(&self) -> usize {
self.operations.len()
}
/// Set the target of a `DW_OP_skip` or `DW_OP_bra` operation .
pub fn set_target(&mut self, operation: usize, new_target: usize) {
debug_assert!(new_target <= self.next_index());
debug_assert_ne!(operation, new_target);
match self.operations[operation] {
Operation::Skip(ref mut target) | Operation::Branch(ref mut target) => {
*target = new_target;
}
_ => unimplemented!(),
}
}
/// Add a `DW_OP_call4` operation to the expression.
pub fn op_call(&mut self, entry: UnitEntryId) {
self.operations.push(Operation::Call(entry));
}
/// Add a `DW_OP_call_ref` operation to the expression.
pub fn op_call_ref(&mut self, entry: Reference) {
self.operations.push(Operation::CallRef(entry));
}
/// Add a `DW_OP_convert` or `DW_OP_GNU_convert` operation to the expression.
///
/// `base` is the DIE of the base type, or `None` for the generic type.
pub fn op_convert(&mut self, base: Option<UnitEntryId>) {
self.operations.push(Operation::Convert(base));
}
/// Add a `DW_OP_reinterpret` or `DW_OP_GNU_reinterpret` operation to the expression.
///
/// `base` is the DIE of the base type, or `None` for the generic type.
pub fn op_reinterpret(&mut self, base: Option<UnitEntryId>) {
self.operations.push(Operation::Reinterpret(base));
}
/// Add a `DW_OP_entry_value` or `DW_OP_GNU_entry_value` operation to the expression.
pub fn op_entry_value(&mut self, expression: Expression) {
self.operations.push(Operation::EntryValue(expression));
}
/// Add a `DW_OP_regx` operation to the expression.
///
/// This may be emitted as a smaller equivalent operation.
pub fn op_reg(&mut self, register: Register) {
self.operations.push(Operation::Register(register));
}
/// Add a `DW_OP_implicit_value` operation to the expression.
pub fn op_implicit_value(&mut self, data: Box<[u8]>) {
self.operations.push(Operation::ImplicitValue(data));
}
/// Add a `DW_OP_implicit_pointer` or `DW_OP_GNU_implicit_pointer` operation to the expression.
pub fn op_implicit_pointer(&mut self, entry: Reference, byte_offset: i64) {
self.operations
.push(Operation::ImplicitPointer { entry, byte_offset });
}
/// Add a `DW_OP_piece` operation to the expression.
pub fn op_piece(&mut self, size_in_bytes: u64) {
self.operations.push(Operation::Piece { size_in_bytes });
}
/// Add a `DW_OP_bit_piece` operation to the expression.
pub fn op_bit_piece(&mut self, size_in_bits: u64, bit_offset: u64) {
self.operations.push(Operation::BitPiece {
size_in_bits,
bit_offset,
});
}
/// Add a `DW_OP_GNU_parameter_ref` operation to the expression.
pub fn op_gnu_parameter_ref(&mut self, entry: UnitEntryId) {
self.operations.push(Operation::ParameterRef(entry));
}
/// Add a `DW_OP_WASM_location 0x0` operation to the expression.
pub fn op_wasm_local(&mut self, index: u32) {
self.operations.push(Operation::WasmLocal(index));
}
/// Add a `DW_OP_WASM_location 0x1` operation to the expression.
pub fn op_wasm_global(&mut self, index: u32) {
self.operations.push(Operation::WasmGlobal(index));
}
/// Add a `DW_OP_WASM_location 0x2` operation to the expression.
pub fn op_wasm_stack(&mut self, index: u32) {
self.operations.push(Operation::WasmStack(index));
}
pub(crate) fn size(&self, encoding: Encoding, unit_offsets: Option<&UnitOffsets>) -> usize {
let mut size = 0;
for operation in &self.operations {
size += operation.size(encoding, unit_offsets);
}
size
}
pub(crate) fn write<W: Writer>(
&self,
w: &mut W,
mut refs: Option<&mut Vec<DebugInfoReference>>,
encoding: Encoding,
unit_offsets: Option<&UnitOffsets>,
) -> Result<()> {
// TODO: only calculate offsets if needed?
let mut offsets = Vec::with_capacity(self.operations.len());
let mut offset = w.len();
for operation in &self.operations {
offsets.push(offset);
offset += operation.size(encoding, unit_offsets);
}
offsets.push(offset);
for (operation, offset) in self.operations.iter().zip(offsets.iter().copied()) {
debug_assert_eq!(w.len(), offset);
operation.write(w, refs.as_deref_mut(), encoding, unit_offsets, &offsets)?;
}
Ok(())
}
}
/// A single DWARF operation.
//
// This type is intentionally not public so that we can change the
// representation of expressions as needed.
//
// Variants are listed in the order they appear in Section 2.5.
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
enum Operation {
/// Raw bytecode.
///
/// Does not support references.
Raw(Vec<u8>),
/// An operation that has no explicit operands.
///
/// Represents:
/// - `DW_OP_drop`, `DW_OP_swap`, `DW_OP_rot`
/// - `DW_OP_push_object_address`, `DW_OP_form_tls_address`, `DW_OP_call_frame_cfa`
/// - `DW_OP_abs`, `DW_OP_and`, `DW_OP_div`, `DW_OP_minus`, `DW_OP_mod`, `DW_OP_mul`,
/// `DW_OP_neg`, `DW_OP_not`, `DW_OP_or`, `DW_OP_plus`, `DW_OP_shl`, `DW_OP_shr`,
/// `DW_OP_shra`, `DW_OP_xor`
/// - `DW_OP_le`, `DW_OP_ge`, `DW_OP_eq`, `DW_OP_lt`, `DW_OP_gt`, `DW_OP_ne`
/// - `DW_OP_nop`
/// - `DW_OP_stack_value`
Simple(DwOp),
/// Relocate the address if needed, and push it on the stack.
///
/// Represents `DW_OP_addr`.
Address(Address),
/// Push an unsigned constant value on the stack.
///
/// Represents `DW_OP_constu`.
UnsignedConstant(u64),
/// Push a signed constant value on the stack.
///
/// Represents `DW_OP_consts`.
SignedConstant(i64),
/* TODO: requires .debug_addr write support
/// Read the address at the given index in `.debug_addr, relocate the address if needed,
/// and push it on the stack.
///
/// Represents `DW_OP_addrx`.
AddressIndex(DebugAddrIndex<Offset>),
/// Read the address at the given index in `.debug_addr, and push it on the stack.
/// Do not relocate the address.
///
/// Represents `DW_OP_constx`.
ConstantIndex(DebugAddrIndex<Offset>),
*/
/// Interpret the value bytes as a constant of a given type, and push it on the stack.
///
/// Represents `DW_OP_const_type`.
ConstantType(UnitEntryId, Box<[u8]>),
/// Compute the frame base (using `DW_AT_frame_base`), add the
/// given offset, and then push the resulting sum on the stack.
///
/// Represents `DW_OP_fbreg`.
FrameOffset(i64),
/// Find the contents of the given register, add the offset, and then
/// push the resulting sum on the stack.
///
/// Represents `DW_OP_bregx`.
RegisterOffset(Register, i64),
/// Interpret the contents of the given register as a value of the given type,
/// and push it on the stack.
///
/// Represents `DW_OP_regval_type`.
RegisterType(Register, UnitEntryId),
/// Copy the item at a stack index and push it on top of the stack.
///
/// Represents `DW_OP_pick`, `DW_OP_dup`, and `DW_OP_over`.
Pick(u8),
/// Pop the topmost value of the stack, dereference it, and push the
/// resulting value.
///
/// Represents `DW_OP_deref` and `DW_OP_xderef`.
Deref {
/// True if the dereference operation takes an address space
/// argument from the stack; false otherwise.
space: bool,
},
/// Pop the topmost value of the stack, dereference it to obtain a value
/// of the given size, and push the resulting value.
///
/// Represents `DW_OP_deref_size` and `DW_OP_xderef_size`.
DerefSize {
/// True if the dereference operation takes an address space
/// argument from the stack; false otherwise.
space: bool,
/// The size of the data to dereference.
size: u8,
},
/// Pop the topmost value of the stack, dereference it to obtain a value
/// of the given type, and push the resulting value.
///
/// Represents `DW_OP_deref_type` and `DW_OP_xderef_type`.
DerefType {
/// True if the dereference operation takes an address space
/// argument from the stack; false otherwise.
space: bool,
/// The size of the data to dereference.
size: u8,
/// The DIE of the base type, or `None` for the generic type.
base: UnitEntryId,
},
/// Add an unsigned constant to the topmost value on the stack.
///
/// Represents `DW_OP_plus_uconst`.
PlusConstant(u64),
/// Unconditional branch to the target location.
///
/// The value is the index within the expression of the operation to branch to.
/// This will be converted to a relative offset when writing.
///
/// Represents `DW_OP_skip`.
Skip(usize),
/// Branch to the target location if the top of stack is nonzero.
///
/// The value is the index within the expression of the operation to branch to.
/// This will be converted to a relative offset when writing.
///
/// Represents `DW_OP_bra`.
Branch(usize),
/// Evaluate a DWARF expression as a subroutine.
///
/// The expression comes from the `DW_AT_location` attribute of the indicated DIE.
///
/// Represents `DW_OP_call4`.
Call(UnitEntryId),
/// Evaluate an external DWARF expression as a subroutine.
///
/// The expression comes from the `DW_AT_location` attribute of the indicated DIE,
/// which may be in another compilation unit or shared object.
///
/// Represents `DW_OP_call_ref`.
CallRef(Reference),
/// Pop the top stack entry, convert it to a different type, and push it on the stack.
///
/// Represents `DW_OP_convert`.
Convert(Option<UnitEntryId>),
/// Pop the top stack entry, reinterpret the bits in its value as a different type,
/// and push it on the stack.
///
/// Represents `DW_OP_reinterpret`.
Reinterpret(Option<UnitEntryId>),
/// Evaluate an expression at the entry to the current subprogram, and push it on the stack.
///
/// Represents `DW_OP_entry_value`.
EntryValue(Expression),
// FIXME: EntryRegister
/// Indicate that this piece's location is in the given register.
///
/// Completes the piece or expression.
///
/// Represents `DW_OP_regx`.
Register(Register),
/// The object has no location, but has a known constant value.
///
/// Completes the piece or expression.
///
/// Represents `DW_OP_implicit_value`.
ImplicitValue(Box<[u8]>),
/// The object is a pointer to a value which has no actual location, such as
/// an implicit value or a stack value.
///
/// Completes the piece or expression.
///
/// Represents `DW_OP_implicit_pointer`.
ImplicitPointer {
/// The DIE of the value that this is an implicit pointer into.
entry: Reference,
/// The byte offset into the value that the implicit pointer points to.
byte_offset: i64,
},
/// Terminate a piece.
///
/// Represents `DW_OP_piece`.
Piece {
/// The size of this piece in bytes.
size_in_bytes: u64,
},
/// Terminate a piece with a size in bits.
///
/// Represents `DW_OP_bit_piece`.
BitPiece {
/// The size of this piece in bits.
size_in_bits: u64,
/// The bit offset of this piece.
bit_offset: u64,
},
/// This represents a parameter that was optimized out.
///
/// The entry is the definition of the parameter, and is matched to
/// the `DW_TAG_GNU_call_site_parameter` in the caller that also
/// points to the same definition of the parameter.
///
/// Represents `DW_OP_GNU_parameter_ref`.
ParameterRef(UnitEntryId),
/// The index of a local in the currently executing function.
///
/// Represents `DW_OP_WASM_location 0x00`.
WasmLocal(u32),
/// The index of a global.
///
/// Represents `DW_OP_WASM_location 0x01`.
WasmGlobal(u32),
/// The index of an item on the operand stack.
///
/// Represents `DW_OP_WASM_location 0x02`.
WasmStack(u32),
}
impl Operation {
fn size(&self, encoding: Encoding, unit_offsets: Option<&UnitOffsets>) -> usize {
let base_size = |base| {
// Errors are handled during writes.
match unit_offsets {
Some(offsets) => uleb128_size(offsets.unit_offset(base)),
None => 0,
}
};
1 + match *self {
Operation::Raw(ref bytecode) => return bytecode.len(),
Operation::Simple(_) => 0,
Operation::Address(_) => encoding.address_size as usize,
Operation::UnsignedConstant(value) => {
if value < 32 {
0
} else {
uleb128_size(value)
}
}
Operation::SignedConstant(value) => sleb128_size(value),
Operation::ConstantType(base, ref value) => base_size(base) + 1 + value.len(),
Operation::FrameOffset(offset) => sleb128_size(offset),
Operation::RegisterOffset(register, offset) => {
if register.0 < 32 {
sleb128_size(offset)
} else {
uleb128_size(register.0.into()) + sleb128_size(offset)
}
}
Operation::RegisterType(register, base) => {
uleb128_size(register.0.into()) + base_size(base)
}
Operation::Pick(index) => {
if index > 1 {
1
} else {
0
}
}
Operation::Deref { .. } => 0,
Operation::DerefSize { .. } => 1,
Operation::DerefType { base, .. } => 1 + base_size(base),
Operation::PlusConstant(value) => uleb128_size(value),
Operation::Skip(_) => 2,
Operation::Branch(_) => 2,
Operation::Call(_) => 4,
Operation::CallRef(_) => encoding.format.word_size() as usize,
Operation::Convert(base) => match base {
Some(base) => base_size(base),
None => 1,
},
Operation::Reinterpret(base) => match base {
Some(base) => base_size(base),
None => 1,
},
Operation::EntryValue(ref expression) => {
let length = expression.size(encoding, unit_offsets);
uleb128_size(length as u64) + length
}
Operation::Register(register) => {
if register.0 < 32 {
0
} else {
uleb128_size(register.0.into())
}
}
Operation::ImplicitValue(ref data) => uleb128_size(data.len() as u64) + data.len(),
Operation::ImplicitPointer { byte_offset, .. } => {
let size = if encoding.version == 2 {
encoding.address_size
} else {
encoding.format.word_size()
};
size as usize + sleb128_size(byte_offset)
}
Operation::Piece { size_in_bytes } => uleb128_size(size_in_bytes),
Operation::BitPiece {
size_in_bits,
bit_offset,
} => uleb128_size(size_in_bits) + uleb128_size(bit_offset),
Operation::ParameterRef(_) => 4,
Operation::WasmLocal(index)
| Operation::WasmGlobal(index)
| Operation::WasmStack(index) => 1 + uleb128_size(index.into()),
}
}
pub(crate) fn write<W: Writer>(
&self,
w: &mut W,
refs: Option<&mut Vec<DebugInfoReference>>,
encoding: Encoding,
unit_offsets: Option<&UnitOffsets>,
offsets: &[usize],
) -> Result<()> {
let entry_offset = |entry| match unit_offsets {
Some(offsets) => {
let offset = offsets.unit_offset(entry);
if offset == 0 {
Err(Error::UnsupportedExpressionForwardReference)
} else {
Ok(offset)
}
}
None => Err(Error::UnsupportedCfiExpressionReference),
};
match *self {
Operation::Raw(ref bytecode) => w.write(bytecode)?,
Operation::Simple(opcode) => w.write_u8(opcode.0)?,
Operation::Address(address) => {
w.write_u8(constants::DW_OP_addr.0)?;
w.write_address(address, encoding.address_size)?;
}
Operation::UnsignedConstant(value) => {
if value < 32 {
w.write_u8(constants::DW_OP_lit0.0 + value as u8)?;
} else {
w.write_u8(constants::DW_OP_constu.0)?;
w.write_uleb128(value)?;
}
}
Operation::SignedConstant(value) => {
w.write_u8(constants::DW_OP_consts.0)?;
w.write_sleb128(value)?;
}
Operation::ConstantType(base, ref value) => {
if encoding.version >= 5 {
w.write_u8(constants::DW_OP_const_type.0)?;
} else {
w.write_u8(constants::DW_OP_GNU_const_type.0)?;
}
w.write_uleb128(entry_offset(base)?)?;
w.write_udata(value.len() as u64, 1)?;
w.write(value)?;
}
Operation::FrameOffset(offset) => {
w.write_u8(constants::DW_OP_fbreg.0)?;
w.write_sleb128(offset)?;
}
Operation::RegisterOffset(register, offset) => {
if register.0 < 32 {
w.write_u8(constants::DW_OP_breg0.0 + register.0 as u8)?;
} else {
w.write_u8(constants::DW_OP_bregx.0)?;
w.write_uleb128(register.0.into())?;
}
w.write_sleb128(offset)?;
}
Operation::RegisterType(register, base) => {
if encoding.version >= 5 {
w.write_u8(constants::DW_OP_regval_type.0)?;
} else {
w.write_u8(constants::DW_OP_GNU_regval_type.0)?;
}
w.write_uleb128(register.0.into())?;
w.write_uleb128(entry_offset(base)?)?;
}
Operation::Pick(index) => match index {
0 => w.write_u8(constants::DW_OP_dup.0)?,
1 => w.write_u8(constants::DW_OP_over.0)?,
_ => {
w.write_u8(constants::DW_OP_pick.0)?;
w.write_u8(index)?;
}
},
Operation::Deref { space } => {
if space {
w.write_u8(constants::DW_OP_xderef.0)?;
} else {
w.write_u8(constants::DW_OP_deref.0)?;
}
}
Operation::DerefSize { space, size } => {
if space {
w.write_u8(constants::DW_OP_xderef_size.0)?;
} else {
w.write_u8(constants::DW_OP_deref_size.0)?;
}
w.write_u8(size)?;
}
Operation::DerefType { space, size, base } => {
if space {
w.write_u8(constants::DW_OP_xderef_type.0)?;
} else {
if encoding.version >= 5 {
w.write_u8(constants::DW_OP_deref_type.0)?;
} else {
w.write_u8(constants::DW_OP_GNU_deref_type.0)?;
}
}
w.write_u8(size)?;
w.write_uleb128(entry_offset(base)?)?;
}
Operation::PlusConstant(value) => {
w.write_u8(constants::DW_OP_plus_uconst.0)?;
w.write_uleb128(value)?;
}
Operation::Skip(target) => {
w.write_u8(constants::DW_OP_skip.0)?;
let offset = offsets[target] as i64 - (w.len() as i64 + 2);
w.write_sdata(offset, 2)?;
}
Operation::Branch(target) => {
w.write_u8(constants::DW_OP_bra.0)?;
let offset = offsets[target] as i64 - (w.len() as i64 + 2);
w.write_sdata(offset, 2)?;
}
Operation::Call(entry) => {
w.write_u8(constants::DW_OP_call4.0)?;
// TODO: this probably won't work in practice, because we may
// only know the offsets of base type DIEs at this point.
w.write_udata(entry_offset(entry)?, 4)?;
}
Operation::CallRef(entry) => {
w.write_u8(constants::DW_OP_call_ref.0)?;
let size = encoding.format.word_size();
match entry {
Reference::Symbol(symbol) => w.write_reference(symbol, size)?,
Reference::Entry(unit, entry) => {
let refs = refs.ok_or(Error::InvalidReference)?;
refs.push(DebugInfoReference {
offset: w.len(),
unit,
entry,
size,
});
w.write_udata(0, size)?;
}
}
}
Operation::Convert(base) => {
if encoding.version >= 5 {
w.write_u8(constants::DW_OP_convert.0)?;
} else {
w.write_u8(constants::DW_OP_GNU_convert.0)?;
}
match base {
Some(base) => w.write_uleb128(entry_offset(base)?)?,
None => w.write_u8(0)?,
}
}
Operation::Reinterpret(base) => {
if encoding.version >= 5 {
w.write_u8(constants::DW_OP_reinterpret.0)?;
} else {
w.write_u8(constants::DW_OP_GNU_reinterpret.0)?;
}
match base {
Some(base) => w.write_uleb128(entry_offset(base)?)?,
None => w.write_u8(0)?,
}
}
Operation::EntryValue(ref expression) => {
if encoding.version >= 5 {
w.write_u8(constants::DW_OP_entry_value.0)?;
} else {
w.write_u8(constants::DW_OP_GNU_entry_value.0)?;
}
let length = expression.size(encoding, unit_offsets);
w.write_uleb128(length as u64)?;
expression.write(w, refs, encoding, unit_offsets)?;
}
Operation::Register(register) => {
if register.0 < 32 {
w.write_u8(constants::DW_OP_reg0.0 + register.0 as u8)?;
} else {
w.write_u8(constants::DW_OP_regx.0)?;
w.write_uleb128(register.0.into())?;
}
}
Operation::ImplicitValue(ref data) => {
w.write_u8(constants::DW_OP_implicit_value.0)?;
w.write_uleb128(data.len() as u64)?;
w.write(data)?;
}
Operation::ImplicitPointer { entry, byte_offset } => {
if encoding.version >= 5 {
w.write_u8(constants::DW_OP_implicit_pointer.0)?;
} else {
w.write_u8(constants::DW_OP_GNU_implicit_pointer.0)?;
}
let size = if encoding.version == 2 {
encoding.address_size
} else {
encoding.format.word_size()
};
match entry {
Reference::Symbol(symbol) => {
w.write_reference(symbol, size)?;
}
Reference::Entry(unit, entry) => {
let refs = refs.ok_or(Error::InvalidReference)?;
refs.push(DebugInfoReference {
offset: w.len(),
unit,
entry,
size,
});
w.write_udata(0, size)?;
}
}
w.write_sleb128(byte_offset)?;
}
Operation::Piece { size_in_bytes } => {
w.write_u8(constants::DW_OP_piece.0)?;
w.write_uleb128(size_in_bytes)?;
}
Operation::BitPiece {
size_in_bits,
bit_offset,
} => {
w.write_u8(constants::DW_OP_bit_piece.0)?;
w.write_uleb128(size_in_bits)?;
w.write_uleb128(bit_offset)?;
}
Operation::ParameterRef(entry) => {
w.write_u8(constants::DW_OP_GNU_parameter_ref.0)?;
w.write_udata(entry_offset(entry)?, 4)?;
}
Operation::WasmLocal(index) => {
w.write(&[constants::DW_OP_WASM_location.0, 0])?;
w.write_uleb128(index.into())?;
}
Operation::WasmGlobal(index) => {
w.write(&[constants::DW_OP_WASM_location.0, 1])?;
w.write_uleb128(index.into())?;
}
Operation::WasmStack(index) => {
w.write(&[constants::DW_OP_WASM_location.0, 2])?;
w.write_uleb128(index.into())?;
}
}
Ok(())
}
}
#[cfg(feature = "read")]
pub(crate) mod convert {
use super::*;
use crate::common::UnitSectionOffset;
use crate::read::{self, Reader};
use crate::write::{ConvertError, ConvertResult, UnitId};
use std::collections::HashMap;
impl Expression {
/// Create an expression from the input expression.
pub fn from<R: Reader<Offset = usize>>(
from_expression: read::Expression<R>,
encoding: Encoding,
dwarf: Option<&read::Dwarf<R>>,
unit: Option<&read::Unit<R>>,
entry_ids: Option<&HashMap<UnitSectionOffset, (UnitId, UnitEntryId)>>,
convert_address: &dyn Fn(u64) -> Option<Address>,
) -> ConvertResult<Expression> {
let convert_unit_offset = |offset: read::UnitOffset| -> ConvertResult<_> {
let entry_ids = entry_ids.ok_or(ConvertError::UnsupportedOperation)?;
let unit = unit.ok_or(ConvertError::UnsupportedOperation)?;
let id = entry_ids
.get(&offset.to_unit_section_offset(unit))
.ok_or(ConvertError::InvalidUnitRef)?;
Ok(id.1)
};
let convert_debug_info_offset = |offset| -> ConvertResult<_> {
// TODO: support relocations
let entry_ids = entry_ids.ok_or(ConvertError::UnsupportedOperation)?;
let id = entry_ids
.get(&UnitSectionOffset::DebugInfoOffset(offset))
.ok_or(ConvertError::InvalidDebugInfoRef)?;
Ok(Reference::Entry(id.0, id.1))
};
// Calculate offsets for use in branch/skip operations.
let mut offsets = Vec::new();
let mut offset = 0;
let mut from_operations = from_expression.clone().operations(encoding);
while from_operations.next()?.is_some() {
offsets.push(offset);
offset = from_operations.offset_from(&from_expression);
}
offsets.push(from_expression.0.len());
let mut from_operations = from_expression.clone().operations(encoding);
let mut operations = Vec::new();
while let Some(from_operation) = from_operations.next()? {
let operation = match from_operation {
read::Operation::Deref {
base_type,
size,
space,
} => {
if base_type.0 != 0 {
let base = convert_unit_offset(base_type)?;
Operation::DerefType { space, size, base }
} else if size != encoding.address_size {
Operation::DerefSize { space, size }
} else {
Operation::Deref { space }
}
}
read::Operation::Drop => Operation::Simple(constants::DW_OP_drop),
read::Operation::Pick { index } => Operation::Pick(index),
read::Operation::Swap => Operation::Simple(constants::DW_OP_swap),
read::Operation::Rot => Operation::Simple(constants::DW_OP_rot),
read::Operation::Abs => Operation::Simple(constants::DW_OP_abs),
read::Operation::And => Operation::Simple(constants::DW_OP_and),
read::Operation::Div => Operation::Simple(constants::DW_OP_div),
read::Operation::Minus => Operation::Simple(constants::DW_OP_minus),
read::Operation::Mod => Operation::Simple(constants::DW_OP_mod),
read::Operation::Mul => Operation::Simple(constants::DW_OP_mul),
read::Operation::Neg => Operation::Simple(constants::DW_OP_neg),
read::Operation::Not => Operation::Simple(constants::DW_OP_not),
read::Operation::Or => Operation::Simple(constants::DW_OP_or),
read::Operation::Plus => Operation::Simple(constants::DW_OP_plus),
read::Operation::PlusConstant { value } => Operation::PlusConstant(value),
read::Operation::Shl => Operation::Simple(constants::DW_OP_shl),
read::Operation::Shr => Operation::Simple(constants::DW_OP_shr),
read::Operation::Shra => Operation::Simple(constants::DW_OP_shra),
read::Operation::Xor => Operation::Simple(constants::DW_OP_xor),
read::Operation::Eq => Operation::Simple(constants::DW_OP_eq),
read::Operation::Ge => Operation::Simple(constants::DW_OP_ge),
read::Operation::Gt => Operation::Simple(constants::DW_OP_gt),
read::Operation::Le => Operation::Simple(constants::DW_OP_le),
read::Operation::Lt => Operation::Simple(constants::DW_OP_lt),
read::Operation::Ne => Operation::Simple(constants::DW_OP_ne),
read::Operation::Bra { target } => {
let offset = from_operations
.offset_from(&from_expression)
.wrapping_add(i64::from(target) as usize);
let index = offsets
.binary_search(&offset)
.map_err(|_| ConvertError::InvalidBranchTarget)?;
Operation::Branch(index)
}
read::Operation::Skip { target } => {
let offset = from_operations
.offset_from(&from_expression)
.wrapping_add(i64::from(target) as usize);
let index = offsets
.binary_search(&offset)
.map_err(|_| ConvertError::InvalidBranchTarget)?;
Operation::Skip(index)
}
read::Operation::UnsignedConstant { value } => {
Operation::UnsignedConstant(value)
}
read::Operation::SignedConstant { value } => Operation::SignedConstant(value),
read::Operation::Register { register } => Operation::Register(register),
read::Operation::RegisterOffset {
register,
offset,
base_type,
} => {
if base_type.0 != 0 {
Operation::RegisterType(register, convert_unit_offset(base_type)?)
} else {
Operation::RegisterOffset(register, offset)
}
}
read::Operation::FrameOffset { offset } => Operation::FrameOffset(offset),
read::Operation::Nop => Operation::Simple(constants::DW_OP_nop),
read::Operation::PushObjectAddress => {
Operation::Simple(constants::DW_OP_push_object_address)
}
read::Operation::Call { offset } => match offset {
read::DieReference::UnitRef(offset) => {
Operation::Call(convert_unit_offset(offset)?)
}
read::DieReference::DebugInfoRef(offset) => {
Operation::CallRef(convert_debug_info_offset(offset)?)
}
},
read::Operation::TLS => Operation::Simple(constants::DW_OP_form_tls_address),
read::Operation::CallFrameCFA => {
Operation::Simple(constants::DW_OP_call_frame_cfa)
}
read::Operation::Piece {
size_in_bits,
bit_offset: None,
} => Operation::Piece {
size_in_bytes: size_in_bits / 8,
},
read::Operation::Piece {
size_in_bits,
bit_offset: Some(bit_offset),
} => Operation::BitPiece {
size_in_bits,
bit_offset,
},
read::Operation::ImplicitValue { data } => {
Operation::ImplicitValue(data.to_slice()?.into_owned().into())
}
read::Operation::StackValue => Operation::Simple(constants::DW_OP_stack_value),
read::Operation::ImplicitPointer { value, byte_offset } => {
let entry = convert_debug_info_offset(value)?;
Operation::ImplicitPointer { entry, byte_offset }
}
read::Operation::EntryValue { expression } => {
let expression = Expression::from(
read::Expression(expression),
encoding,
dwarf,
unit,
entry_ids,
convert_address,
)?;
Operation::EntryValue(expression)
}
read::Operation::ParameterRef { offset } => {
let entry = convert_unit_offset(offset)?;
Operation::ParameterRef(entry)
}
read::Operation::Address { address } => {
let address =
convert_address(address).ok_or(ConvertError::InvalidAddress)?;
Operation::Address(address)
}
read::Operation::AddressIndex { index } => {
let dwarf = dwarf.ok_or(ConvertError::UnsupportedOperation)?;
let unit = unit.ok_or(ConvertError::UnsupportedOperation)?;
let val = dwarf.address(unit, index)?;
let address = convert_address(val).ok_or(ConvertError::InvalidAddress)?;
Operation::Address(address)
}
read::Operation::ConstantIndex { index } => {
let dwarf = dwarf.ok_or(ConvertError::UnsupportedOperation)?;
let unit = unit.ok_or(ConvertError::UnsupportedOperation)?;
let val = dwarf.address(unit, index)?;
Operation::UnsignedConstant(val)
}
read::Operation::TypedLiteral { base_type, value } => {
let entry = convert_unit_offset(base_type)?;
Operation::ConstantType(entry, value.to_slice()?.into_owned().into())
}
read::Operation::Convert { base_type } => {
if base_type.0 == 0 {
Operation::Convert(None)
} else {
let entry = convert_unit_offset(base_type)?;
Operation::Convert(Some(entry))
}
}
read::Operation::Reinterpret { base_type } => {
if base_type.0 == 0 {
Operation::Reinterpret(None)
} else {
let entry = convert_unit_offset(base_type)?;
Operation::Reinterpret(Some(entry))
}
}
read::Operation::WasmLocal { index } => Operation::WasmLocal(index),
read::Operation::WasmGlobal { index } => Operation::WasmGlobal(index),
read::Operation::WasmStack { index } => Operation::WasmStack(index),
};
operations.push(operation);
}
Ok(Expression { operations })
}
}
}
#[cfg(test)]
#[cfg(feature = "read")]
mod tests {
use super::*;
use crate::common::{DebugInfoOffset, Format};
use crate::read;
use crate::write::{AttributeValue, Dwarf, EndianVec, LineProgram, Sections, Unit};
use crate::LittleEndian;
use std::collections::HashMap;
#[test]
#[allow(clippy::type_complexity)]
fn test_operation() {
for version in [2, 3, 4, 5] {
for address_size in [4, 8] {
for format in [Format::Dwarf32, Format::Dwarf64] {
let encoding = Encoding {
format,
version,
address_size,
};
let mut dwarf = Dwarf::new();
let unit_id = dwarf.units.add(Unit::new(encoding, LineProgram::none()));
let unit = dwarf.units.get_mut(unit_id);
// Create an entry that can be referenced by the expression.
let entry_id = unit.add(unit.root(), constants::DW_TAG_base_type);
let reference = Reference::Entry(unit_id, entry_id);
// The offsets for the above entry when reading back the expression.
struct ReadState {
debug_info_offset: DebugInfoOffset,
entry_offset: read::UnitOffset,
}
let mut reg_expression = Expression::new();
reg_expression.op_reg(Register(23));
let operations: &[(
&dyn Fn(&mut Expression),
Operation,
&dyn Fn(&ReadState) -> read::Operation<_>,
)] = &[
(
&|x| x.op_deref(),
Operation::Deref { space: false },
&|_| read::Operation::Deref {
base_type: read::UnitOffset(0),
size: address_size,
space: false,
},
),
(
&|x| x.op_xderef(),
Operation::Deref { space: true },
&|_| read::Operation::Deref {
base_type: read::UnitOffset(0),
size: address_size,
space: true,
},
),
(
&|x| x.op_deref_size(2),
Operation::DerefSize {
space: false,
size: 2,
},
&|_| read::Operation::Deref {
base_type: read::UnitOffset(0),
size: 2,
space: false,
},
),
(
&|x| x.op_xderef_size(2),
Operation::DerefSize {
space: true,
size: 2,
},
&|_| read::Operation::Deref {
base_type: read::UnitOffset(0),
size: 2,
space: true,
},
),
(
&|x| x.op_deref_type(2, entry_id),
Operation::DerefType {
space: false,
size: 2,
base: entry_id,
},
&|x| read::Operation::Deref {
base_type: x.entry_offset,
size: 2,
space: false,
},
),
(
&|x| x.op_xderef_type(2, entry_id),
Operation::DerefType {
space: true,
size: 2,
base: entry_id,
},
&|x| read::Operation::Deref {
base_type: x.entry_offset,
size: 2,
space: true,
},
),
(
&|x| x.op(constants::DW_OP_drop),
Operation::Simple(constants::DW_OP_drop),
&|_| read::Operation::Drop,
),
(&|x| x.op_pick(0), Operation::Pick(0), &|_| {
read::Operation::Pick { index: 0 }
}),
(&|x| x.op_pick(1), Operation::Pick(1), &|_| {
read::Operation::Pick { index: 1 }
}),
(&|x| x.op_pick(2), Operation::Pick(2), &|_| {
read::Operation::Pick { index: 2 }
}),
(
&|x| x.op(constants::DW_OP_swap),
Operation::Simple(constants::DW_OP_swap),
&|_| read::Operation::Swap,
),
(
&|x| x.op(constants::DW_OP_rot),
Operation::Simple(constants::DW_OP_rot),
&|_| read::Operation::Rot,
),
(
&|x| x.op(constants::DW_OP_abs),
Operation::Simple(constants::DW_OP_abs),
&|_| read::Operation::Abs,
),
(
&|x| x.op(constants::DW_OP_and),
Operation::Simple(constants::DW_OP_and),
&|_| read::Operation::And,
),
(
&|x| x.op(constants::DW_OP_div),
Operation::Simple(constants::DW_OP_div),
&|_| read::Operation::Div,
),
(
&|x| x.op(constants::DW_OP_minus),
Operation::Simple(constants::DW_OP_minus),
&|_| read::Operation::Minus,
),
(
&|x| x.op(constants::DW_OP_mod),
Operation::Simple(constants::DW_OP_mod),
&|_| read::Operation::Mod,
),
(
&|x| x.op(constants::DW_OP_mul),
Operation::Simple(constants::DW_OP_mul),
&|_| read::Operation::Mul,
),
(
&|x| x.op(constants::DW_OP_neg),
Operation::Simple(constants::DW_OP_neg),
&|_| read::Operation::Neg,
),
(
&|x| x.op(constants::DW_OP_not),
Operation::Simple(constants::DW_OP_not),
&|_| read::Operation::Not,
),
(
&|x| x.op(constants::DW_OP_or),
Operation::Simple(constants::DW_OP_or),
&|_| read::Operation::Or,
),
(
&|x| x.op(constants::DW_OP_plus),
Operation::Simple(constants::DW_OP_plus),
&|_| read::Operation::Plus,
),
(
&|x| x.op_plus_uconst(23),
Operation::PlusConstant(23),
&|_| read::Operation::PlusConstant { value: 23 },
),
(
&|x| x.op(constants::DW_OP_shl),
Operation::Simple(constants::DW_OP_shl),
&|_| read::Operation::Shl,
),
(
&|x| x.op(constants::DW_OP_shr),
Operation::Simple(constants::DW_OP_shr),
&|_| read::Operation::Shr,
),
(
&|x| x.op(constants::DW_OP_shra),
Operation::Simple(constants::DW_OP_shra),
&|_| read::Operation::Shra,
),
(
&|x| x.op(constants::DW_OP_xor),
Operation::Simple(constants::DW_OP_xor),
&|_| read::Operation::Xor,
),
(
&|x| x.op(constants::DW_OP_eq),
Operation::Simple(constants::DW_OP_eq),
&|_| read::Operation::Eq,
),
(
&|x| x.op(constants::DW_OP_ge),
Operation::Simple(constants::DW_OP_ge),
&|_| read::Operation::Ge,
),
(
&|x| x.op(constants::DW_OP_gt),
Operation::Simple(constants::DW_OP_gt),
&|_| read::Operation::Gt,
),
(
&|x| x.op(constants::DW_OP_le),
Operation::Simple(constants::DW_OP_le),
&|_| read::Operation::Le,
),
(
&|x| x.op(constants::DW_OP_lt),
Operation::Simple(constants::DW_OP_lt),
&|_| read::Operation::Lt,
),
(
&|x| x.op(constants::DW_OP_ne),
Operation::Simple(constants::DW_OP_ne),
&|_| read::Operation::Ne,
),
(
&|x| x.op_constu(23),
Operation::UnsignedConstant(23),
&|_| read::Operation::UnsignedConstant { value: 23 },
),
(
&|x| x.op_consts(-23),
Operation::SignedConstant(-23),
&|_| read::Operation::SignedConstant { value: -23 },
),
(
&|x| x.op_reg(Register(23)),
Operation::Register(Register(23)),
&|_| read::Operation::Register {
register: Register(23),
},
),
(
&|x| x.op_reg(Register(123)),
Operation::Register(Register(123)),
&|_| read::Operation::Register {
register: Register(123),
},
),
(
&|x| x.op_breg(Register(23), 34),
Operation::RegisterOffset(Register(23), 34),
&|_| read::Operation::RegisterOffset {
register: Register(23),
offset: 34,
base_type: read::UnitOffset(0),
},
),
(
&|x| x.op_breg(Register(123), 34),
Operation::RegisterOffset(Register(123), 34),
&|_| read::Operation::RegisterOffset {
register: Register(123),
offset: 34,
base_type: read::UnitOffset(0),
},
),
(
&|x| x.op_regval_type(Register(23), entry_id),
Operation::RegisterType(Register(23), entry_id),
&|x| read::Operation::RegisterOffset {
register: Register(23),
offset: 0,
base_type: x.entry_offset,
},
),
(&|x| x.op_fbreg(34), Operation::FrameOffset(34), &|_| {
read::Operation::FrameOffset { offset: 34 }
}),
(
&|x| x.op(constants::DW_OP_nop),
Operation::Simple(constants::DW_OP_nop),
&|_| read::Operation::Nop,
),
(
&|x| x.op(constants::DW_OP_push_object_address),
Operation::Simple(constants::DW_OP_push_object_address),
&|_| read::Operation::PushObjectAddress,
),
(&|x| x.op_call(entry_id), Operation::Call(entry_id), &|x| {
read::Operation::Call {
offset: read::DieReference::UnitRef(x.entry_offset),
}
}),
(
&|x| x.op_call_ref(reference),
Operation::CallRef(reference),
&|x| read::Operation::Call {
offset: read::DieReference::DebugInfoRef(x.debug_info_offset),
},
),
(
&|x| x.op(constants::DW_OP_form_tls_address),
Operation::Simple(constants::DW_OP_form_tls_address),
&|_| read::Operation::TLS,
),
(
&|x| x.op(constants::DW_OP_call_frame_cfa),
Operation::Simple(constants::DW_OP_call_frame_cfa),
&|_| read::Operation::CallFrameCFA,
),
(
&|x| x.op_piece(23),
Operation::Piece { size_in_bytes: 23 },
&|_| read::Operation::Piece {
size_in_bits: 23 * 8,
bit_offset: None,
},
),
(
&|x| x.op_bit_piece(23, 34),
Operation::BitPiece {
size_in_bits: 23,
bit_offset: 34,
},
&|_| read::Operation::Piece {
size_in_bits: 23,
bit_offset: Some(34),
},
),
(
&|x| x.op_implicit_value(vec![23].into()),
Operation::ImplicitValue(vec![23].into()),
&|_| read::Operation::ImplicitValue {
data: read::EndianSlice::new(&[23], LittleEndian),
},
),
(
&|x| x.op(constants::DW_OP_stack_value),
Operation::Simple(constants::DW_OP_stack_value),
&|_| read::Operation::StackValue,
),
(
&|x| x.op_implicit_pointer(reference, 23),
Operation::ImplicitPointer {
entry: reference,
byte_offset: 23,
},
&|x| read::Operation::ImplicitPointer {
value: x.debug_info_offset,
byte_offset: 23,
},
),
(
&|x| x.op_entry_value(reg_expression.clone()),
Operation::EntryValue(reg_expression.clone()),
&|_| read::Operation::EntryValue {
expression: read::EndianSlice::new(
&[constants::DW_OP_reg23.0],
LittleEndian,
),
},
),
(
&|x| x.op_gnu_parameter_ref(entry_id),
Operation::ParameterRef(entry_id),
&|x| read::Operation::ParameterRef {
offset: x.entry_offset,
},
),
(
&|x| x.op_addr(Address::Constant(23)),
Operation::Address(Address::Constant(23)),
&|_| read::Operation::Address { address: 23 },
),
(
&|x| x.op_const_type(entry_id, vec![23].into()),
Operation::ConstantType(entry_id, vec![23].into()),
&|x| read::Operation::TypedLiteral {
base_type: x.entry_offset,
value: read::EndianSlice::new(&[23], LittleEndian),
},
),
(&|x| x.op_convert(None), Operation::Convert(None), &|_| {
read::Operation::Convert {
base_type: read::UnitOffset(0),
}
}),
(
&|x| x.op_convert(Some(entry_id)),
Operation::Convert(Some(entry_id)),
&|x| read::Operation::Convert {
base_type: x.entry_offset,
},
),
(
&|x| x.op_reinterpret(None),
Operation::Reinterpret(None),
&|_| read::Operation::Reinterpret {
base_type: read::UnitOffset(0),
},
),
(
&|x| x.op_reinterpret(Some(entry_id)),
Operation::Reinterpret(Some(entry_id)),
&|x| read::Operation::Reinterpret {
base_type: x.entry_offset,
},
),
(
&|x| x.op_wasm_local(1000),
Operation::WasmLocal(1000),
&|_| read::Operation::WasmLocal { index: 1000 },
),
(
&|x| x.op_wasm_global(1000),
Operation::WasmGlobal(1000),
&|_| read::Operation::WasmGlobal { index: 1000 },
),
(
&|x| x.op_wasm_stack(1000),
Operation::WasmStack(1000),
&|_| read::Operation::WasmStack { index: 1000 },
),
];
// Create a single expression containing all operations.
let mut expression = Expression::new();
let start_index = expression.next_index();
for (f, o, _) in operations {
f(&mut expression);
assert_eq!(expression.operations.last(), Some(o));
}
let bra_index = expression.op_bra();
let skip_index = expression.op_skip();
expression.op(constants::DW_OP_nop);
let end_index = expression.next_index();
expression.set_target(bra_index, start_index);
expression.set_target(skip_index, end_index);
// Create an entry containing the expression.
let subprogram_id = unit.add(unit.root(), constants::DW_TAG_subprogram);
let subprogram = unit.get_mut(subprogram_id);
subprogram.set(
constants::DW_AT_location,
AttributeValue::Exprloc(expression),
);
// Write the DWARF, then parse it.
let mut sections = Sections::new(EndianVec::new(LittleEndian));
dwarf.write(&mut sections).unwrap();
let read_dwarf = sections.read(LittleEndian);
let mut read_units = read_dwarf.units();
let read_unit_header = read_units.next().unwrap().unwrap();
let read_unit = read_dwarf.unit(read_unit_header).unwrap();
let mut read_entries = read_unit.entries();
let (_, read_entry) = read_entries.next_dfs().unwrap().unwrap();
assert_eq!(read_entry.tag(), constants::DW_TAG_compile_unit);
// Determine the offset of the entry that can be referenced by the expression.
let (_, read_entry) = read_entries.next_dfs().unwrap().unwrap();
assert_eq!(read_entry.tag(), constants::DW_TAG_base_type);
let read_state = ReadState {
debug_info_offset: read_entry
.offset()
.to_debug_info_offset(&read_unit.header)
.unwrap(),
entry_offset: read_entry.offset(),
};
// Get the expression.
let (_, read_entry) = read_entries.next_dfs().unwrap().unwrap();
assert_eq!(read_entry.tag(), constants::DW_TAG_subprogram);
let read_attr = read_entry
.attr_value(constants::DW_AT_location)
.unwrap()
.unwrap();
let read_expression = read_attr.exprloc_value().unwrap();
let mut read_operations = read_expression.operations(encoding);
for (_, _, operation) in operations {
assert_eq!(read_operations.next(), Ok(Some(operation(&read_state))));
}
// 4 = DW_OP_skip + i16 + DW_OP_nop
assert_eq!(
read_operations.next(),
Ok(Some(read::Operation::Bra {
target: -(read_expression.0.len() as i16) + 4
}))
);
// 1 = DW_OP_nop
assert_eq!(
read_operations.next(),
Ok(Some(read::Operation::Skip { target: 1 }))
);
assert_eq!(read_operations.next(), Ok(Some(read::Operation::Nop)));
assert_eq!(read_operations.next(), Ok(None));
let mut entry_ids = HashMap::new();
entry_ids.insert(read_state.debug_info_offset.into(), (unit_id, entry_id));
let convert_expression = Expression::from(
read_expression,
encoding,
Some(&read_dwarf),
Some(&read_unit),
Some(&entry_ids),
&|address| Some(Address::Constant(address)),
)
.unwrap();
let mut convert_operations = convert_expression.operations.iter();
for (_, operation, _) in operations {
assert_eq!(convert_operations.next(), Some(operation));
}
assert_eq!(
convert_operations.next(),
Some(&Operation::Branch(start_index))
);
assert_eq!(convert_operations.next(), Some(&Operation::Skip(end_index)));
assert_eq!(
convert_operations.next(),
Some(&Operation::Simple(constants::DW_OP_nop))
);
}
}
}
}
}