summaryrefslogtreecommitdiffhomepage
path: root/pkg/sentry/usermem
diff options
context:
space:
mode:
authorMichael Pratt <mpratt@google.com>2018-07-12 10:36:16 -0700
committerShentubot <shentubot@google.com>2018-07-12 10:37:21 -0700
commit41e0b977e5ffc667750c0f706bb70173c5de2161 (patch)
tree0684cdc1122057eb8d2651943cfe513256d9e26c /pkg/sentry/usermem
parentb363799bd879a7c36a87bc4a91f5c45c91ad6473 (diff)
Format documentation
PiperOrigin-RevId: 204323728 Change-Id: I1ff9aa062ffa12583b2e38ec94c87db7a3711971
Diffstat (limited to 'pkg/sentry/usermem')
-rw-r--r--pkg/sentry/usermem/README.md42
1 files changed, 21 insertions, 21 deletions
diff --git a/pkg/sentry/usermem/README.md b/pkg/sentry/usermem/README.md
index 2ebd3bcc1..f6d2137eb 100644
--- a/pkg/sentry/usermem/README.md
+++ b/pkg/sentry/usermem/README.md
@@ -2,30 +2,30 @@ This package defines primitives for sentry access to application memory.
Major types:
-- The `IO` interface represents a virtual address space and provides I/O methods
- on that address space. `IO` is the lowest-level primitive. The primary
- implementation of the `IO` interface is `mm.MemoryManager`.
+- The `IO` interface represents a virtual address space and provides I/O
+ methods on that address space. `IO` is the lowest-level primitive. The
+ primary implementation of the `IO` interface is `mm.MemoryManager`.
-- `IOSequence` represents a collection of individually-contiguous address ranges
- in a `IO` that is operated on sequentially, analogous to Linux's `struct
- iov_iter`.
+- `IOSequence` represents a collection of individually-contiguous address
+ ranges in a `IO` that is operated on sequentially, analogous to Linux's
+ `struct iov_iter`.
Major usage patterns:
-- Access to a task's virtual memory, subject to the application's memory
- protections and while running on that task's goroutine, from a context that is
- at or above the level of the `kernel` package (e.g. most syscall
- implementations in `syscalls/linux`); use the `kernel.Task.Copy*` wrappers
- defined in `kernel/task_usermem.go`.
+- Access to a task's virtual memory, subject to the application's memory
+ protections and while running on that task's goroutine, from a context that
+ is at or above the level of the `kernel` package (e.g. most syscall
+ implementations in `syscalls/linux`); use the `kernel.Task.Copy*` wrappers
+ defined in `kernel/task_usermem.go`.
-- Access to a task's virtual memory, from a context that is at or above the
- level of the `kernel` package, but where any of the above constraints does not
- hold (e.g. `PTRACE_POKEDATA`, which ignores application memory protections);
- obtain the task's `mm.MemoryManager` by calling `kernel.Task.MemoryManager`,
- and call its `IO` methods directly.
+- Access to a task's virtual memory, from a context that is at or above the
+ level of the `kernel` package, but where any of the above constraints does
+ not hold (e.g. `PTRACE_POKEDATA`, which ignores application memory
+ protections); obtain the task's `mm.MemoryManager` by calling
+ `kernel.Task.MemoryManager`, and call its `IO` methods directly.
-- Access to a task's virtual memory, from a context that is below the level of
- the `kernel` package (e.g. filesystem I/O); clients must pass I/O arguments
- from higher layers, usually in the form of an `IOSequence`. The
- `kernel.Task.SingleIOSequence` and `kernel.Task.IovecsIOSequence` functions in
- `kernel/task_usermem.go` are convenience functions for doing so.
+- Access to a task's virtual memory, from a context that is below the level of
+ the `kernel` package (e.g. filesystem I/O); clients must pass I/O arguments
+ from higher layers, usually in the form of an `IOSequence`. The
+ `kernel.Task.SingleIOSequence` and `kernel.Task.IovecsIOSequence` functions
+ in `kernel/task_usermem.go` are convenience functions for doing so.