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