xref: /illumos-gate/usr/src/man/man4fs/objfs.4fs (revision 8119dad84d6416f13557b0ba8e2aaf9064cbcfd3)
1.\"
2.\" Copyright (c) 2004, Sun Microsystems, Inc.  All Rights Reserved
3.\" Copyright 2021 Oxide Computer Company
4.\"
5.\" The contents of this file are subject to the terms of the
6.\" Common Development and Distribution License (the "License").
7.\" You may not use this file except in compliance with the License.
8.\"
9.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
10.\" or http://www.opensolaris.org/os/licensing.
11.\" See the License for the specific language governing permissions
12.\" and limitations under the License.
13.\"
14.\" When distributing Covered Code, include this CDDL HEADER in each
15.\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
16.\" If applicable, add the following below this CDDL HEADER, with the
17.\" fields enclosed by brackets "[]" replaced with your own identifying
18.\" information: Portions Copyright [yyyy] [name of copyright owner]
19.\"
20.Dd November 29, 2021
21.Dt OBJFS 4FS
22.Os
23.Sh NAME
24.Nm objfs
25.Nd Kernel object filesystem
26.Sh DESCRIPTION
27The
28.Nm
29filesystem describes the state of all modules currently loaded
30by the kernel.
31It is mounted during boot at
32.Pa /system/object .
33.Pp
34The contents of the filesystem are dynamic and reflect the current state of the
35system.
36Each module is represented by a directory containing a single file,
37.Sq object' .
38The object file is a read only ELF file which contains information about the
39object loaded in the kernel.
40.Pp
41The kernel may load and unload modules dynamically as the system runs.
42As a result, applications may observe different directory contents in
43.Pa /system/object
44if they repeatedly rescan the directory.
45If a module is unloaded, its associated
46.Pa /system/object
47files disappear from the hierarchy and subsequent attempts to open them, or to
48read files opened before the module unloaded, elicits an error.
49.Pp
50This file system is generally not present in a non-global zone.
51.Sh FILES
52.Bl -tag -width Pa
53.It Pa /system/object
54Mount point for objfs file system in the global zone.
55.El
56.Sh Interface Stability
57.Sy Private
58.Sh SEE ALSO
59.Xr vfstab 5
60.Sh NOTES
61The content of the ELF files is private to the implementation and subject to
62change without notice.
63