aboutsummaryrefslogtreecommitdiff
path: root/doc/manual/src/architecture/store/fso.md
blob: 958b8f62a136daaec866b67513a974129dfb1e78 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
# File System Object

The Nix store uses a simple file system model for the data it holds in [store objects](store.md#store-object).

Every file system object is one of the following:

 - File: an executable flag, and arbitrary data for contents
 - Directory: mapping of names to child file system objects
 - [Symbolic link][symlink]: may point anywhere.

We call a store object's outermost file system object the *root*.

    data FileSystemObject
      = File      { isExecutable :: Bool, contents :: Bytes }
      | Directory { entries :: Map FileName FileSystemObject }
      | SymLink   { target :: Path }

Examples:

- a directory with contents

    /nix/store/<hash>-hello-2.10
    ├── bin
    │   └── hello
    └── share
        ├── info
        │   └── hello.info
        └── man
            └── man1
                └── hello.1.gz

- a directory with relative symlink and other contents

    /nix/store/<hash>-go-1.16.9
    ├── bin -> share/go/bin
    ├── nix-support/
    └── share/

- a directory with absolute symlink

    /nix/store/d3k...-nodejs
    └── nix_node -> /nix/store/f20...-nodejs-10.24.

A bare file or symlink can be a root file system object.
Examles:

    /nix/store/<hash>-hello-2.10.tar.gz

    /nix/store/4j5...-pkg-config-wrapper-0.29.2-doc -> /nix/store/i99...-pkg-config-0.29.2-doc

Symlinks pointing outside of their own root or to a store object without a matching reference are allowed, but might not function as intended.
Examples:

- an arbitrarily symlinked file may change or not exist at all

    /nix/store/<hash>-foo
    └── foo -> /home/foo

- if a symlink to a store path was not automatically created by Nix, it may be invalid or get invalidated when the store object is deleted

    /nix/store/<hash>-bar
    └── bar -> /nix/store/abc...-foo

[symlink]: https://en.m.wikipedia.org/wiki/Symbolic_link