xref: /illumos-gate/usr/src/man/man4fs/bootfs.4fs (revision a89c0811c892ec231725fe10817ef95dda813c06)
1.\"
2.\" This file and its contents are supplied under the terms of the
3.\" Common Development and Distribution License ("CDDL"), version 1.0.
4.\" You may only use this file in accordance with the terms of version
5.\" 1.0 of the CDDL.
6.\"
7.\" A full copy of the text of the CDDL should have accompanied this
8.\" source.  A copy of the CDDL is also available via the Internet at
9.\" http://www.illumos.org/license/CDDL.
10.\"
11.\"
12.\" Copyright (c) 2014 Joyent, Inc.  All rights reserved.
13.\" Copyright 2021 Oxide Computer Company
14.\"
15.Dd May 8, 2014
16.Dt BOOTFS 4FS
17.Os
18.Sh NAME
19.Nm bootfs
20.Nd boot-time module file system
21.Sh DESCRIPTION
22The
23.Nm
24file system is a read-only file system that provides access to any
25boot-time modules that were passed in to the system loader which were
26tagged with the type
27.Em file .
28.Nm
29does not display any boot-time modules that were tagged as type
30.Em hash
31or type
32.Em rootfs .
33If modules with duplicate names and paths are specified, only the first
34such entry will be present in the file system and a counter will be
35incremented to indicate that a duplicate entry was found, but is not
36present into the file system.
37If a module's name only consists of invalid characters, such as
38.Sq . ,
39.Sq .. ,
40or
41.Sq / ,
42then the module will not be present in the file system and a counter
43will be incremented to indicate that this has occurred.
44In both cases, diagnostic information is available through the kstats
45facility.
46.Sh FILES
47.Bl -tag -width Pa
48.It Pa /system/boot
49The mount point for the
50.Nm
51file system in the global zone.
52.El
53.Sh EXAMPLES
54.Sy Example 1
55Determining if collisions or invalid names are present
56.Pp
57To determine if any boot-time modules were not created due to collisions
58or invalid names, enter the following command:
59.Bd -literal -offset indent
60# kstat -m bootfs
61module: bootfs                          instance: 1
62name:   bootfs                          class:    fs
63        crtime                          236063.651324041
64        nbytes                          8749355
65        ndirs                           3
66        ndiscard                        0
67        ndup                            0
68        nfiles                          2
69        snaptime                        236063.651324041
70.Ed
71The field
72.Fa ndiscard
73lists the number of boot-time modules that were discarded due to naming
74conflicts.
75The field
76.Fa ndup
77lists the number of duplicate entries that were found and therefore not
78displayed in the file system.
79.Pp
80This information is provided for informational purposes only, it is not
81to be construed as a stable interface.
82.Sh SEE ALSO
83.Xr loader 7 ,
84.Xr kstat 8
85