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 "qemu/osdep.h"
13 #include "hw/boards.h"
14 #include "hw/s390x/storage-keys.h"
15 #include "qapi/error.h"
16 #include "qapi/qapi-commands-misc.h"
17 #include "qapi/qmp/qdict.h"
18 #include "qemu/error-report.h"
19 #include "sysemu/kvm.h"
20 #include "migration/register.h"
22 #define S390_SKEYS_BUFFER_SIZE 131072 /* Room for 128k storage keys */
23 #define S390_SKEYS_SAVE_FLAG_EOS 0x01
24 #define S390_SKEYS_SAVE_FLAG_SKEYS 0x02
25 #define S390_SKEYS_SAVE_FLAG_ERROR 0x04
27 S390SKeysState
*s390_get_skeys_device(void)
31 ss
= S390_SKEYS(object_resolve_path_type("", TYPE_S390_SKEYS
, NULL
));
36 void s390_skeys_init(void)
41 obj
= object_new(TYPE_KVM_S390_SKEYS
);
43 obj
= object_new(TYPE_QEMU_S390_SKEYS
);
45 object_property_add_child(qdev_get_machine(), TYPE_S390_SKEYS
,
49 qdev_init_nofail(DEVICE(obj
));
52 static void write_keys(FILE *f
, uint8_t *keys
, uint64_t startgfn
,
53 uint64_t count
, Error
**errp
)
55 uint64_t curpage
= startgfn
;
56 uint64_t maxpage
= curpage
+ count
- 1;
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 fprintf(f
, "page=%03" PRIx64
": key(%d) => ACC=%X, FP=%d, REF=%d,"
66 " ch=%d, reserved=%d\n",
67 curpage
, *keys
, acc
, fp
, ref
, ch
, res
);
72 void hmp_info_skeys(Monitor
*mon
, const QDict
*qdict
)
74 S390SKeysState
*ss
= s390_get_skeys_device();
75 S390SKeysClass
*skeyclass
= S390_SKEYS_GET_CLASS(ss
);
76 uint64_t addr
= qdict_get_int(qdict
, "addr");
80 /* Quick check to see if guest is using storage keys*/
81 if (!skeyclass
->skeys_enabled(ss
)) {
82 monitor_printf(mon
, "Error: This guest is not using storage keys\n");
86 r
= skeyclass
->get_skeys(ss
, addr
/ TARGET_PAGE_SIZE
, 1, &key
);
88 monitor_printf(mon
, "Error: %s\n", strerror(-r
));
92 monitor_printf(mon
, " key: 0x%X\n", key
);
95 void hmp_dump_skeys(Monitor
*mon
, const QDict
*qdict
)
97 const char *filename
= qdict_get_str(qdict
, "filename");
100 qmp_dump_skeys(filename
, &err
);
102 error_report_err(err
);
106 void qmp_dump_skeys(const char *filename
, Error
**errp
)
108 S390SKeysState
*ss
= s390_get_skeys_device();
109 S390SKeysClass
*skeyclass
= S390_SKEYS_GET_CLASS(ss
);
110 const uint64_t total_count
= ram_size
/ TARGET_PAGE_SIZE
;
111 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 fd
= qemu_open(filename
, O_WRONLY
| O_CREAT
| O_TRUNC
, 0600);
128 error_setg_file_open(errp
, errno
, filename
);
131 f
= fdopen(fd
, "wb");
134 error_setg_file_open(errp
, errno
, filename
);
138 buf
= g_try_malloc(S390_SKEYS_BUFFER_SIZE
);
140 error_setg(errp
, "Could not allocate memory");
144 /* we'll only dump initial memory for now */
145 while (handled_count
< total_count
) {
146 /* Calculate how many keys to ask for & handle overflow case */
147 cur_count
= MIN(total_count
- handled_count
, S390_SKEYS_BUFFER_SIZE
);
149 ret
= skeyclass
->get_skeys(ss
, cur_gfn
, cur_count
, buf
);
151 error_setg(errp
, "get_keys error %d", ret
);
155 /* write keys to stream */
156 write_keys(f
, buf
, cur_gfn
, cur_count
, &lerr
);
161 cur_gfn
+= cur_count
;
162 handled_count
+= cur_count
;
166 error_propagate(errp
, lerr
);
172 static void qemu_s390_skeys_init(Object
*obj
)
174 QEMUS390SKeysState
*skeys
= QEMU_S390_SKEYS(obj
);
175 MachineState
*machine
= MACHINE(qdev_get_machine());
177 skeys
->key_count
= machine
->maxram_size
/ TARGET_PAGE_SIZE
;
178 skeys
->keydata
= g_malloc0(skeys
->key_count
);
181 static int qemu_s390_skeys_enabled(S390SKeysState
*ss
)
187 * TODO: for memory hotplug support qemu_s390_skeys_set and qemu_s390_skeys_get
188 * will have to make sure that the given gfn belongs to a memory region and not
191 static int qemu_s390_skeys_set(S390SKeysState
*ss
, uint64_t start_gfn
,
192 uint64_t count
, uint8_t *keys
)
194 QEMUS390SKeysState
*skeydev
= QEMU_S390_SKEYS(ss
);
197 /* Check for uint64 overflow and access beyond end of key data */
198 if (start_gfn
+ count
> skeydev
->key_count
|| start_gfn
+ count
< count
) {
199 error_report("Error: Setting storage keys for page beyond the end "
200 "of memory: gfn=%" PRIx64
" count=%" PRId64
,
205 for (i
= 0; i
< count
; i
++) {
206 skeydev
->keydata
[start_gfn
+ i
] = keys
[i
];
211 static int qemu_s390_skeys_get(S390SKeysState
*ss
, uint64_t start_gfn
,
212 uint64_t count
, uint8_t *keys
)
214 QEMUS390SKeysState
*skeydev
= QEMU_S390_SKEYS(ss
);
217 /* Check for uint64 overflow and access beyond end of key data */
218 if (start_gfn
+ count
> skeydev
->key_count
|| start_gfn
+ count
< count
) {
219 error_report("Error: Getting storage keys for page beyond the end "
220 "of memory: gfn=%" PRIx64
" count=%" PRId64
,
225 for (i
= 0; i
< count
; i
++) {
226 keys
[i
] = skeydev
->keydata
[start_gfn
+ i
];
231 static void qemu_s390_skeys_class_init(ObjectClass
*oc
, void *data
)
233 S390SKeysClass
*skeyclass
= S390_SKEYS_CLASS(oc
);
234 DeviceClass
*dc
= DEVICE_CLASS(oc
);
236 skeyclass
->skeys_enabled
= qemu_s390_skeys_enabled
;
237 skeyclass
->get_skeys
= qemu_s390_skeys_get
;
238 skeyclass
->set_skeys
= qemu_s390_skeys_set
;
240 /* Reason: Internal device (only one skeys device for the whole memory) */
241 dc
->user_creatable
= false;
244 static const TypeInfo qemu_s390_skeys_info
= {
245 .name
= TYPE_QEMU_S390_SKEYS
,
246 .parent
= TYPE_S390_SKEYS
,
247 .instance_init
= qemu_s390_skeys_init
,
248 .instance_size
= sizeof(QEMUS390SKeysState
),
249 .class_init
= qemu_s390_skeys_class_init
,
250 .class_size
= sizeof(S390SKeysClass
),
253 static void s390_storage_keys_save(QEMUFile
*f
, void *opaque
)
255 S390SKeysState
*ss
= S390_SKEYS(opaque
);
256 S390SKeysClass
*skeyclass
= S390_SKEYS_GET_CLASS(ss
);
257 uint64_t pages_left
= ram_size
/ TARGET_PAGE_SIZE
;
258 uint64_t read_count
, eos
= S390_SKEYS_SAVE_FLAG_EOS
;
263 if (!skeyclass
->skeys_enabled(ss
)) {
267 buf
= g_try_malloc(S390_SKEYS_BUFFER_SIZE
);
269 error_report("storage key save could not allocate memory");
273 /* We only support initial memory. Standby memory is not handled yet. */
274 qemu_put_be64(f
, (cur_gfn
* TARGET_PAGE_SIZE
) | S390_SKEYS_SAVE_FLAG_SKEYS
);
275 qemu_put_be64(f
, pages_left
);
278 read_count
= MIN(pages_left
, S390_SKEYS_BUFFER_SIZE
);
281 error
= skeyclass
->get_skeys(ss
, cur_gfn
, read_count
, buf
);
284 * If error: we want to fill the stream with valid data instead
285 * of stopping early so we pad the stream with 0x00 values and
286 * use S390_SKEYS_SAVE_FLAG_ERROR to indicate failure to the
289 error_report("S390_GET_KEYS error %d", error
);
290 memset(buf
, 0, S390_SKEYS_BUFFER_SIZE
);
291 eos
= S390_SKEYS_SAVE_FLAG_ERROR
;
295 qemu_put_buffer(f
, buf
, read_count
);
296 cur_gfn
+= read_count
;
297 pages_left
-= read_count
;
302 qemu_put_be64(f
, eos
);
305 static int s390_storage_keys_load(QEMUFile
*f
, void *opaque
, int version_id
)
307 S390SKeysState
*ss
= S390_SKEYS(opaque
);
308 S390SKeysClass
*skeyclass
= S390_SKEYS_GET_CLASS(ss
);
315 addr
= qemu_get_be64(f
);
316 flags
= addr
& ~TARGET_PAGE_MASK
;
317 addr
&= TARGET_PAGE_MASK
;
320 case S390_SKEYS_SAVE_FLAG_SKEYS
: {
321 const uint64_t total_count
= qemu_get_be64(f
);
322 uint64_t handled_count
= 0, cur_count
;
323 uint64_t cur_gfn
= addr
/ TARGET_PAGE_SIZE
;
324 uint8_t *buf
= g_try_malloc(S390_SKEYS_BUFFER_SIZE
);
327 error_report("storage key load could not allocate memory");
332 while (handled_count
< total_count
) {
333 cur_count
= MIN(total_count
- handled_count
,
334 S390_SKEYS_BUFFER_SIZE
);
335 qemu_get_buffer(f
, buf
, cur_count
);
337 ret
= skeyclass
->set_skeys(ss
, cur_gfn
, cur_count
, buf
);
339 error_report("S390_SET_KEYS error %d", ret
);
342 handled_count
+= cur_count
;
343 cur_gfn
+= cur_count
;
348 case S390_SKEYS_SAVE_FLAG_ERROR
: {
349 error_report("Storage key data is incomplete");
353 case S390_SKEYS_SAVE_FLAG_EOS
:
357 error_report("Unexpected storage key flag data: %#x", flags
);
365 static inline bool s390_skeys_get_migration_enabled(Object
*obj
, Error
**errp
)
367 S390SKeysState
*ss
= S390_SKEYS(obj
);
369 return ss
->migration_enabled
;
372 static SaveVMHandlers savevm_s390_storage_keys
= {
373 .save_state
= s390_storage_keys_save
,
374 .load_state
= s390_storage_keys_load
,
377 static inline void s390_skeys_set_migration_enabled(Object
*obj
, bool value
,
380 S390SKeysState
*ss
= S390_SKEYS(obj
);
382 /* Prevent double registration of savevm handler */
383 if (ss
->migration_enabled
== value
) {
387 ss
->migration_enabled
= value
;
389 if (ss
->migration_enabled
) {
390 register_savevm_live(NULL
, TYPE_S390_SKEYS
, 0, 1,
391 &savevm_s390_storage_keys
, ss
);
393 unregister_savevm(DEVICE(ss
), TYPE_S390_SKEYS
, ss
);
397 static void s390_skeys_instance_init(Object
*obj
)
399 object_property_add_bool(obj
, "migration-enabled",
400 s390_skeys_get_migration_enabled
,
401 s390_skeys_set_migration_enabled
, NULL
);
402 object_property_set_bool(obj
, true, "migration-enabled", NULL
);
405 static void s390_skeys_class_init(ObjectClass
*oc
, void *data
)
407 DeviceClass
*dc
= DEVICE_CLASS(oc
);
409 dc
->hotpluggable
= false;
410 set_bit(DEVICE_CATEGORY_MISC
, dc
->categories
);
413 static const TypeInfo s390_skeys_info
= {
414 .name
= TYPE_S390_SKEYS
,
415 .parent
= TYPE_DEVICE
,
416 .instance_init
= s390_skeys_instance_init
,
417 .instance_size
= sizeof(S390SKeysState
),
418 .class_init
= s390_skeys_class_init
,
419 .class_size
= sizeof(S390SKeysClass
),
423 static void qemu_s390_skeys_register_types(void)
425 type_register_static(&s390_skeys_info
);
426 type_register_static(&qemu_s390_skeys_info
);
429 type_init(qemu_s390_skeys_register_types
)