simics 0.2.6

Intel® Simics® Simulator bindings in high level, idiomatic Rust
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

// Copyright (C) 2024 Intel Corporation
// SPDX-License-Identifier: Apache-2.0

//! Experimental snapshot APIs

use crate::{simics_exception, AttrValue, Result};
use raw_cstr::raw_cstr;

// NOTE: Snapshot errors are only defined starting in Simics 6.0.180
#[cfg(not(any(
    simics_version = "6.0.163",
    simics_version = "6.0.164",
    simics_version = "6.0.165",
    simics_version = "6.0.166",
    simics_version = "6.0.167",
    simics_version = "6.0.168",
    simics_version = "6.0.169",
    simics_version = "6.0.170",
    simics_version = "6.0.171",
    simics_version = "6.0.172",
    simics_version = "6.0.173",
    simics_version = "6.0.174",
    simics_version = "6.0.175",
    simics_version = "6.0.176",
    simics_version = "6.0.177",
    simics_version = "6.0.178",
    simics_version = "6.0.179",
)))]
type SnapshotError = crate::sys::snapshot_error_t;

// NOTE: This function was renamed to take_snapshot in Simics 6.0.180
#[cfg(simics_version = "6.0.173")]
#[simics_exception]
/// Save a snapshot with a name. This function was renamed to
/// `VT_take_snapshot` in version 6.0.180
pub fn save_snapshot<S>(name: S) -> Result<()>
where
    S: AsRef<str>,
{
    Ok(unsafe { crate::sys::VT_save_snapshot(raw_cstr(name)?) })
}

// NOTE: This function began returning a boolean result in Simics 6.0.174
#[cfg(any(
    simics_version = "6.0.174",
    simics_version = "6.0.175",
    simics_version = "6.0.176",
    simics_version = "6.0.177",
    simics_version = "6.0.178",
    simics_version = "6.0.179",
))]
#[simics_exception]
/// Save a snapshot with a name. This function was renamed to
/// `VT_take_snapshot` in version 6.0.180
pub fn save_snapshot<S>(name: S) -> Result<bool>
where
    S: AsRef<str>,
{
    Ok(unsafe { crate::sys::VT_save_snapshot(raw_cstr(name)?) })
}

// NOTE: This function is backed by take_snapshot starting from Simics 6.0.180
#[cfg(all(
    not(any(
        simics_version = "6.0.163",
        simics_version = "6.0.164",
        simics_version = "6.0.165",
        simics_version = "6.0.166",
        simics_version = "6.0.167",
        simics_version = "6.0.168",
        simics_version = "6.0.169",
        simics_version = "6.0.170",
        simics_version = "6.0.171",
        simics_version = "6.0.172",
        simics_version = "6.0.173",
        simics_version = "6.0.174",
        simics_version = "6.0.175",
        simics_version = "6.0.176",
        simics_version = "6.0.177",
        simics_version = "6.0.178",
        simics_version = "6.0.179",
    )),
    simics_version = "6"
))]
/// Save a snapshot with a name. API deprecated as of SIMICS 6.0.180
pub fn save_snapshot<S>(name: S) -> Result<SnapshotError>
where
    S: AsRef<str>,
{
    Ok(unsafe { crate::sys::VT_take_snapshot(raw_cstr(name)?) })
}

#[cfg(all(
    not(any(
        simics_version = "6.0.163",
        simics_version = "6.0.164",
        simics_version = "6.0.165",
        simics_version = "6.0.166",
        simics_version = "6.0.167",
        simics_version = "6.0.168",
        simics_version = "6.0.169",
        simics_version = "6.0.170",
        simics_version = "6.0.171",
        simics_version = "6.0.172",
        simics_version = "6.0.173",
        simics_version = "6.0.174",
        simics_version = "6.0.175",
        simics_version = "6.0.176",
        simics_version = "6.0.177",
        simics_version = "6.0.178",
        simics_version = "6.0.179",
    )),
    simics_version = "6"
))]
#[simics_exception]
/// Take a snapshot with a name
pub fn take_snapshot<S>(name: S) -> Result<SnapshotError>
where
    S: AsRef<str>,
{
    Ok(unsafe { crate::sys::VT_take_snapshot(raw_cstr(name)?) })
}

// NOTE: Restoring a snapshot with an index instead of a name was removed in Simics 6.0.174
#[cfg(simics_version = "6.0.173")]
#[simics_exception]
/// Restore a snapshot with a name
pub fn restore_snapshot<S>(index: i32) -> Result<bool>
where
    S: AsRef<str>,
{
    Ok(unsafe { crate::sys::VT_restore_snapshot(index) })
}

// NOTE: Restoring a snapshot with a name was added in Simics 6.0.174
#[cfg(all(
    not(any(
        simics_version = "6.0.163",
        simics_version = "6.0.164",
        simics_version = "6.0.165",
        simics_version = "6.0.166",
        simics_version = "6.0.167",
        simics_version = "6.0.168",
        simics_version = "6.0.169",
        simics_version = "6.0.170",
        simics_version = "6.0.171",
        simics_version = "6.0.172",
        simics_version = "6.0.173",
    )),
    simics_version = "6"
))]
#[simics_exception]
/// Restore a snapshot with a name
pub fn restore_snapshot<S>(name: S) -> Result<SnapshotError>
where
    S: AsRef<str>,
{
    Ok(unsafe { crate::sys::VT_restore_snapshot(raw_cstr(name)?) })
}

