LXR qemu/include/exec/memory-internal.h

   1/*
   2 * Declarations for functions which are internal to the memory subsystem.
   3 *
   4 * Copyright 2011 Red Hat, Inc. and/or its affiliates
   5 *
   6 * Authors:
   7 *  Avi Kivity <avi@redhat.com>
   8 *
   9 * This work is licensed under the terms of the GNU GPL, version 2 or
  10 * later.  See the COPYING file in the top-level directory.
  11 *
  12 */
  13
  14/*
  15 * This header is for use by exec.c, memory.c and accel/tcg/cputlb.c ONLY,
  16 * for declarations which are shared between the memory subsystem's
  17 * internals and the TCG TLB code. Do not include it from elsewhere.
  18 */
  19
  20#ifndef MEMORY_INTERNAL_H
  21#define MEMORY_INTERNAL_H
  22
  23#ifndef CONFIG_USER_ONLY
  24static inline AddressSpaceDispatch *flatview_to_dispatch(FlatView *fv)
  25{
  26    return fv->dispatch;
  27}
  28
  29static inline AddressSpaceDispatch *address_space_to_dispatch(AddressSpace *as)
  30{
  31    return flatview_to_dispatch(address_space_to_flatview(as));
  32}
  33
  34FlatView *address_space_get_flatview(AddressSpace *as);
  35void flatview_unref(FlatView *view);
  36
  37extern const MemoryRegionOps unassigned_mem_ops;
  38
  39bool memory_region_access_valid(MemoryRegion *mr, hwaddr addr,
  40                                unsigned size, bool is_write,
  41                                MemTxAttrs attrs);
  42
  43void flatview_add_to_dispatch(FlatView *fv, MemoryRegionSection *section);
  44AddressSpaceDispatch *address_space_dispatch_new(FlatView *fv);
  45void address_space_dispatch_compact(AddressSpaceDispatch *d);
  46void address_space_dispatch_free(AddressSpaceDispatch *d);
  47
  48void mtree_print_dispatch(struct AddressSpaceDispatch *d,
  49                          MemoryRegion *root);
  50
  51struct page_collection;
  52
  53/* Opaque struct for passing info from memory_notdirty_write_prepare()
  54 * to memory_notdirty_write_complete(). Callers should treat all fields
  55 * as private, with the exception of @active.
  56 *
  57 * @active is a field which is not touched by either the prepare or
  58 * complete functions, but which the caller can use if it wishes to
  59 * track whether it has called prepare for this struct and so needs
  60 * to later call the complete function.
  61 */
  62typedef struct {
  63    CPUState *cpu;
  64    struct page_collection *pages;
  65    ram_addr_t ram_addr;
  66    vaddr mem_vaddr;
  67    unsigned size;
  68    bool active;
  69} NotDirtyInfo;
  70
  71/**
  72 * memory_notdirty_write_prepare: call before writing to non-dirty memory
  73 * @ndi: pointer to opaque NotDirtyInfo struct
  74 * @cpu: CPU doing the write
  75 * @mem_vaddr: virtual address of write
  76 * @ram_addr: the ram address of the write
  77 * @size: size of write in bytes
  78 *
  79 * Any code which writes to the host memory corresponding to
  80 * guest RAM which has been marked as NOTDIRTY must wrap those
  81 * writes in calls to memory_notdirty_write_prepare() and
  82 * memory_notdirty_write_complete():
  83 *
  84 *  NotDirtyInfo ndi;
  85 *  memory_notdirty_write_prepare(&ndi, ....);
  86 *  ... perform write here ...
  87 *  memory_notdirty_write_complete(&ndi);
  88 *
  89 * These calls will ensure that we flush any TCG translated code for
  90 * the memory being written, update the dirty bits and (if possible)
  91 * remove the slowpath callback for writing to the memory.
  92 *
  93 * This must only be called if we are using TCG; it will assert otherwise.
  94 *
  95 * We may take locks in the prepare call, so callers must ensure that
  96 * they don't exit (via longjump or otherwise) without calling complete.
  97 *
  98 * This call must only be made inside an RCU critical section.
  99 * (Note that while we're executing a TCG TB we're always in an
 100 * RCU critical section, which is likely to be the case for callers
 101 * of these functions.)
 102 */
 103void memory_notdirty_write_prepare(NotDirtyInfo *ndi,
 104                                   CPUState *cpu,
 105                                   vaddr mem_vaddr,
 106                                   ram_addr_t ram_addr,
 107                                   unsigned size);
 108/**
 109 * memory_notdirty_write_complete: finish write to non-dirty memory
 110 * @ndi: pointer to the opaque NotDirtyInfo struct which was initialized
 111 * by memory_not_dirty_write_prepare().
 112 */
 113void memory_notdirty_write_complete(NotDirtyInfo *ndi);
 114
 115#endif
 116#endif
 117