From: Warren Toomey <wkt@tuhs.org>
To: tuhs@tuhs.org
Subject: [TUHS] Unix APIs: elegant or not?
Date: Wed, 31 Oct 2018 14:38:10 +1000 [thread overview]
Message-ID: <20181031043810.GA10775@minnie.tuhs.org> (raw)
I was just reading this book review:
http://www.pathsensitive.com/2018/10/book-review-philosophy-of-software.html
and came across these paragraphs:
<book quote>
The mechanism for file IO provided by the Unix operating system
and its descendants, such as Linux, is a beautiful example of a
deep interface. There are only five basic system calls for I/O,
with simple signatures:
int open(const char* path, int flags, mode_t permissions);
ssize_t read(int fd, void* buffer, size_t count);
ssize_t write(int fd, const void* buffer, size_t count);
off_t lseek(int fd, off_t offset, int referencePosition);
int close(int fd);
</book quote>
The POSIX file API is a great example, but not of a deep
interface. Rather, it’s a great example of how code with a very
complicated interface may look deceptively simple when reduced to C-style
function signatures. It’s a stateful API with interesting orderings
and interactions between calls. The flags and permissions parameters
of open hide an enormous amount of complexity, with hidden requirements
like “exactly one of these five bits should be specified.” open may
return 20 different error codes, each with their own meaning, and many
with references to specific implementations.
The authors of SibylIFS tried to write down an exact description of the
open interface. Their annotated version[1] of the POSIX standard is over
3000 words. Not counting basic machinery, it took them over 200 lines[2]
to write down the properties of open in higher-order logic, and another
70 to give the interactions between open and close.
[1]: https://github.com/sibylfs/sibylfs_src/blob/8a7f53ba58654249b0ec0725ce3887840d6a1812/fs_spec/src/posix/open.md
[2]: https://github.com/sibylfs/sibylfs_src/blob/8a7f53ba58654249b0ec0725ce3887840d6a1812/fs_spec/src/t_fs_spec_fs_command_properties.lem_cppo#L460
I just thought it was a thought-provoking comment on the apparent elegance
of the Unix file API that actually has some subtle complexity.
Cheers, Warren
next reply other threads:[~2018-10-31 5:31 UTC|newest]
Thread overview: 30+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-10-31 4:38 Warren Toomey [this message]
2018-10-31 15:47 ` Paul Winalski
2018-10-31 17:22 ` Clem Cole
2018-10-31 19:33 ` Lawrence Stewart
2018-10-31 20:57 ` G. Branden Robinson
2018-10-31 21:31 ` Dave Horsfall
2018-11-01 7:42 ` Pierre DAVID
2018-11-01 10:20 ` Dave Horsfall
2018-11-01 12:57 ` Clem Cole
2018-11-01 14:19 ` ron minnich
2018-11-01 14:41 ` Clem Cole
2018-11-01 16:43 ` Warner Losh
2018-11-01 16:48 ` ron minnich
2018-11-01 16:56 ` Warner Losh
2018-11-02 5:24 ` Bakul Shah
2018-11-04 10:53 ` Chris Hanson
2018-11-04 15:34 ` ron minnich
2018-11-04 17:06 ` Warner Losh
2018-11-04 20:00 ` ron minnich
2018-11-04 18:52 ` Bakul Shah
2018-11-04 10:49 ` Chris Hanson
2018-11-04 12:28 ` arnold
2018-11-04 21:34 ` Chris Hanson
2018-11-05 14:11 ` Donald ODona
2018-11-04 13:35 ` Warner Losh
2018-11-04 19:47 ` Dave Horsfall
2018-11-01 15:39 Noel Chiappa
2018-11-04 22:29 Theodore Y. Ts'o
2018-11-04 22:37 Noel Chiappa
2018-11-05 4:04 ` Dave Horsfall
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=20181031043810.GA10775@minnie.tuhs.org \
--to=wkt@tuhs.org \
--cc=tuhs@tuhs.org \
/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).