// NOTE: Deleting a snapshot with an index instead of a name was removed in Simics 6.0.174
#[cfg(simics_version = "6.0.173")]
#[simics_exception]
/// Delete a snapshot with a name
pub fn delete_snapshot(index: i32) -> Result<bool> {
    Ok(unsafe { crate::sys::VT_delete_snapshot(index) })
}

// NOTE: Deleting a snapshot with a name was added in Simics 6.0.174
#[cfg(all(
    not(any(
        simics_version = "6.0.163",
        simics_version = "6.0.164",
        simics_version = "6.0.165",
        simics_version = "6.0.166",
        simics_version = "6.0.167",
        simics_version = "6.0.168",
        simics_version = "6.0.169",
        simics_version = "6.0.170",
        simics_version = "6.0.171",
        simics_version = "6.0.172",
        simics_version = "6.0.173",
    )),
    simics_version = "6"
))]
#[simics_exception]
/// Delete a snapshot with a name
pub fn delete_snapshot<S>(name: S) -> Result<SnapshotError>
where
    S: AsRef<str>,
{
    Ok(unsafe { crate::sys::VT_delete_snapshot(raw_cstr(name)?) })
}

// NOTE: Retrieving the total snapshot size used was added in Simics 6.0.173
#[cfg(all(
    not(any(
        simics_version = "6.0.163",
        simics_version = "6.0.164",
        simics_version = "6.0.165",
        simics_version = "6.0.166",
        simics_version = "6.0.167",
        simics_version = "6.0.168",
        simics_version = "6.0.169",
        simics_version = "6.0.170",
        simics_version = "6.0.171",
        simics_version = "6.0.172",
    )),
    simics_version = "6",
))]
#[simics_exception]
/// Get the total size used by all snapshots
pub fn snapshot_size_used() -> AttrValue {
    unsafe { crate::sys::VT_snapshot_size_used() }.into()
}

// NOTE: Listing all snapshots was added in Simics 6.0.173
#[cfg(all(
    not(any(
        simics_version = "6.0.163",
        simics_version = "6.0.164",
        simics_version = "6.0.165",
        simics_version = "6.0.166",
        simics_version = "6.0.167",
        simics_version = "6.0.168",
        simics_version = "6.0.169",
        simics_version = "6.0.170",
        simics_version = "6.0.171",
        simics_version = "6.0.172",
    )),
    simics_version = "6",
))]
#[simics_exception]
/// Get the list of all snapshots
pub fn list_snapshots() -> AttrValue {
    unsafe { crate::sys::VT_list_snapshots() }.into()
}

// NOTE: Ignoring a snapshot class was added in Simics 6.0.173
#[cfg(not(any(
    simics_version = "6.0.163",
    simics_version = "6.0.164",
    simics_version = "6.0.165",
    simics_version = "6.0.166",
    simics_version = "6.0.167",
    simics_version = "6.0.168",
    simics_version = "6.0.169",
    simics_version = "6.0.170",
    simics_version = "6.0.171",
    simics_version = "6.0.172",
)))]
#[simics_exception]
/// Set snapshots to ignore a given class by name
pub fn snapshots_ignore_class<S>(class_name: S) -> Result<()>
where
    S: AsRef<str>,
{
    unsafe { crate::sys::VT_snapshots_ignore_class(raw_cstr(class_name)?) };
    Ok(())
}

// NOTE: All Snapshot APIs are stabilized in Simics 7

#[deprecated = "Use `take_snapshot` instead`"]
#[cfg(simics_version = "7")]
#[simics_exception]
/// Take a snapshot with a name
pub fn save_snapshot<S>(name: S) -> Result<SnapshotError>
where
    S: AsRef<str>,
{
    Ok(unsafe { crate::sys::SIM_take_snapshot(raw_cstr(name)?) })
}

#[cfg(simics_version = "7")]
#[simics_exception]
/// Take a snapshot with a name
pub fn take_snapshot<S>(name: S) -> Result<SnapshotError>
where
    S: AsRef<str>,
{
    Ok(unsafe { crate::sys::SIM_take_snapshot(raw_cstr(name)?) })
}

#[cfg(simics_version = "7")]
#[simics_exception]
/// Restore a snapshot with a name
pub fn restore_snapshot<S>(name: S) -> Result<SnapshotError>
where
    S: AsRef<str>,
{
    Ok(unsafe { crate::sys::SIM_restore_snapshot(raw_cstr(name)?) })
}

#[cfg(simics_version = "7")]
#[simics_exception]
/// Delete a snapshot with a name
pub fn delete_snapshot<S>(name: S) -> Result<SnapshotError>
where
    S: AsRef<str>,
{
    Ok(unsafe { crate::sys::SIM_delete_snapshot(raw_cstr(name)?) })
}

#[cfg(simics_version = "7")]
#[simics_exception]
/// Get the list of all snapshots
pub fn list_snapshots() -> AttrValue {
    unsafe { crate::sys::SIM_list_snapshots() }.into()
}