/
memory-range.ts
127 lines (107 loc) · 4.47 KB
/
memory-range.ts
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
/********************************************************************************
* Copyright (C) 2023 Ericsson and others.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v. 2.0 which is available at
* http://www.eclipse.org/legal/epl-2.0.
*
* This Source Code may also be made available under the following Secondary
* Licenses when the conditions for such availability set forth in the Eclipse
* Public License v. 2.0 are satisfied: GNU General Public License, version 2
* with the GNU Classpath Exception which is available at
* https://www.gnu.org/software/classpath/license.html.
*
* SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
********************************************************************************/
/** Suitable for transmission as JSON */
export interface MemoryRange {
/** String representation of the address at which the range begins. May exceed maximum safe JS integer. */
startAddress: string;
/**
* String representation of the address at which the range ends, exclusive. I.e. this should be the first address not included in the range.
* May exceed maximum safe JS integer.
*
* If absent, the UI will indicate the first address at which the variable can be found but not its extent.
*/
endAddress?: string;
}
export interface WrittenMemory {
memoryReference: string;
offset?: number;
count?: number
}
/** Suitable for arithemetic */
export interface BigIntMemoryRange {
startAddress: bigint;
endAddress: bigint;
}
export function isWithin(candidate: bigint, container: BigIntMemoryRange): boolean {
return container.startAddress <= candidate && container.endAddress > candidate;
}
export function doOverlap(one: BigIntMemoryRange, other: BigIntMemoryRange): boolean {
// If they overlap, they either start in the same place, or one starts in the other.
return isWithin(one.startAddress, other) || isWithin(other.startAddress, one);
}
export function areRangesEqual(one: BigIntMemoryRange, other: BigIntMemoryRange): boolean {
return one.startAddress === other.startAddress && one.endAddress === other.endAddress;
}
export function compareBigInt(left: bigint, right: bigint): number {
const difference = left - right;
return difference === BigInt(0) ? 0 : difference > 0 ? 1 : -1;
}
export enum RangeRelationship {
Before,
Within,
Past,
None,
}
export function determineRelationship(candidate: bigint, range?: BigIntMemoryRange): RangeRelationship {
if (range === undefined) { return RangeRelationship.None; }
if (candidate < range.startAddress) { return RangeRelationship.Before; }
if (candidate >= range.endAddress) { return RangeRelationship.Past; }
return RangeRelationship.Within;
}
export enum Radix {
Binary = 2,
Octal = 8,
Decimal = 10,
Hexadecimal = 16,
}
export type Architecture = 32 | 64;
const radixPrefixMap: { [key: number]: string } = {
[Radix.Binary]: '0b',
[Radix.Octal]: '0o',
[Radix.Decimal]: '0d',
[Radix.Hexadecimal]: '0x',
};
export function getRadixMarker(radix: Radix): string {
return radixPrefixMap[radix];
}
export function getAddressString(address: bigint | number, radix: Radix, paddedLength: number = 0): string {
return address.toString(radix).padStart(paddedLength, '0');
}
export function getAddressLength(padding: number, radix: Radix): number {
return Math.ceil(padding / Math.log2(radix));
}
export function toHexStringWithRadixMarker(target: bigint | number, paddedLength: number = 0): string {
return `${getRadixMarker(Radix.Hexadecimal)}${getAddressString(target, Radix.Hexadecimal, paddedLength)}`;
}
export interface VariableMetadata {
name: string;
type?: string;
/** If applicable, a string representation of the variable's value */
value?: string;
}
/** Suitable for transmission as JSON */
export interface VariableRange extends MemoryRange, VariableMetadata { }
/** Suitable for arithemetic */
export interface BigIntVariableRange extends BigIntMemoryRange, VariableMetadata { }
export function areVariablesEqual(one: BigIntVariableRange, other: BigIntVariableRange): boolean {
return areRangesEqual(one, other)
&& one.name === other.name
&& one.type === other.type
&& one.value === other.value;
}
export function toOffset(startAddress: bigint, targetAddress: bigint, wordSize: number): number {
return Number(targetAddress - startAddress) * (wordSize / 8);
}