logo
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

// SPDX-License-Identifier: MIT
// Copyright (C) 2018-present iced project and contributors

use crate::*;

/// Memory operand passed to one of [`Instruction`]'s `with_*()` constructor methods
///
/// [`Instruction`]: struct.Instruction.html
#[derive(Debug, Default, Copy, Clone, Eq, PartialEq, Hash)]
pub struct MemoryOperand {
	/// Segment override or [`Register::None`]
	///
	/// [`Register::None`]: enum.Register.html#variant.None
	pub segment_prefix: Register,

	/// Base register or [`Register::None`]
	///
	/// [`Register::None`]: enum.Register.html#variant.None
	pub base: Register,

	/// Index register or [`Register::None`]
	///
	/// [`Register::None`]: enum.Register.html#variant.None
	pub index: Register,

	/// Index register scale (1, 2, 4, or 8)
	pub scale: u32,

	/// Memory displacement
	pub displacement: i64,

	/// 0 (no displ), 1 (16/32/64-bit, but use 2/4/8 if it doesn't fit in a `i8`), 2 (16-bit), 4 (32-bit) or 8 (64-bit)
	pub displ_size: u32,

	/// `true` if it's broadcast memory (EVEX instructions)
	pub is_broadcast: bool,
}

impl MemoryOperand {
	/// Constructor
	///
	/// # Arguments
	///
	/// * `base`: Base register or [`Register::None`]
	/// * `index`: Index register or [`Register::None`]
	/// * `scale`: Index register scale (1, 2, 4, or 8)
	/// * `displacement`: Memory displacement
	/// * `displ_size`: 0 (no displ), 1 (16/32/64-bit, but use 2/4/8 if it doesn't fit in a `i8`), 2 (16-bit), 4 (32-bit) or 8 (64-bit)
	/// * `is_broadcast`: `true` if it's broadcast memory (EVEX instructions)
	/// * `segment_prefix`: Segment override or [`Register::None`]
	///
	/// [`Register::None`]: enum.Register.html#variant.None
	#[must_use]
	#[inline]
	pub fn new(
		base: Register, index: Register, scale: u32, displacement: i64, displ_size: u32, is_broadcast: bool, segment_prefix: Register,
	) -> Self {
		Self { segment_prefix, base, index, scale, displacement, displ_size, is_broadcast }
	}

	/// Constructor
	///
	/// # Arguments
	///
	/// * `base`: Base register or [`Register::None`]
	/// * `index`: Index register or [`Register::None`]
	/// * `scale`: Index register scale (1, 2, 4, or 8)
	/// * `is_broadcast`: `true` if it's broadcast memory (EVEX instructions)
	/// * `segment_prefix`: Segment override or [`Register::None`]
	///
	/// [`Register::None`]: enum.Register.html#variant.None
	#[must_use]
	#[inline]
	pub fn with_base_index_scale_bcst_seg(base: Register, index: Register, scale: u32, is_broadcast: bool, segment_prefix: Register) -> Self {
		Self { segment_prefix, base, index, scale, displacement: 0, displ_size: 0, is_broadcast }
	}

	/// Constructor
	///
	/// # Arguments
	///
	/// * `base`: Base register or [`Register::None`]
	/// * `displacement`: Memory displacement
	/// * `displ_size`: 0 (no displ), 1 (16/32/64-bit, but use 2/4/8 if it doesn't fit in a `i8`), 2 (16-bit), 4 (32-bit) or 8 (64-bit)
	/// * `is_broadcast`: `true` if it's broadcast memory (EVEX instructions)
	/// * `segment_prefix`: Segment override or [`Register::None`]
	///
	/// [`Register::None`]: enum.Register.html#variant.None
	#[must_use]
	#[inline]
	pub fn with_base_displ_size_bcst_seg(base: Register, displacement: i64, displ_size: u32, is_broadcast: bool, segment_prefix: Register) -> Self {
		Self { segment_prefix, base, index: Register::None, scale: 1, displacement, displ_size, is_broadcast }
	}

	/// Constructor
	///
	/// # Arguments
	///
	/// * `index`: Index register or [`Register::None`]
	/// * `scale`: Index register scale (1, 2, 4, or 8)
	/// * `displacement`: Memory displacement
	/// * `displ_size`: 0 (no displ), 1 (16/32/64-bit, but use 2/4/8 if it doesn't fit in a `i8`), 2 (16-bit), 4 (32-bit) or 8 (64-bit)
	/// * `is_broadcast`: `true` if it's broadcast memory (EVEX instructions)
	/// * `segment_prefix`: Segment override or [`Register::None`]
	///
	/// [`Register::None`]: enum.Register.html#variant.None
	#[must_use]
	#[inline]
	pub fn with_index_scale_displ_size_bcst_seg(
		index: Register, scale: u32, displacement: i64, displ_size: u32, is_broadcast: bool, segment_prefix: Register,
	) -> Self {
		Self { segment_prefix, base: Register::None, index, scale, displacement, displ_size, is_broadcast }
	}

