summaryrefslogtreecommitdiffhomepage
path: root/pkg/lisafs/README.md
diff options
context:
space:
mode:
authorAyush Ranjan <ayushranjan@google.com>2021-09-20 11:41:58 -0700
committergVisor bot <gvisor-bot@google.com>2021-09-20 11:44:11 -0700
commitd139087b3f7be1fdc1af151e8548c4bbdc199875 (patch)
tree627c9a4aa9b1d97b4f92895e454541fb9173a8ed /pkg/lisafs/README.md
parent89a0011c100d778cd8a0cc5e1b14996461c66629 (diff)
[lisa] lisafs package POC.
This change mainly aims to define the semantics of communication for the LISAFS (LInux SAndbox Filesystem) protocol. This protocol aims to replace 9P and intends to bring some performance benefits with it. Some of the notable differences from the p9 package are: - Now the server implementations own the handlers. - As a result, there is no verbose interface like `p9.File` that all servers need to implement. Different implementations can extend their File implementations to varying degrees without imposing those extensions to other server implementations that might not have anything to do with those features. - If a server implementation adds a new RPC message, other implementations are not compelled to support it. I wrote a benchmark `BenchmarkSendRecv` in connection_test.go which competes with p9's `BenchmarkSendRecvChannel`. Running these on an AMD Milan machine shows that lisafs is **45%** faster. **With 9P** goos: linux goarch: amd64 pkg: gvisor/pkg/p9/p9 cpu: AMD EPYC 7B13 64-Core Processor BenchmarkSendRecvLegacy-256 82830 14053 ns/op 633 B/op 23 allocs/op BenchmarkSendRecvChannel-256 776971 1551 ns/op 184 B/op 6 allocs/op **With lisafs** goos: linux goarch: amd64 pkg: pkg/lisafs/connection_test cpu: AMD EPYC 7B13 64-Core Processor BenchmarkSendRecv-256 1399610 853.5 ns/op 48 B/op 2 allocs/op Fixes #5464 PiperOrigin-RevId: 397803163
Diffstat (limited to 'pkg/lisafs/README.md')
-rw-r--r--pkg/lisafs/README.md3
1 files changed, 3 insertions, 0 deletions
diff --git a/pkg/lisafs/README.md b/pkg/lisafs/README.md
index 51d0d40e5..6b857321a 100644
--- a/pkg/lisafs/README.md
+++ b/pkg/lisafs/README.md
@@ -1,5 +1,8 @@
# Replacing 9P
+NOTE: LISAFS is **NOT** production ready. There are still some security concerns
+that must be resolved first.
+
## Background
The Linux filesystem model consists of the following key aspects (modulo mounts,