qemu-devel.nongnu.org archive mirror
 help / color / mirror / Atom feed
From: Xuebing Wang <xbing6@gmail.com>
To: qemu-devel@nongnu.org
Cc: pbonzini@redhat.com, xbing6@gmail.com, afaerber@suse.de,
	stefanha@redhat.com
Subject: [Qemu-devel]  [Discussion 01/10] docs: add docs/api-hierarchy.txt
Date: Tue,  4 Mar 2014 10:47:21 +0800	[thread overview]
Message-ID: <1393901250-3922-2-git-send-email-xbing6@gmail.com> (raw)
In-Reply-To: <1393901250-3922-1-git-send-email-xbing6@gmail.com>

Signed-off-by: Xuebing Wang <xbing6@gmail.com>
---
 docs/api-hierarchy.txt |   93 ++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 93 insertions(+)
 create mode 100644 docs/api-hierarchy.txt

diff --git a/docs/api-hierarchy.txt b/docs/api-hierarchy.txt
new file mode 100644
index 0000000..9982f51
--- /dev/null
+++ b/docs/api-hierarchy.txt
@@ -0,0 +1,93 @@
+API hierarchy
+=============
+
+1) QEMU common API
+
+   |-------------------------------|
+   |  C99 API                      |
+   |  - <stdio.h> <stdlib.h> ...   |
+   |-------------------------------|
+   |  QEMU basic API               |
+   |  - include/qemu/*             |
+   |-------------------------------|
+   |  QEMU utility/helper API      |
+   |  - block                      |
+   |  - disas                      |
+   |  - migration                  |
+   |  - monitor                    |
+   |  - net                        |
+   |  - qapi                       |
+   |  - ...                        |
+   |-------------------------------|
+
+2) CPUArchState API
+
+   |-----------------------------------------------------------------------|
+   |  qom/Object  |  QEMU common API                                       |
+   |--------------|  - Linux API                                           |
+                  |  - QEMU basic API                                      |
+                  |  - QEMU utility/helper API                             |
+   |-----------------------------------------------------------------------|
+   |  qdev/DeviceState    |
+   |-----------------------------------------------------------------------|
+                          | Create new file? | sysemu/kvm.h | hw/xen/xen.h |
+                          | exec/cpu-exec.h? |              |              |
+                          |------------------------------------------------|
+                          |  TODO: consider to abstract vcpu here?         |
+                          |  include/qom/vcpu.h?                           |
+   |-----------------------------------------------------------------------|
+   |  qom/CPUState                                 |
+   |-----------------------------------------------------------------------|
+   |  target-xxx/CPUArchState                      |  sysemu/sysemu.h      |
+   |-----------------------------------------------------------------------|
+
+   cpu-exec.h is for one (tcg) of the 3 accelerators: tcg, kvm and xen.
+
+3) Memory API
+
+   |--------------------------------------------------------------|
+   |  linux-user               |  softmmu                         |
+   |  gueust virtual address   |  guest physical address          |
+   |                           |  guest virtual address           |
+   |                           |                                  |
+   |                           |  --------------------------------|
+   |                           |  |  Memory modelling             |
+   |                           |  |                               |
+   |                           |  |  MemoryRegion  |  RAMBlock    |
+   |                           |  |  memory.h      |              |
+   |                           |  --------------------------------|
+   |                           |  |  softmmu API                  |
+   |                           |  |  - include/exec/softmmu*.h    |
+   |                           |  |  - include/exec/cputlb.h      |
+   |--------------------------------------------------------------|
+   |  memory load/store API                                       |
+   |  include/exec/cpu-common.h                                   |
+   |--------------------------------------------------------------|
+
+4) exec API
+
+                                architecture-independent | architecture
+                                                         | specific
+   |------------------|                                  |
+   | memory           |                                  |
+   | load/store API   |                                  |
+   | cpu-common.h     |                                  |
+   |-----------------------------------------------------|---------------|
+                                         | tcg framework | tcg frontend  |
+                                         | tcg/tcg*.h    |               |
+                      |------------------|---------------|---------------|
+                      | TranslationBlock |               |
+                      | translate.h      |               |
+   |-------------------------------------|---------------|---------------|
+   |                                     | misc cpu API  | misc cpu API  |
+   | include/exec/exec-all.h             | cpu-common.h  | cpu-all.h     |
+   |-------------------------------------|---------------|---------------|
+
+   include/exec includes:
+   - Memory  API
+   - TranslationBlock API
+   - misc cpu API (both architecture-independent and architecture-specific)
+
+   include/exec/cpu-all.h is for architecture-specific, it's only included
+   in target-xxx/* files.
+
-- 
1.7.9.5

  reply	other threads:[~2014-03-04  2:48 UTC|newest]

Thread overview: 37+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2014-03-04  2:47 [Qemu-devel] [Discussion 00/10] about API hierarchy Xuebing Wang
2014-03-04  2:47 ` Xuebing Wang [this message]
2014-03-04  9:42   ` [Qemu-devel] [Discussion 01/10] docs: add docs/api-hierarchy.txt Stefan Hajnoczi
2014-03-04  9:58     ` Xuebing wang
2014-03-04 11:57       ` Stefan Hajnoczi
2014-03-04  2:47 ` [Qemu-devel] [Discussion 02/10] NEED_CPU_H: remove '#include "cpu.h"' from include/qemu-common.h Xuebing Wang
2014-03-04 10:19   ` Paolo Bonzini
2014-03-04 11:54     ` Xuebing wang
2014-03-04 12:02     ` Xuebing wang
2014-03-04 12:09       ` Paolo Bonzini
2014-03-04 12:09     ` Xuebing wang
2014-03-04 12:34       ` Peter Maydell
2014-03-04 12:40         ` Xuebing wang
2014-03-04 12:19     ` Xuebing wang
2014-03-04 12:23       ` Paolo Bonzini
2014-03-04 12:26     ` Xuebing wang
2014-03-04 12:29       ` Paolo Bonzini
2014-03-04  2:47 ` [Qemu-devel] [Discussion 03/10] NEED_CPU_H: remove unnecessary use of NEED_CPU_H Xuebing Wang
2014-03-04 10:20   ` Paolo Bonzini
2014-03-04  2:47 ` [Qemu-devel] [Discussion 04/10] memory_mapping: make this architecture-independent Xuebing Wang
2014-03-04 10:22   ` Paolo Bonzini
2014-03-04 11:05   ` Peter Maydell
2014-03-04  2:47 ` [Qemu-devel] [Discussion 05/10] NEED_CPU_H: remove unnecessary inclusion of "cpu.h" in root Xuebing Wang
2014-03-04 10:24   ` Paolo Bonzini
2014-03-04  2:47 ` [Qemu-devel] [Discussion 06/10] memory: move contents in include/exec/address-spaces.h => memory.h Xuebing Wang
2014-03-04 10:26   ` Paolo Bonzini
2014-03-04  2:47 ` [Qemu-devel] [Discussion 07/10] memory: remove file include/exec/address-spaces.h Xuebing Wang
2014-03-04  2:47 ` [Qemu-devel] [Discussion 08/10] exec: move TranslationBlock API from exec-all.h => translate.h Xuebing Wang
2014-03-04 10:27   ` Paolo Bonzini
2014-03-04  2:47 ` [Qemu-devel] [Discussion 09/10] exec: remove the unnecessary include of "exec-all.h" Xuebing Wang
2014-03-04 10:27   ` Paolo Bonzini
2014-03-04 11:11   ` Peter Maydell
2014-03-04 11:16     ` Peter Maydell
2014-03-04  2:47 ` [Qemu-devel] [Discussion 10/10] translate: remove file translate-all.h Xuebing Wang
2014-03-04 10:29   ` Paolo Bonzini
2014-03-04  3:45 ` [Qemu-devel] [Discussion 00/10] about API hierarchy Andreas Färber
2014-03-04  5:37   ` Xuebing wang

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1393901250-3922-2-git-send-email-xbing6@gmail.com \
    --to=xbing6@gmail.com \
    --cc=afaerber@suse.de \
    --cc=pbonzini@redhat.com \
    --cc=qemu-devel@nongnu.org \
    --cc=stefanha@redhat.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).