	/// Constructor
	///
	/// # Arguments
	///
	/// * `base`: Base register or [`Register::None`]
	/// * `displacement`: Memory displacement
	/// * `is_broadcast`: `true` if it's broadcast memory (EVEX instructions)
	/// * `segment_prefix`: Segment override or [`Register::None`]
	///
	/// [`Register::None`]: enum.Register.html#variant.None
	#[must_use]
	#[inline]
	pub fn with_base_displ_bcst_seg(base: Register, displacement: i64, is_broadcast: bool, segment_prefix: Register) -> Self {
		Self { segment_prefix, base, index: Register::None, scale: 1, displacement, displ_size: 1, is_broadcast }
	}

	/// Constructor
	///
	/// # Arguments
	///
	/// * `base`: Base register or [`Register::None`]
	/// * `index`: Index register or [`Register::None`]
	/// * `scale`: Index register scale (1, 2, 4, or 8)
	/// * `displacement`: Memory displacement
	/// * `displ_size`: 0 (no displ), 1 (16/32/64-bit, but use 2/4/8 if it doesn't fit in a `i8`), 2 (16-bit), 4 (32-bit) or 8 (64-bit)
	///
	/// [`Register::None`]: enum.Register.html#variant.None
	#[must_use]
	#[inline]
	pub fn with_base_index_scale_displ_size(base: Register, index: Register, scale: u32, displacement: i64, displ_size: u32) -> Self {
		Self { segment_prefix: Register::None, base, index, scale, displacement, displ_size, is_broadcast: false }
	}

	/// Constructor
	///
	/// # Arguments
	///
	/// * `base`: Base register or [`Register::None`]
	/// * `index`: Index register or [`Register::None`]
	/// * `scale`: Index register scale (1, 2, 4, or 8)
	///
	/// [`Register::None`]: enum.Register.html#variant.None
	#[must_use]
	#[inline]
	pub fn with_base_index_scale(base: Register, index: Register, scale: u32) -> Self {
		Self { segment_prefix: Register::None, base, index, scale, displacement: 0, displ_size: 0, is_broadcast: false }
	}

	/// Constructor
	///
	/// # Arguments
	///
	/// * `base`: Base register or [`Register::None`]
	/// * `index`: Index register or [`Register::None`]
	///
	/// [`Register::None`]: enum.Register.html#variant.None
	#[must_use]
	#[inline]
	pub fn with_base_index(base: Register, index: Register) -> Self {
		Self { segment_prefix: Register::None, base, index, scale: 1, displacement: 0, displ_size: 0, is_broadcast: false }
	}

	/// Constructor
	///
	/// # Arguments
	///
	/// * `base`: Base register or [`Register::None`]
	/// * `displacement`: Memory displacement
	/// * `displ_size`: 0 (no displ), 1 (16/32/64-bit, but use 2/4/8 if it doesn't fit in a `i8`), 2 (16-bit), 4 (32-bit) or 8 (64-bit)
	///
	/// [`Register::None`]: enum.Register.html#variant.None
	#[must_use]
	#[inline]
	pub fn with_base_displ_size(base: Register, displacement: i64, displ_size: u32) -> Self {
		Self { segment_prefix: Register::None, base, index: Register::None, scale: 1, displacement, displ_size, is_broadcast: false }
	}

	/// Constructor
	///
	/// # Arguments
	///
	/// * `index`: Index register or [`Register::None`]
	/// * `scale`: Index register scale (1, 2, 4, or 8)
	/// * `displacement`: Memory displacement
	/// * `displ_size`: 0 (no displ), 1 (16/32/64-bit, but use 2/4/8 if it doesn't fit in a `i8`), 2 (16-bit), 4 (32-bit) or 8 (64-bit)
	///
	/// [`Register::None`]: enum.Register.html#variant.None
	#[must_use]
	#[inline]
	pub fn with_index_scale_displ_size(index: Register, scale: u32, displacement: i64, displ_size: u32) -> Self {
		Self { segment_prefix: Register::None, base: Register::None, index, scale, displacement, displ_size, is_broadcast: false }
	}

	/// Constructor
	///
	/// # Arguments
	///
	/// * `base`: Base register or [`Register::None`]
	/// * `displacement`: Memory displacement
	///
	/// [`Register::None`]: enum.Register.html#variant.None
	#[must_use]
	#[inline]
	pub fn with_base_displ(base: Register, displacement: i64) -> Self {
		Self { segment_prefix: Register::None, base, index: Register::None, scale: 1, displacement, displ_size: 1, is_broadcast: false }
	}

	/// Constructor
	///
	/// # Arguments
	///
	/// * `base`: Base register or [`Register::None`]
	///
	/// [`Register::None`]: enum.Register.html#variant.None
	#[must_use]
	#[inline]
	pub fn with_base(base: Register) -> Self {
		Self { segment_prefix: Register::None, base, index: Register::None, scale: 1, displacement: 0, displ_size: 0, is_broadcast: false }
	}

	/// Constructor
	///
	/// # Arguments
	///
	/// * `displacement`: Memory displacement
	/// * `displ_size`: 2 (16-bit), 4 (32-bit) or 8 (64-bit)
	///
	/// [`Register::None`]: enum.Register.html#variant.None
	#[must_use]
	#[inline]
	pub fn with_displ(displacement: u64, displ_size: u32) -> Self {
		Self {
			segment_prefix: Register::None,
			base: Register::None,
			index: Register::None,
			scale: 1,
			displacement: displacement as i64,
			displ_size,
			is_broadcast: false,
		}
	}
}