9P (protocol)

9P (or the Plan 9 Filesystem Protocol or Styx) is a network protocol developed for the Plan 9 from Bell Labs distributed operating system as the means of connecting the components of a Plan 9 system. Files are key objects in Plan 9. They represent windows, network connections, processes, and almost anything else available in the operating system.

9P was revised for the 4th edition of Plan 9 under the name 9P2000, containing various improvements. Some of the improvements made are, the removal of certain filename restrictions, the addition of a 'last modifier' metadata field for directories, and authentication files.[1] The latest version of the Inferno operating system also uses 9P2000. The Inferno file protocol was originally called Styx, but technically it has always been a variant of 9P.

A server implementation of 9P for Unix, called u9fs,[2][3] is included in the Plan 9 distribution. A 9P OS X client kernel extension is provided by Mac9P.[4] A kernel client driver implementing 9p with some extensions for Linux is part of the v9fs project. 9P and its derivatives have also found application in embedded environments, such as the Styx on a Brick project.[5]

Server applications

Many of Plan 9's applications take the form of 9P file servers. Examples include:

  • acme: a text editor/development environment
  • rio: the Plan 9 windowing system
  • plumber: interprocess communication
  • ftpfs: an FTP client that presents the files and directories on a remote FTP server in the local namespace
  • wikifs: a wiki editing tool that presents a remote wiki as files in the local namespace
  • webfs: a file server that retrieves data from URLs and presents the contents and details of responses as files in the local namespace

Outside of Plan 9, the 9P protocol is still used when a lightweight remote filesystem is required:

  • NixOS: a purely functional and declarative Linux distribution can rebuild itself inside a virtual machine, where the client uses 9P to mount the package store directory of the host.
  • Windows Subsystem for Linux: since Windows 10 version 1903, the subsystem implements 9P as a server and the host Windows operating system acts as a client.[6]
  • Crostini: a custom 9P server is used to provide access to files outside of a Linux VM [7]
  • QEMU: the VirtFS device allows for filesystem sharing over 9P, which is accelerated with kernel drivers and shared memory [8][9]
  • DIOD: Distributed I/O Daemon - a 9P file server

Implementation

9P sends the following messages between clients and servers.[10] These messages correspond to the entry points in the Plan 9 vfs layer that any 9P server must implement.

version
Negotiate protocol version[11]
error
Return an error[12]
flush
Abort a message[13]
auth, attach
Establish a connection[14]
walk
Descend a directory hierarchy[15]
create, open
Prepare a fid for I/O on an existing or new file[16]
read, write
Transfer data from and to a file[17]
clunk
Forget about a fid[18]
remove
Remove a file from a server[19]
stat, wstat
Inquire or change file attributes[20]

See also

  • IL (network protocol), transport protocol that was designed for 9P in local area networks
  • Distributed file system

References

  1. "Plan 9 from Bell Labs — Overview". 9p.io.
  2. "research: u9fs.tgz is the source code tarbal". www.netlib.org.
  3. "Plan 9 /sys/man/4/u9fs". 9p.io.
  4. benavento (April 19, 2019). "9P for Mac" via GitHub.
  5. "Styx-on-a-Brick". Cat-V Doc.
  6. "What's new for WSL in Windows 10 version 1903?". Windows Command Line Tools For Developers. February 16, 2019.
  7. "Running Custom Containers Under Chrome OS". Chromium OS Docs. Retrieved 2019-03-28.
  8. Jujjuri, Venkateswararao; Van Hensbergen, Eric; Liguori, Anthony; Pulavarty, Badari (July 13–16, 2010). "VirtFS—A virtualization aware File System pass-through" (PDF). Linux Symposium.
  9. "Documentation/9psetup". QEMU Docs. Retrieved 2019-03-28.
  10. "Section 5: 9P protocol". Plan 9 manualg.
  11. "version page from Section 5 of the plan 9 manual". Plan 9 manualg.
  12. "error page from Section 5 of the plan 9 manual". Plan 9 manualg.
  13. "flush page from Section 5 of the plan 9 manual". Plan 9 manualg.
  14. "attach page from Section 5 of the plan 9 manual". Plan 9 manualg.
  15. "walk page from Section 5 of the plan 9 manual". Plan 9 manualg.
  16. "open page from Section 5 of the plan 9 manual". Plan 9 manualg.
  17. "read page from Section 5 of the plan 9 manual". Plan 9 manualg.
  18. "clunk page from Section 5 of the plan 9 manual". Plan 9 manualg.
  19. "remove page from Section 5 of the plan 9 manual". Plan 9 manualg.
  20. "stat page from Section 5 of the plan 9 manual". Plan 9 manualg.
This article is issued from Wikipedia. The text is licensed under Creative Commons - Attribution - Sharealike. Additional terms may apply for the media files.