target/ppc: Fix slbia TLB invalidation gap
[qemu.git] / docs / devel / migration.rst
1 =========
2 Migration
3 =========
4
5 QEMU has code to load/save the state of the guest that it is running.
6 These are two complementary operations.  Saving the state just does
7 that, saves the state for each device that the guest is running.
8 Restoring a guest is just the opposite operation: we need to load the
9 state of each device.
10
11 For this to work, QEMU has to be launched with the same arguments the
12 two times.  I.e. it can only restore the state in one guest that has
13 the same devices that the one it was saved (this last requirement can
14 be relaxed a bit, but for now we can consider that configuration has
15 to be exactly the same).
16
17 Once that we are able to save/restore a guest, a new functionality is
18 requested: migration.  This means that QEMU is able to start in one
19 machine and being "migrated" to another machine.  I.e. being moved to
20 another machine.
21
22 Next was the "live migration" functionality.  This is important
23 because some guests run with a lot of state (specially RAM), and it
24 can take a while to move all state from one machine to another.  Live
25 migration allows the guest to continue running while the state is
26 transferred.  Only while the last part of the state is transferred has
27 the guest to be stopped.  Typically the time that the guest is
28 unresponsive during live migration is the low hundred of milliseconds
29 (notice that this depends on a lot of things).
30
31 Transports
32 ==========
33
34 The migration stream is normally just a byte stream that can be passed
35 over any transport.
36
37 - tcp migration: do the migration using tcp sockets
38 - unix migration: do the migration using unix sockets
39 - exec migration: do the migration using the stdin/stdout through a process.
40 - fd migration: do the migration using a file descriptor that is
41   passed to QEMU.  QEMU doesn't care how this file descriptor is opened.
42
43 In addition, support is included for migration using RDMA, which
44 transports the page data using ``RDMA``, where the hardware takes care of
45 transporting the pages, and the load on the CPU is much lower.  While the
46 internals of RDMA migration are a bit different, this isn't really visible
47 outside the RAM migration code.
48
49 All these migration protocols use the same infrastructure to
50 save/restore state devices.  This infrastructure is shared with the
51 savevm/loadvm functionality.
52
53 Common infrastructure
54 =====================
55
56 The files, sockets or fd's that carry the migration stream are abstracted by
57 the  ``QEMUFile`` type (see `migration/qemu-file.h`).  In most cases this
58 is connected to a subtype of ``QIOChannel`` (see `io/`).
59
60
61 Saving the state of one device
62 ==============================
63
64 For most devices, the state is saved in a single call to the migration
65 infrastructure; these are *non-iterative* devices.  The data for these
66 devices is sent at the end of precopy migration, when the CPUs are paused.
67 There are also *iterative* devices, which contain a very large amount of
68 data (e.g. RAM or large tables).  See the iterative device section below.
69
70 General advice for device developers
71 ------------------------------------
72
73 - The migration state saved should reflect the device being modelled rather
74   than the way your implementation works.  That way if you change the implementation
75   later the migration stream will stay compatible.  That model may include
76   internal state that's not directly visible in a register.
77
78 - When saving a migration stream the device code may walk and check
79   the state of the device.  These checks might fail in various ways (e.g.
80   discovering internal state is corrupt or that the guest has done something bad).
81   Consider carefully before asserting/aborting at this point, since the
82   normal response from users is that *migration broke their VM* since it had
83   apparently been running fine until then.  In these error cases, the device
84   should log a message indicating the cause of error, and should consider
85   putting the device into an error state, allowing the rest of the VM to
86   continue execution.
87
88 - The migration might happen at an inconvenient point,
89   e.g. right in the middle of the guest reprogramming the device, during
90   guest reboot or shutdown or while the device is waiting for external IO.
91   It's strongly preferred that migrations do not fail in this situation,
92   since in the cloud environment migrations might happen automatically to
93   VMs that the administrator doesn't directly control.
94
95 - If you do need to fail a migration, ensure that sufficient information
96   is logged to identify what went wrong.
97
98 - The destination should treat an incoming migration stream as hostile
99   (which we do to varying degrees in the existing code).  Check that offsets
100   into buffers and the like can't cause overruns.  Fail the incoming migration
101   in the case of a corrupted stream like this.
102
103 - Take care with internal device state or behaviour that might become
104   migration version dependent.  For example, the order of PCI capabilities
105   is required to stay constant across migration.  Another example would
106   be that a special case handled by subsections (see below) might become
107   much more common if a default behaviour is changed.
108
109 - The state of the source should not be changed or destroyed by the
110   outgoing migration.  Migrations timing out or being failed by
111   higher levels of management, or failures of the destination host are
112   not unusual, and in that case the VM is restarted on the source.
113   Note that the management layer can validly revert the migration
114   even though the QEMU level of migration has succeeded as long as it
115   does it before starting execution on the destination.
116
117 - Buses and devices should be able to explicitly specify addresses when
118   instantiated, and management tools should use those.  For example,
119   when hot adding USB devices it's important to specify the ports
120   and addresses, since implicit ordering based on the command line order
121   may be different on the destination.  This can result in the
122   device state being loaded into the wrong device.
123
124 VMState
125 -------
126
127 Most device data can be described using the ``VMSTATE`` macros (mostly defined
128 in ``include/migration/vmstate.h``).
129
130 An example (from hw/input/pckbd.c)
131
132 .. code:: c
133
134   static const VMStateDescription vmstate_kbd = {
135       .name = "pckbd",
136       .version_id = 3,
137       .minimum_version_id = 3,
138       .fields = (VMStateField[]) {
139           VMSTATE_UINT8(write_cmd, KBDState),
140           VMSTATE_UINT8(status, KBDState),
141           VMSTATE_UINT8(mode, KBDState),
142           VMSTATE_UINT8(pending, KBDState),
143           VMSTATE_END_OF_LIST()
144       }
145   };
146
147 We are declaring the state with name "pckbd".
148 The `version_id` is 3, and the fields are 4 uint8_t in a KBDState structure.
149 We registered this with:
150
151 .. code:: c
152
153     vmstate_register(NULL, 0, &vmstate_kbd, s);
154
155 For devices that are `qdev` based, we can register the device in the class
156 init function:
157
158 .. code:: c
159
160     dc->vmsd = &vmstate_kbd_isa;
161
162 The VMState macros take care of ensuring that the device data section
163 is formatted portably (normally big endian) and make some compile time checks
164 against the types of the fields in the structures.
165
166 VMState macros can include other VMStateDescriptions to store substructures
167 (see ``VMSTATE_STRUCT_``), arrays (``VMSTATE_ARRAY_``) and variable length
168 arrays (``VMSTATE_VARRAY_``).  Various other macros exist for special
169 cases.
170
171 Note that the format on the wire is still very raw; i.e. a VMSTATE_UINT32
172 ends up with a 4 byte bigendian representation on the wire; in the future
173 it might be possible to use a more structured format.
174
175 Legacy way
176 ----------
177
178 This way is going to disappear as soon as all current users are ported to VMSTATE;
179 although converting existing code can be tricky, and thus 'soon' is relative.
180
181 Each device has to register two functions, one to save the state and
182 another to load the state back.
183
184 .. code:: c
185
186   int register_savevm_live(const char *idstr,
187                            int instance_id,
188                            int version_id,
189                            SaveVMHandlers *ops,
190                            void *opaque);
191
192 Two functions in the ``ops`` structure are the `save_state`
193 and `load_state` functions.  Notice that `load_state` receives a version_id
194 parameter to know what state format is receiving.  `save_state` doesn't
195 have a version_id parameter because it always uses the latest version.
196
197 Note that because the VMState macros still save the data in a raw
198 format, in many cases it's possible to replace legacy code
199 with a carefully constructed VMState description that matches the
200 byte layout of the existing code.
201
202 Changing migration data structures
203 ----------------------------------
204
205 When we migrate a device, we save/load the state as a series
206 of fields.  Sometimes, due to bugs or new functionality, we need to
207 change the state to store more/different information.  Changing the migration
208 state saved for a device can break migration compatibility unless
209 care is taken to use the appropriate techniques.  In general QEMU tries
210 to maintain forward migration compatibility (i.e. migrating from
211 QEMU n->n+1) and there are users who benefit from backward compatibility
212 as well.
213
214 Subsections
215 -----------
216
217 The most common structure change is adding new data, e.g. when adding
218 a newer form of device, or adding that state that you previously
219 forgot to migrate.  This is best solved using a subsection.
220
221 A subsection is "like" a device vmstate, but with a particularity, it
222 has a Boolean function that tells if that values are needed to be sent
223 or not.  If this functions returns false, the subsection is not sent.
224 Subsections have a unique name, that is looked for on the receiving
225 side.
226
227 On the receiving side, if we found a subsection for a device that we
228 don't understand, we just fail the migration.  If we understand all
229 the subsections, then we load the state with success.  There's no check
230 that a subsection is loaded, so a newer QEMU that knows about a subsection
231 can (with care) load a stream from an older QEMU that didn't send
232 the subsection.
233
234 If the new data is only needed in a rare case, then the subsection
235 can be made conditional on that case and the migration will still
236 succeed to older QEMUs in most cases.  This is OK for data that's
237 critical, but in some use cases it's preferred that the migration
238 should succeed even with the data missing.  To support this the
239 subsection can be connected to a device property and from there
240 to a versioned machine type.
241
242 The 'pre_load' and 'post_load' functions on subsections are only
243 called if the subsection is loaded.
244
245 One important note is that the outer post_load() function is called "after"
246 loading all subsections, because a newer subsection could change the same
247 value that it uses.  A flag, and the combination of outer pre_load and
248 post_load can be used to detect whether a subsection was loaded, and to
249 fall back on default behaviour when the subsection isn't present.
250
251 Example:
252
253 .. code:: c
254
255   static bool ide_drive_pio_state_needed(void *opaque)
256   {
257       IDEState *s = opaque;
258
259       return ((s->status & DRQ_STAT) != 0)
260           || (s->bus->error_status & BM_STATUS_PIO_RETRY);
261   }
262
263   const VMStateDescription vmstate_ide_drive_pio_state = {
264       .name = "ide_drive/pio_state",
265       .version_id = 1,
266       .minimum_version_id = 1,
267       .pre_save = ide_drive_pio_pre_save,
268       .post_load = ide_drive_pio_post_load,
269       .needed = ide_drive_pio_state_needed,
270       .fields = (VMStateField[]) {
271           VMSTATE_INT32(req_nb_sectors, IDEState),
272           VMSTATE_VARRAY_INT32(io_buffer, IDEState, io_buffer_total_len, 1,
273                                vmstate_info_uint8, uint8_t),
274           VMSTATE_INT32(cur_io_buffer_offset, IDEState),
275           VMSTATE_INT32(cur_io_buffer_len, IDEState),
276           VMSTATE_UINT8(end_transfer_fn_idx, IDEState),
277           VMSTATE_INT32(elementary_transfer_size, IDEState),
278           VMSTATE_INT32(packet_transfer_size, IDEState),
279           VMSTATE_END_OF_LIST()
280       }
281   };
282
283   const VMStateDescription vmstate_ide_drive = {
284       .name = "ide_drive",
285       .version_id = 3,
286       .minimum_version_id = 0,
287       .post_load = ide_drive_post_load,
288       .fields = (VMStateField[]) {
289           .... several fields ....
290           VMSTATE_END_OF_LIST()
291       },
292       .subsections = (const VMStateDescription*[]) {
293           &vmstate_ide_drive_pio_state,
294           NULL
295       }
296   };
297
298 Here we have a subsection for the pio state.  We only need to
299 save/send this state when we are in the middle of a pio operation
300 (that is what ``ide_drive_pio_state_needed()`` checks).  If DRQ_STAT is
301 not enabled, the values on that fields are garbage and don't need to
302 be sent.
303
304 Connecting subsections to properties
305 ------------------------------------
306
307 Using a condition function that checks a 'property' to determine whether
308 to send a subsection allows backward migration compatibility when
309 new subsections are added, especially when combined with versioned
310 machine types.
311
312 For example:
313
314    a) Add a new property using ``DEFINE_PROP_BOOL`` - e.g. support-foo and
315       default it to true.
316    b) Add an entry to the ``hw_compat_`` for the previous version that sets
317       the property to false.
318    c) Add a static bool  support_foo function that tests the property.
319    d) Add a subsection with a .needed set to the support_foo function
320    e) (potentially) Add an outer pre_load that sets up a default value
321       for 'foo' to be used if the subsection isn't loaded.
322
323 Now that subsection will not be generated when using an older
324 machine type and the migration stream will be accepted by older
325 QEMU versions.
326
327 Not sending existing elements
328 -----------------------------
329
330 Sometimes members of the VMState are no longer needed:
331
332   - removing them will break migration compatibility
333
334   - making them version dependent and bumping the version will break backward migration
335     compatibility.
336
337 Adding a dummy field into the migration stream is normally the best way to preserve
338 compatibility.
339
340 If the field really does need to be removed then:
341
342   a) Add a new property/compatibility/function in the same way for subsections above.
343   b) replace the VMSTATE macro with the _TEST version of the macro, e.g.:
344
345    ``VMSTATE_UINT32(foo, barstruct)``
346
347    becomes
348
349    ``VMSTATE_UINT32_TEST(foo, barstruct, pre_version_baz)``
350
351    Sometime in the future when we no longer care about the ancient versions these can be killed off.
352    Note that for backward compatibility it's important to fill in the structure with
353    data that the destination will understand.
354
355 Any difference in the predicates on the source and destination will end up
356 with different fields being enabled and data being loaded into the wrong
357 fields; for this reason conditional fields like this are very fragile.
358
359 Versions
360 --------
361
362 Version numbers are intended for major incompatible changes to the
363 migration of a device, and using them breaks backward-migration
364 compatibility; in general most changes can be made by adding Subsections
365 (see above) or _TEST macros (see above) which won't break compatibility.
366
367 Each version is associated with a series of fields saved.  The `save_state` always saves
368 the state as the newer version.  But `load_state` sometimes is able to
369 load state from an older version.
370
371 You can see that there are several version fields:
372
373 - `version_id`: the maximum version_id supported by VMState for that device.
374 - `minimum_version_id`: the minimum version_id that VMState is able to understand
375   for that device.
376 - `minimum_version_id_old`: For devices that were not able to port to vmstate, we can
377   assign a function that knows how to read this old state. This field is
378   ignored if there is no `load_state_old` handler.
379
380 VMState is able to read versions from minimum_version_id to
381 version_id.  And the function ``load_state_old()`` (if present) is able to
382 load state from minimum_version_id_old to minimum_version_id.  This
383 function is deprecated and will be removed when no more users are left.
384
385 There are *_V* forms of many ``VMSTATE_`` macros to load fields for version dependent fields,
386 e.g.
387
388 .. code:: c
389
390    VMSTATE_UINT16_V(ip_id, Slirp, 2),
391
392 only loads that field for versions 2 and newer.
393
394 Saving state will always create a section with the 'version_id' value
395 and thus can't be loaded by any older QEMU.
396
397 Massaging functions
398 -------------------
399
400 Sometimes, it is not enough to be able to save the state directly
401 from one structure, we need to fill the correct values there.  One
402 example is when we are using kvm.  Before saving the cpu state, we
403 need to ask kvm to copy to QEMU the state that it is using.  And the
404 opposite when we are loading the state, we need a way to tell kvm to
405 load the state for the cpu that we have just loaded from the QEMUFile.
406
407 The functions to do that are inside a vmstate definition, and are called:
408
409 - ``int (*pre_load)(void *opaque);``
410
411   This function is called before we load the state of one device.
412
413 - ``int (*post_load)(void *opaque, int version_id);``
414
415   This function is called after we load the state of one device.
416
417 - ``int (*pre_save)(void *opaque);``
418
419   This function is called before we save the state of one device.
420
421 - ``int (*post_save)(void *opaque);``
422
423   This function is called after we save the state of one device
424   (even upon failure, unless the call to pre_save returned an error).
425
426 Example: You can look at hpet.c, that uses the first three functions
427 to massage the state that is transferred.
428
429 The ``VMSTATE_WITH_TMP`` macro may be useful when the migration
430 data doesn't match the stored device data well; it allows an
431 intermediate temporary structure to be populated with migration
432 data and then transferred to the main structure.
433
434 If you use memory API functions that update memory layout outside
435 initialization (i.e., in response to a guest action), this is a strong
436 indication that you need to call these functions in a `post_load` callback.
437 Examples of such memory API functions are:
438
439   - memory_region_add_subregion()
440   - memory_region_del_subregion()
441   - memory_region_set_readonly()
442   - memory_region_set_nonvolatile()
443   - memory_region_set_enabled()
444   - memory_region_set_address()
445   - memory_region_set_alias_offset()
446
447 Iterative device migration
448 --------------------------
449
450 Some devices, such as RAM, Block storage or certain platform devices,
451 have large amounts of data that would mean that the CPUs would be
452 paused for too long if they were sent in one section.  For these
453 devices an *iterative* approach is taken.
454
455 The iterative devices generally don't use VMState macros
456 (although it may be possible in some cases) and instead use
457 qemu_put_*/qemu_get_* macros to read/write data to the stream.  Specialist
458 versions exist for high bandwidth IO.
459
460
461 An iterative device must provide:
462
463   - A ``save_setup`` function that initialises the data structures and
464     transmits a first section containing information on the device.  In the
465     case of RAM this transmits a list of RAMBlocks and sizes.
466
467   - A ``load_setup`` function that initialises the data structures on the
468     destination.
469
470   - A ``save_live_pending`` function that is called repeatedly and must
471     indicate how much more data the iterative data must save.  The core
472     migration code will use this to determine when to pause the CPUs
473     and complete the migration.
474
475   - A ``save_live_iterate`` function (called after ``save_live_pending``
476     when there is significant data still to be sent).  It should send
477     a chunk of data until the point that stream bandwidth limits tell it
478     to stop.  Each call generates one section.
479
480   - A ``save_live_complete_precopy`` function that must transmit the
481     last section for the device containing any remaining data.
482
483   - A ``load_state`` function used to load sections generated by
484     any of the save functions that generate sections.
485
486   - ``cleanup`` functions for both save and load that are called
487     at the end of migration.
488
489 Note that the contents of the sections for iterative migration tend
490 to be open-coded by the devices; care should be taken in parsing
491 the results and structuring the stream to make them easy to validate.
492
493 Device ordering
494 ---------------
495
496 There are cases in which the ordering of device loading matters; for
497 example in some systems where a device may assert an interrupt during loading,
498 if the interrupt controller is loaded later then it might lose the state.
499
500 Some ordering is implicitly provided by the order in which the machine
501 definition creates devices, however this is somewhat fragile.
502
503 The ``MigrationPriority`` enum provides a means of explicitly enforcing
504 ordering.  Numerically higher priorities are loaded earlier.
505 The priority is set by setting the ``priority`` field of the top level
506 ``VMStateDescription`` for the device.
507
508 Stream structure
509 ================
510
511 The stream tries to be word and endian agnostic, allowing migration between hosts
512 of different characteristics running the same VM.
513
514   - Header
515
516     - Magic
517     - Version
518     - VM configuration section
519
520        - Machine type
521        - Target page bits
522   - List of sections
523     Each section contains a device, or one iteration of a device save.
524
525     - section type
526     - section id
527     - ID string (First section of each device)
528     - instance id (First section of each device)
529     - version id (First section of each device)
530     - <device data>
531     - Footer mark
532   - EOF mark
533   - VM Description structure
534     Consisting of a JSON description of the contents for analysis only
535
536 The ``device data`` in each section consists of the data produced
537 by the code described above.  For non-iterative devices they have a single
538 section; iterative devices have an initial and last section and a set
539 of parts in between.
540 Note that there is very little checking by the common code of the integrity
541 of the ``device data`` contents, that's up to the devices themselves.
542 The ``footer mark`` provides a little bit of protection for the case where
543 the receiving side reads more or less data than expected.
544
545 The ``ID string`` is normally unique, having been formed from a bus name
546 and device address, PCI devices and storage devices hung off PCI controllers
547 fit this pattern well.  Some devices are fixed single instances (e.g. "pc-ram").
548 Others (especially either older devices or system devices which for
549 some reason don't have a bus concept) make use of the ``instance id``
550 for otherwise identically named devices.
551
552 Return path
553 -----------
554
555 Only a unidirectional stream is required for normal migration, however a
556 ``return path`` can be created when bidirectional communication is desired.
557 This is primarily used by postcopy, but is also used to return a success
558 flag to the source at the end of migration.
559
560 ``qemu_file_get_return_path(QEMUFile* fwdpath)`` gives the QEMUFile* for the return
561 path.
562
563   Source side
564
565      Forward path - written by migration thread
566      Return path  - opened by main thread, read by return-path thread
567
568   Destination side
569
570      Forward path - read by main thread
571      Return path  - opened by main thread, written by main thread AND postcopy
572      thread (protected by rp_mutex)
573
574 Postcopy
575 ========
576
577 'Postcopy' migration is a way to deal with migrations that refuse to converge
578 (or take too long to converge) its plus side is that there is an upper bound on
579 the amount of migration traffic and time it takes, the down side is that during
580 the postcopy phase, a failure of *either* side or the network connection causes
581 the guest to be lost.
582
583 In postcopy the destination CPUs are started before all the memory has been
584 transferred, and accesses to pages that are yet to be transferred cause
585 a fault that's translated by QEMU into a request to the source QEMU.
586
587 Postcopy can be combined with precopy (i.e. normal migration) so that if precopy
588 doesn't finish in a given time the switch is made to postcopy.
589
590 Enabling postcopy
591 -----------------
592
593 To enable postcopy, issue this command on the monitor (both source and
594 destination) prior to the start of migration:
595
596 ``migrate_set_capability postcopy-ram on``
597
598 The normal commands are then used to start a migration, which is still
599 started in precopy mode.  Issuing:
600
601 ``migrate_start_postcopy``
602
603 will now cause the transition from precopy to postcopy.
604 It can be issued immediately after migration is started or any
605 time later on.  Issuing it after the end of a migration is harmless.
606
607 Blocktime is a postcopy live migration metric, intended to show how
608 long the vCPU was in state of interruptable sleep due to pagefault.
609 That metric is calculated both for all vCPUs as overlapped value, and
610 separately for each vCPU. These values are calculated on destination
611 side.  To enable postcopy blocktime calculation, enter following
612 command on destination monitor:
613
614 ``migrate_set_capability postcopy-blocktime on``
615
616 Postcopy blocktime can be retrieved by query-migrate qmp command.
617 postcopy-blocktime value of qmp command will show overlapped blocking
618 time for all vCPU, postcopy-vcpu-blocktime will show list of blocking
619 time per vCPU.
620
621 .. note::
622   During the postcopy phase, the bandwidth limits set using
623   ``migrate_set_speed`` is ignored (to avoid delaying requested pages that
624   the destination is waiting for).
625
626 Postcopy device transfer
627 ------------------------
628
629 Loading of device data may cause the device emulation to access guest RAM
630 that may trigger faults that have to be resolved by the source, as such
631 the migration stream has to be able to respond with page data *during* the
632 device load, and hence the device data has to be read from the stream completely
633 before the device load begins to free the stream up.  This is achieved by
634 'packaging' the device data into a blob that's read in one go.
635
636 Source behaviour
637 ----------------
638
639 Until postcopy is entered the migration stream is identical to normal
640 precopy, except for the addition of a 'postcopy advise' command at
641 the beginning, to tell the destination that postcopy might happen.
642 When postcopy starts the source sends the page discard data and then
643 forms the 'package' containing:
644
645    - Command: 'postcopy listen'
646    - The device state
647
648      A series of sections, identical to the precopy streams device state stream
649      containing everything except postcopiable devices (i.e. RAM)
650    - Command: 'postcopy run'
651
652 The 'package' is sent as the data part of a Command: ``CMD_PACKAGED``, and the
653 contents are formatted in the same way as the main migration stream.
654
655 During postcopy the source scans the list of dirty pages and sends them
656 to the destination without being requested (in much the same way as precopy),
657 however when a page request is received from the destination, the dirty page
658 scanning restarts from the requested location.  This causes requested pages
659 to be sent quickly, and also causes pages directly after the requested page
660 to be sent quickly in the hope that those pages are likely to be used
661 by the destination soon.
662
663 Destination behaviour
664 ---------------------
665
666 Initially the destination looks the same as precopy, with a single thread
667 reading the migration stream; the 'postcopy advise' and 'discard' commands
668 are processed to change the way RAM is managed, but don't affect the stream
669 processing.
670
671 ::
672
673   ------------------------------------------------------------------------------
674                           1      2   3     4 5                      6   7
675   main -----DISCARD-CMD_PACKAGED ( LISTEN  DEVICE     DEVICE DEVICE RUN )
676   thread                             |       |
677                                      |     (page request)
678                                      |        \___
679                                      v            \
680   listen thread:                     --- page -- page -- page -- page -- page --
681
682                                      a   b        c
683   ------------------------------------------------------------------------------
684
685 - On receipt of ``CMD_PACKAGED`` (1)
686
687    All the data associated with the package - the ( ... ) section in the diagram -
688    is read into memory, and the main thread recurses into qemu_loadvm_state_main
689    to process the contents of the package (2) which contains commands (3,6) and
690    devices (4...)
691
692 - On receipt of 'postcopy listen' - 3 -(i.e. the 1st command in the package)
693
694    a new thread (a) is started that takes over servicing the migration stream,
695    while the main thread carries on loading the package.   It loads normal
696    background page data (b) but if during a device load a fault happens (5)
697    the returned page (c) is loaded by the listen thread allowing the main
698    threads device load to carry on.
699
700 - The last thing in the ``CMD_PACKAGED`` is a 'RUN' command (6)
701
702    letting the destination CPUs start running.  At the end of the
703    ``CMD_PACKAGED`` (7) the main thread returns to normal running behaviour and
704    is no longer used by migration, while the listen thread carries on servicing
705    page data until the end of migration.
706
707 Postcopy states
708 ---------------
709
710 Postcopy moves through a series of states (see postcopy_state) from
711 ADVISE->DISCARD->LISTEN->RUNNING->END
712
713  - Advise
714
715     Set at the start of migration if postcopy is enabled, even
716     if it hasn't had the start command; here the destination
717     checks that its OS has the support needed for postcopy, and performs
718     setup to ensure the RAM mappings are suitable for later postcopy.
719     The destination will fail early in migration at this point if the
720     required OS support is not present.
721     (Triggered by reception of POSTCOPY_ADVISE command)
722
723  - Discard
724
725     Entered on receipt of the first 'discard' command; prior to
726     the first Discard being performed, hugepages are switched off
727     (using madvise) to ensure that no new huge pages are created
728     during the postcopy phase, and to cause any huge pages that
729     have discards on them to be broken.
730
731  - Listen
732
733     The first command in the package, POSTCOPY_LISTEN, switches
734     the destination state to Listen, and starts a new thread
735     (the 'listen thread') which takes over the job of receiving
736     pages off the migration stream, while the main thread carries
737     on processing the blob.  With this thread able to process page
738     reception, the destination now 'sensitises' the RAM to detect
739     any access to missing pages (on Linux using the 'userfault'
740     system).
741
742  - Running
743
744     POSTCOPY_RUN causes the destination to synchronise all
745     state and start the CPUs and IO devices running.  The main
746     thread now finishes processing the migration package and
747     now carries on as it would for normal precopy migration
748     (although it can't do the cleanup it would do as it
749     finishes a normal migration).
750
751  - End
752
753     The listen thread can now quit, and perform the cleanup of migration
754     state, the migration is now complete.
755
756 Source side page maps
757 ---------------------
758
759 The source side keeps two bitmaps during postcopy; 'the migration bitmap'
760 and 'unsent map'.  The 'migration bitmap' is basically the same as in
761 the precopy case, and holds a bit to indicate that page is 'dirty' -
762 i.e. needs sending.  During the precopy phase this is updated as the CPU
763 dirties pages, however during postcopy the CPUs are stopped and nothing
764 should dirty anything any more.
765
766 The 'unsent map' is used for the transition to postcopy. It is a bitmap that
767 has a bit cleared whenever a page is sent to the destination, however during
768 the transition to postcopy mode it is combined with the migration bitmap
769 to form a set of pages that:
770
771    a) Have been sent but then redirtied (which must be discarded)
772    b) Have not yet been sent - which also must be discarded to cause any
773       transparent huge pages built during precopy to be broken.
774
775 Note that the contents of the unsentmap are sacrificed during the calculation
776 of the discard set and thus aren't valid once in postcopy.  The dirtymap
777 is still valid and is used to ensure that no page is sent more than once.  Any
778 request for a page that has already been sent is ignored.  Duplicate requests
779 such as this can happen as a page is sent at about the same time the
780 destination accesses it.
781
782 Postcopy with hugepages
783 -----------------------
784
785 Postcopy now works with hugetlbfs backed memory:
786
787   a) The linux kernel on the destination must support userfault on hugepages.
788   b) The huge-page configuration on the source and destination VMs must be
789      identical; i.e. RAMBlocks on both sides must use the same page size.
790   c) Note that ``-mem-path /dev/hugepages``  will fall back to allocating normal
791      RAM if it doesn't have enough hugepages, triggering (b) to fail.
792      Using ``-mem-prealloc`` enforces the allocation using hugepages.
793   d) Care should be taken with the size of hugepage used; postcopy with 2MB
794      hugepages works well, however 1GB hugepages are likely to be problematic
795      since it takes ~1 second to transfer a 1GB hugepage across a 10Gbps link,
796      and until the full page is transferred the destination thread is blocked.
797
798 Postcopy with shared memory
799 ---------------------------
800
801 Postcopy migration with shared memory needs explicit support from the other
802 processes that share memory and from QEMU. There are restrictions on the type of
803 memory that userfault can support shared.
804
805 The Linux kernel userfault support works on `/dev/shm` memory and on `hugetlbfs`
806 (although the kernel doesn't provide an equivalent to `madvise(MADV_DONTNEED)`
807 for hugetlbfs which may be a problem in some configurations).
808
809 The vhost-user code in QEMU supports clients that have Postcopy support,
810 and the `vhost-user-bridge` (in `tests/`) and the DPDK package have changes
811 to support postcopy.
812
813 The client needs to open a userfaultfd and register the areas
814 of memory that it maps with userfault.  The client must then pass the
815 userfaultfd back to QEMU together with a mapping table that allows
816 fault addresses in the clients address space to be converted back to
817 RAMBlock/offsets.  The client's userfaultfd is added to the postcopy
818 fault-thread and page requests are made on behalf of the client by QEMU.
819 QEMU performs 'wake' operations on the client's userfaultfd to allow it
820 to continue after a page has arrived.
821
822 .. note::
823   There are two future improvements that would be nice:
824     a) Some way to make QEMU ignorant of the addresses in the clients
825        address space
826     b) Avoiding the need for QEMU to perform ufd-wake calls after the
827        pages have arrived
828
829 Retro-fitting postcopy to existing clients is possible:
830   a) A mechanism is needed for the registration with userfault as above,
831      and the registration needs to be coordinated with the phases of
832      postcopy.  In vhost-user extra messages are added to the existing
833      control channel.
834   b) Any thread that can block due to guest memory accesses must be
835      identified and the implication understood; for example if the
836      guest memory access is made while holding a lock then all other
837      threads waiting for that lock will also be blocked.
838
839 Firmware
840 ========
841
842 Migration migrates the copies of RAM and ROM, and thus when running
843 on the destination it includes the firmware from the source. Even after
844 resetting a VM, the old firmware is used.  Only once QEMU has been restarted
845 is the new firmware in use.
846
847 - Changes in firmware size can cause changes in the required RAMBlock size
848   to hold the firmware and thus migration can fail.  In practice it's best
849   to pad firmware images to convenient powers of 2 with plenty of space
850   for growth.
851
852 - Care should be taken with device emulation code so that newer
853   emulation code can work with older firmware to allow forward migration.
854
855 - Care should be taken with newer firmware so that backward migration
856   to older systems with older device emulation code will work.
857
858 In some cases it may be best to tie specific firmware versions to specific
859 versioned machine types to cut down on the combinations that will need
860 support.  This is also useful when newer versions of firmware outgrow
861 the padding.
862