2 * s390 storage key device
4 * Copyright 2015 IBM Corp.
5 * Author(s): Jason J. Herne <jjherne@linux.vnet.ibm.com>
7 * This work is licensed under the terms of the GNU GPL, version 2 or (at
8 * your option) any later version. See the COPYING file in the top-level
12 #include "hw/boards.h"
13 #include "qmp-commands.h"
14 #include "migration/qemu-file.h"
15 #include "hw/s390x/storage-keys.h"
16 #include "qemu/error-report.h"
18 #define S390_SKEYS_BUFFER_SIZE 131072 /* Room for 128k storage keys */
19 #define S390_SKEYS_SAVE_FLAG_EOS 0x01
20 #define S390_SKEYS_SAVE_FLAG_SKEYS 0x02
21 #define S390_SKEYS_SAVE_FLAG_ERROR 0x04
23 S390SKeysState
*s390_get_skeys_device(void)
27 ss
= S390_SKEYS(object_resolve_path_type("", TYPE_S390_SKEYS
, NULL
));
32 void s390_skeys_init(void)
37 obj
= object_new(TYPE_KVM_S390_SKEYS
);
39 obj
= object_new(TYPE_QEMU_S390_SKEYS
);
41 object_property_add_child(qdev_get_machine(), TYPE_S390_SKEYS
,
45 qdev_init_nofail(DEVICE(obj
));
48 static void write_keys(QEMUFile
*f
, uint8_t *keys
, uint64_t startgfn
,
49 uint64_t count
, Error
**errp
)
51 uint64_t curpage
= startgfn
;
52 uint64_t maxpage
= curpage
+ count
- 1;
53 const char *fmt
= "page=%03" PRIx64
": key(%d) => ACC=%X, FP=%d, REF=%d,"
54 " ch=%d, reserved=%d\n";
58 for (; curpage
<= maxpage
; curpage
++) {
59 uint8_t acc
= (*keys
& 0xF0) >> 4;
60 int fp
= (*keys
& 0x08);
61 int ref
= (*keys
& 0x04);
62 int ch
= (*keys
& 0x02);
63 int res
= (*keys
& 0x01);
65 len
= snprintf(buf
, sizeof(buf
), fmt
, curpage
,
66 *keys
, acc
, fp
, ref
, ch
, res
);
67 assert(len
< sizeof(buf
));
68 qemu_put_buffer(f
, (uint8_t *)buf
, len
);
73 void hmp_info_skeys(Monitor
*mon
, const QDict
*qdict
)
75 S390SKeysState
*ss
= s390_get_skeys_device();
76 S390SKeysClass
*skeyclass
= S390_SKEYS_GET_CLASS(ss
);
77 uint64_t addr
= qdict_get_int(qdict
, "addr");
81 /* Quick check to see if guest is using storage keys*/
82 if (!skeyclass
->skeys_enabled(ss
)) {
83 monitor_printf(mon
, "Error: This guest is not using storage keys\n");
87 r
= skeyclass
->get_skeys(ss
, addr
/ TARGET_PAGE_SIZE
, 1, &key
);
89 monitor_printf(mon
, "Error: %s\n", strerror(-r
));
93 monitor_printf(mon
, " key: 0x%X\n", key
);
96 void hmp_dump_skeys(Monitor
*mon
, const QDict
*qdict
)
98 const char *filename
= qdict_get_str(qdict
, "filename");
101 qmp_dump_skeys(filename
, &err
);
103 error_report_err(err
);
107 void qmp_dump_skeys(const char *filename
, Error
**errp
)
109 S390SKeysState
*ss
= s390_get_skeys_device();
110 S390SKeysClass
*skeyclass
= S390_SKEYS_GET_CLASS(ss
);
111 const uint64_t total_count
= ram_size
/ TARGET_PAGE_SIZE
;
112 uint64_t handled_count
= 0, cur_count
;
119 /* Quick check to see if guest is using storage keys*/
120 if (!skeyclass
->skeys_enabled(ss
)) {
121 error_setg(errp
, "This guest is not using storage keys - "
126 f
= qemu_fopen(filename
, "wb");
128 error_setg_file_open(errp
, errno
, filename
);
132 buf
= g_try_malloc(S390_SKEYS_BUFFER_SIZE
);
134 error_setg(errp
, "Could not allocate memory");
138 /* we'll only dump initial memory for now */
139 while (handled_count
< total_count
) {
140 /* Calculate how many keys to ask for & handle overflow case */
141 cur_count
= MIN(total_count
- handled_count
, S390_SKEYS_BUFFER_SIZE
);
143 ret
= skeyclass
->get_skeys(ss
, cur_gfn
, cur_count
, buf
);
145 error_setg(errp
, "get_keys error %d", ret
);
149 /* write keys to stream */
150 write_keys(f
, buf
, cur_gfn
, cur_count
, &lerr
);
155 cur_gfn
+= cur_count
;
156 handled_count
+= cur_count
;
160 error_propagate(errp
, lerr
);
166 static void qemu_s390_skeys_init(Object
*obj
)
168 QEMUS390SKeysState
*skeys
= QEMU_S390_SKEYS(obj
);
169 MachineState
*machine
= MACHINE(qdev_get_machine());
171 skeys
->key_count
= machine
->maxram_size
/ TARGET_PAGE_SIZE
;
172 skeys
->keydata
= g_malloc0(skeys
->key_count
);
175 static int qemu_s390_skeys_enabled(S390SKeysState
*ss
)
181 * TODO: for memory hotplug support qemu_s390_skeys_set and qemu_s390_skeys_get
182 * will have to make sure that the given gfn belongs to a memory region and not
185 static int qemu_s390_skeys_set(S390SKeysState
*ss
, uint64_t start_gfn
,
186 uint64_t count
, uint8_t *keys
)
188 QEMUS390SKeysState
*skeydev
= QEMU_S390_SKEYS(ss
);
191 /* Check for uint64 overflow and access beyond end of key data */
192 if (start_gfn
+ count
> skeydev
->key_count
|| start_gfn
+ count
< count
) {
193 error_report("Error: Setting storage keys for page beyond the end "
194 "of memory: gfn=%" PRIx64
" count=%" PRId64
,
199 for (i
= 0; i
< count
; i
++) {
200 skeydev
->keydata
[start_gfn
+ i
] = keys
[i
];
205 static int qemu_s390_skeys_get(S390SKeysState
*ss
, uint64_t start_gfn
,
206 uint64_t count
, uint8_t *keys
)
208 QEMUS390SKeysState
*skeydev
= QEMU_S390_SKEYS(ss
);
211 /* Check for uint64 overflow and access beyond end of key data */
212 if (start_gfn
+ count
> skeydev
->key_count
|| start_gfn
+ count
< count
) {
213 error_report("Error: Getting storage keys for page beyond the end "
214 "of memory: gfn=%" PRIx64
" count=%" PRId64
,
219 for (i
= 0; i
< count
; i
++) {
220 keys
[i
] = skeydev
->keydata
[start_gfn
+ i
];
225 static void qemu_s390_skeys_class_init(ObjectClass
*oc
, void *data
)
227 S390SKeysClass
*skeyclass
= S390_SKEYS_CLASS(oc
);
229 skeyclass
->skeys_enabled
= qemu_s390_skeys_enabled
;
230 skeyclass
->get_skeys
= qemu_s390_skeys_get
;
231 skeyclass
->set_skeys
= qemu_s390_skeys_set
;
234 static const TypeInfo qemu_s390_skeys_info
= {
235 .name
= TYPE_QEMU_S390_SKEYS
,
236 .parent
= TYPE_S390_SKEYS
,
237 .instance_init
= qemu_s390_skeys_init
,
238 .instance_size
= sizeof(QEMUS390SKeysState
),
239 .class_init
= qemu_s390_skeys_class_init
,
240 .class_size
= sizeof(S390SKeysClass
),
243 static void s390_storage_keys_save(QEMUFile
*f
, void *opaque
)
245 S390SKeysState
*ss
= S390_SKEYS(opaque
);
246 S390SKeysClass
*skeyclass
= S390_SKEYS_GET_CLASS(ss
);
247 uint64_t pages_left
= ram_size
/ TARGET_PAGE_SIZE
;
248 uint64_t read_count
, eos
= S390_SKEYS_SAVE_FLAG_EOS
;
253 if (!skeyclass
->skeys_enabled(ss
)) {
257 buf
= g_try_malloc(S390_SKEYS_BUFFER_SIZE
);
259 error_report("storage key save could not allocate memory");
263 /* We only support initial memory. Standby memory is not handled yet. */
264 qemu_put_be64(f
, (cur_gfn
* TARGET_PAGE_SIZE
) | S390_SKEYS_SAVE_FLAG_SKEYS
);
265 qemu_put_be64(f
, pages_left
);
268 read_count
= MIN(pages_left
, S390_SKEYS_BUFFER_SIZE
);
271 error
= skeyclass
->get_skeys(ss
, cur_gfn
, read_count
, buf
);
274 * If error: we want to fill the stream with valid data instead
275 * of stopping early so we pad the stream with 0x00 values and
276 * use S390_SKEYS_SAVE_FLAG_ERROR to indicate failure to the
279 error_report("S390_GET_KEYS error %d", error
);
280 memset(buf
, 0, S390_SKEYS_BUFFER_SIZE
);
281 eos
= S390_SKEYS_SAVE_FLAG_ERROR
;
285 qemu_put_buffer(f
, buf
, read_count
);
286 cur_gfn
+= read_count
;
287 pages_left
-= read_count
;
292 qemu_put_be64(f
, eos
);
295 static int s390_storage_keys_load(QEMUFile
*f
, void *opaque
, int version_id
)
297 S390SKeysState
*ss
= S390_SKEYS(opaque
);
298 S390SKeysClass
*skeyclass
= S390_SKEYS_GET_CLASS(ss
);
305 addr
= qemu_get_be64(f
);
306 flags
= addr
& ~TARGET_PAGE_MASK
;
307 addr
&= TARGET_PAGE_MASK
;
310 case S390_SKEYS_SAVE_FLAG_SKEYS
: {
311 const uint64_t total_count
= qemu_get_be64(f
);
312 uint64_t handled_count
= 0, cur_count
;
313 uint64_t cur_gfn
= addr
/ TARGET_PAGE_SIZE
;
314 uint8_t *buf
= g_try_malloc(S390_SKEYS_BUFFER_SIZE
);
317 error_report("storage key load could not allocate memory");
322 while (handled_count
< total_count
) {
323 cur_count
= MIN(total_count
- handled_count
,
324 S390_SKEYS_BUFFER_SIZE
);
325 qemu_get_buffer(f
, buf
, cur_count
);
327 ret
= skeyclass
->set_skeys(ss
, cur_gfn
, cur_count
, buf
);
329 error_report("S390_SET_KEYS error %d", ret
);
332 handled_count
+= cur_count
;
333 cur_gfn
+= cur_count
;
338 case S390_SKEYS_SAVE_FLAG_ERROR
: {
339 error_report("Storage key data is incomplete");
343 case S390_SKEYS_SAVE_FLAG_EOS
:
347 error_report("Unexpected storage key flag data: %#x", flags
);
355 static inline bool s390_skeys_get_migration_enabled(Object
*obj
, Error
**errp
)
357 S390SKeysState
*ss
= S390_SKEYS(obj
);
359 return ss
->migration_enabled
;
362 static inline void s390_skeys_set_migration_enabled(Object
*obj
, bool value
,
365 S390SKeysState
*ss
= S390_SKEYS(obj
);
367 /* Prevent double registration of savevm handler */
368 if (ss
->migration_enabled
== value
) {
372 ss
->migration_enabled
= value
;
374 if (ss
->migration_enabled
) {
375 register_savevm(NULL
, TYPE_S390_SKEYS
, 0, 1, s390_storage_keys_save
,
376 s390_storage_keys_load
, ss
);
378 unregister_savevm(DEVICE(ss
), TYPE_S390_SKEYS
, ss
);
382 static void s390_skeys_instance_init(Object
*obj
)
384 object_property_add_bool(obj
, "migration-enabled",
385 s390_skeys_get_migration_enabled
,
386 s390_skeys_set_migration_enabled
, NULL
);
387 object_property_set_bool(obj
, true, "migration-enabled", NULL
);
390 static void s390_skeys_class_init(ObjectClass
*oc
, void *data
)
392 DeviceClass
*dc
= DEVICE_CLASS(oc
);
394 dc
->hotpluggable
= false;
395 set_bit(DEVICE_CATEGORY_MISC
, dc
->categories
);
398 static const TypeInfo s390_skeys_info
= {
399 .name
= TYPE_S390_SKEYS
,
400 .parent
= TYPE_DEVICE
,
401 .instance_init
= s390_skeys_instance_init
,
402 .instance_size
= sizeof(S390SKeysState
),
403 .class_init
= s390_skeys_class_init
,
404 .class_size
= sizeof(S390SKeysClass
),
408 static void qemu_s390_skeys_register_types(void)
410 type_register_static(&s390_skeys_info
);
411 type_register_static(&qemu_s390_skeys_info
);
414 type_init(qemu_s390_skeys_register_types
)