Page MenuHomeFreeBSD
Differential D15865

Provide process space virtualisation functionality for jails.
Needs ReviewPublic
Actions

Authored by bz on Jun 17 2018, 2:55 PM.
Tags
None
Referenced Files
Unknown Object (File)
Tue, Mar 11, 4:29 AM
Unknown Object (File)
Tue, Mar 4, 10:50 PM
Unknown Object (File)
Tue, Mar 4, 10:10 PM
Unknown Object (File)
Tue, Mar 4, 6:11 PM
Unknown Object (File)
Tue, Mar 4, 2:07 PM
Unknown Object (File)
Fri, Feb 28, 11:41 PM
Unknown Object (File)
Sat, Feb 22, 3:48 AM
Unknown Object (File)
Feb 1 2025, 12:52 AM
View All 65 Files
Subscribers
ae
andrew
crest_freebsd_rlwinm.de
dfr
editor_callfortesting.org
emaste
fabian.freyer_physik.tu-berlin.de
View All 17 Subscribers

Details

Reviewers
jamie
kib
jhb
andrew
Summary

This is the initial logic which will give a jail its own init,
have a dedicated kernel process "0" (swapper) per jail, its
own pid, etc. space if enabled.
Add ddb support to aid debugging as was done for vnet.

Obtained from: http://www.7he.at/freebsd/vps/files/diffs/vps-r215.diff

		(parts, originally as provided by iXsystems, Inc.)

Sponsored by: iXsystems, Inc.

Diff Detail

Lint
Lint Passed
Unit
No Test Coverage
Build Status
Buildable 17983
Build 17737: arc lint + arc unit

Event Timeline

bz created this revision.Jun 17 2018, 2:55 PM
Harbormaster completed remote builds in B17372: Diff 43944.Jun 17 2018, 2:55 PM
bz added a parent revision: D15570: Virtualization of basic variables and locks for jail+vps..Jun 18 2018, 3:24 PM
jamie added inline comments.Jun 18 2018, 6:51 PM
sys/kern/init_main.c
708

Panicking seems harsh when kproc_create can fail simply because the process limit has been hit. Is there a way to just fail the jail creation, or if not that to destroy the jail? Perhaps with a warning - a sort of VPS panic.

sys/kern/kern_resource.c
1277

Is this something you've found to happen? I know that zombie jails often sit around indefinitely waiting for a cred hold to go away; perhaps it's something like that?

bz edited parent revisions, added: D15906: Implement "global" process (and zombie) lists loops iterating over all vps instances and all processes in each.; removed: D15570: Virtualization of basic variables and locks for jail+vps..Jun 19 2018, 4:36 PM
bz added a comment.Jun 19 2018, 11:46 PM

Follow-up on comments to @jamie

sys/kern/init_main.c
708

Yes. There's a few such situations; we would need to add a flag to the vps structure, check in between every sysinit invokation; in case of error, undo the exact bits we already allocated/initialised, and the return an error to jail creation. We never did for vnets; maybe it's time; but the cleanup can be "complex" to get fully symmetric. For the moment having well-defined errors (panic) seems better while developing.

sys/kern/kern_resource.c
1277

Yes I have but so far no one has ever tried to cleanly shutdown process space so (as with vnet) we expect to find certain leaks. I am sure that the buffer cache is a major problem for process space references. One thing at a time though. At the moment I am seeing linger DYING jails around with plain HEAD and not even vnets; took something over 50 days for one to go. Need a more general "tracker" which I do not want to intermix with this work.

freqlabs added a subscriber: freqlabs.Jun 22 2018, 7:39 PM
swills added a subscriber: swills.Jul 4 2018, 4:41 PM
bz updated this revision to Diff 45169.Jul 11 2018, 3:50 PM
  • Merge branch 'p2' into p3
Herald added subscribers: emaste, ae. · View Herald TranscriptJul 11 2018, 3:50 PM
Harbormaster completed remote builds in B17983: Diff 45169.Jul 11 2018, 3:50 PM
marius.h_lden.org added a subscriber: marius.h_lden.org.Mar 18 2019, 11:31 PM
Herald added a subscriber: andrew. · View Herald TranscriptMar 18 2019, 11:31 PM
fabian.freyer_physik.tu-berlin.de added a subscriber: fabian.freyer_physik.tu-berlin.de.May 21 2019, 1:25 PM
zlei added a subscriber: zlei.Jan 15 2024, 9:07 AM
Herald added a reviewer: andrew. · View Herald TranscriptJan 15 2024, 9:07 AM
Herald added subscribers: linuxkpi, glebius, melifaro. · View Herald Transcript
freebsd_igalic.co added a subscriber: freebsd_igalic.co.Jan 22 2024, 12:27 AM
meka_tilda.center added a subscriber: meka_tilda.center.Jan 22 2024, 7:55 AM
crest_freebsd_rlwinm.de added a subscriber: crest_freebsd_rlwinm.de.Jan 30 2024, 6:29 PM
bz mentioned this in D46440: init: Add jail(8) support.Aug 26 2024, 7:21 PM
hrs added a subscriber: hrs.Aug 26 2024, 10:47 PM
editor_callfortesting.org added a subscriber: editor_callfortesting.org.Tue, Mar 18, 6:06 PM

From the Jails Production User call: This work is still of interest, particularly in the context of OCI jail progress.
DCH: "This needs serious rebasing." Do any developers have interest in this feature?

zlei added a subscriber: dfr.Wed, Mar 19, 12:42 AM
In D15865#1126562, @editor_callfortesting.org wrote:

From the Jails Production User call: This work is still of interest, particularly in the context of OCI jail progress.
DCH: "This needs serious rebasing." Do any developers have interest in this feature?

I think @dfr is interested with this :)

dfr added a comment.Wed, Mar 19, 3:06 PM
In D15865#1126691, @zlei wrote:
In D15865#1126562, @editor_callfortesting.org wrote:

From the Jails Production User call: This work is still of interest, particularly in the context of OCI jail progress.
DCH: "This needs serious rebasing." Do any developers have interest in this feature?

I think @dfr is interested with this :)

I read through the diff briefly and as far as I can tell, with this approach, processes inside the vps jail are not visible in the host (or parent jail). If so, this won't work for OCI containers where we need to be able to wait for and reap the initial container process on the host. With Linux pid namespaces, each process has a sequence of pids starting with a host pid, then a viritualised pid for each parent namespace (if any) of the container and finishes with the pid visible inside the container.

Revision Contents
Changeset List

PathSize
sys/
arm/
arm/
6 lines
cddl/
contrib/
opensolaris/
uts/
intel/
dtrace/
4 lines
compat/
linprocfs/
16 lines
linux/
6 lines
4 lines
2 lines
linuxkpi/
common/
src/
25 lines
conf/
1 line
ddb/
23 lines
3 lines
33 lines
77 lines
6 lines
2 lines
2 lines
1 line
dev/
filemon/
29 lines
hwpmc/
36 lines
fs/
devfs/
10 lines
nfs/
4 lines
pseudofs/
17 lines
i386/
i386/
6 lines
ibcs2/
19 lines
kern/
23 lines
314 lines
4 lines
143 lines
32 lines
219 lines
97 lines
122 lines
137 lines
33 lines
83 lines
8 lines
325 lines
30 lines
21 lines
147 lines
178 lines
72 lines
59 lines
18 lines
12 lines
5 lines
20 lines
835 lines
25 lines
1 line
12 lines
26 lines
27 lines
22 lines
18 lines
18 lines
4 lines
net/
4 lines
sys/
3 lines
5 lines
62 lines
1 line
1 line
381 lines
vm/
66 lines
25 lines
141 lines
337 lines

Diff 45169

View Options

sys/arm/arm/pmap-v6.c

  • This file was added.
.\" Copyright (c) 2021 The FreeBSD Foundation
.\"
.\" This document was written by Ed Maste under sponsorhip from
.\" The FreeBSD Foundation.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
.\"
.\" $FreeBSD$
.\"
.Dd August 16, 2021
.Dt GONE_IN 9
.Os
.Sh NAME
.Nm gone_in ,
.Nm gone_in_dev
.Nd deprecation notice functions
.Sh SYNOPSIS
.In sys/systm.h
.Ft void
.Fn gone_in "int major" "const char *msg"
.Ft void
.Fn gone_in_dev "device_t dev" "int major" "const char *msg"
.Sh DESCRIPTION
The
.Fn gone_in
functions are used to provide a notice that the kernel is using a driver or
some other functionality that is deprecated, and will be removed in a future
.Fx
release.
The notice is sent to the kernel
.Xr dmesg 8
log and will appear on the console.
The
.Fa major
argument specifies the major version of the
debdrupUnsubmitted
Done
Inline Actions
.Fa major
- argument specifies the major version of the FreeBSD release that will remove
+ argument specifies the major version of the
+ .Fx
+ release that will remove
the deprecated functionality.
debdrup:
.Fx
release that will remove the deprecated functionality.
.Pp
In releases before
.Fa major
the deprecation notice states
.Do
debdrupUnsubmitted
Not Done
Inline Actions
the deprecation notice states
.Do
- Deprecated code (to be removed in FreeBSD
+ Deprecated code (to be removed in
+ .Fx
.Fa major ):
debdrup:
emasteAuthorUnsubmitted
Done
Inline Actions

I think this one probably should not change because it's literal console output.

emaste: I think this one probably should not change because it's literal console output.
Deprecated code (to be removed in FreeBSD
.Fa major Ns ):
emasteAuthorUnsubmitted
Done
Inline Actions

Added Ns here

emaste: Added Ns here
.Fa msg
.Dc .
In releases equal to and after
.Fa major
the notice states
.Do
Obsolete code will be removed soon:
.Fa msg
.Dc .
.Sh EXAMPLES
.Bd -literal -offset indent
void
sample_init(void)
{
/* Initializaiton code omitted. */
impUnsubmitted
Not Done
Inline Actions

11.x ABI compat isn't the headlining reason to retire, necessarily.
In the past this has been more like "Giant locked filesystem" or "Driver not migrated from old API" or simiar

imp: 11.x ABI compat isn't the headlining reason to retire, necessarily. In the past this has been…
emasteAuthorUnsubmitted
Done
Inline Actions

This was copied from an in-tree one, but indeed "Giant locked filesystem" is probably a good canonical example

emaste: This was copied from an in-tree one, but indeed "Giant locked filesystem" is probably a good…
gone_in(14, "Giant-locked filesystem");
}
impUnsubmitted
Done
Inline Actions

int

imp: int
int
example_driver_attach(struct example_driver_softc *sc)
{
impUnsubmitted
Not Done
Inline Actions

This message needs to be more along the lines of "This hardware no longer relevant to FreeBSD" or "This wifi driver doesn't support FooBar crypto" or some other minimum bar.

imp: This message needs to be more along the lines of "This hardware no longer relevant to FreeBSD"…
emasteAuthorUnsubmitted
Done
Inline Actions

Here's some examples from the tree, as they'd appear in dmesg:

Deprecated code (to be removed in FreeBSD 13): pccard removed, an doesn't support modern crypto
Deprecated code (to be removed in FreeBSD 13): pccard removed, an doesn't support modern crypto
Deprecated code (to be removed in FreeBSD 13): amr(4) driver
Deprecated code (to be removed in FreeBSD 13): FreeBSD 11.x ABI compat
Deprecated code (to be removed in FreeBSD 14): FreeBSD 12.x ABI compat
Deprecated code (to be removed in FreeBSD 13): drm2 drivers
Deprecated code (to be removed in FreeBSD 14): esp(4) driver
Deprecated code (to be removed in FreeBSD 14): PC Card to be removed
Deprecated code (to be removed in FreeBSD 14): mly(4) removed
prefixed with the device name/number for gone_in_dev of course

IMO something short like "ISA drivers", "obsolete hardware" etc. is what we should suggest

sys/dev/mly/mly.c
339: gone_in_dev(dev, 13, "");

sys/dev/twa/tw_osl_freebsd.c
416: gone_in_dev(dev, 13, "twa(4) removed");

sys/dev/iir/iir_pci.c
339: gone_in_dev(dev, 13, "iir(4) removed");

emaste: Here's some examples from the tree, as they'd appear in dmesg: Deprecated code (to be removed…
/* Attach code omitted. */
gone_in_dev(sc->dev, 14, "Giant-locked driver");
}
.Ed
.Sh HISTORY
The
impUnsubmitted
Done
Inline Actions

11

imp: 11
.Nm
functions first appeared in
.Fx 11 .
View Options

sys/cddl/contrib/opensolaris/uts/intel/dtrace/fasttrap_isa.c

  • This file was added.
.\" Copyright (c) 2021 The FreeBSD Foundation
.\"
.\" This document was written by Ed Maste under sponsorhip from
.\" The FreeBSD Foundation.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
.\"
.\" $FreeBSD$
.\"
.Dd August 16, 2021
.Dt GONE_IN 9
.Os
.Sh NAME
.Nm gone_in ,
.Nm gone_in_dev
.Nd deprecation notice functions
.Sh SYNOPSIS
.In sys/systm.h
.Ft void
.Fn gone_in "int major" "const char *msg"
.Ft void
.Fn gone_in_dev "device_t dev" "int major" "const char *msg"
.Sh DESCRIPTION
The
.Fn gone_in
functions are used to provide a notice that the kernel is using a driver or
some other functionality that is deprecated, and will be removed in a future
.Fx
release.
The notice is sent to the kernel
.Xr dmesg 8
log and will appear on the console.
The
.Fa major
argument specifies the major version of the
debdrupUnsubmitted
Done
Inline Actions
.Fa major
- argument specifies the major version of the FreeBSD release that will remove
+ argument specifies the major version of the
+ .Fx
+ release that will remove
the deprecated functionality.
debdrup:
.Fx
release that will remove the deprecated functionality.
.Pp
In releases before
.Fa major
the deprecation notice states
.Do
debdrupUnsubmitted
Not Done
Inline Actions
the deprecation notice states
.Do
- Deprecated code (to be removed in FreeBSD
+ Deprecated code (to be removed in
+ .Fx
.Fa major ):
debdrup:
emasteAuthorUnsubmitted
Done
Inline Actions

I think this one probably should not change because it's literal console output.

emaste: I think this one probably should not change because it's literal console output.
Deprecated code (to be removed in FreeBSD
.Fa major Ns ):
emasteAuthorUnsubmitted
Done
Inline Actions

Added Ns here

emaste: Added Ns here
.Fa msg
.Dc .
In releases equal to and after
.Fa major
the notice states
.Do
Obsolete code will be removed soon:
.Fa msg
.Dc .
.Sh EXAMPLES
.Bd -literal -offset indent
void
sample_init(void)
{
/* Initializaiton code omitted. */
impUnsubmitted
Not Done
Inline Actions

11.x ABI compat isn't the headlining reason to retire, necessarily.
In the past this has been more like "Giant locked filesystem" or "Driver not migrated from old API" or simiar

imp: 11.x ABI compat isn't the headlining reason to retire, necessarily. In the past this has been…
emasteAuthorUnsubmitted
Done
Inline Actions

This was copied from an in-tree one, but indeed "Giant locked filesystem" is probably a good canonical example

emaste: This was copied from an in-tree one, but indeed "Giant locked filesystem" is probably a good…
gone_in(14, "Giant-locked filesystem");
}
impUnsubmitted
Done
Inline Actions

int

imp: int
int
example_driver_attach(struct example_driver_softc *sc)
{
impUnsubmitted
Not Done
Inline Actions

This message needs to be more along the lines of "This hardware no longer relevant to FreeBSD" or "This wifi driver doesn't support FooBar crypto" or some other minimum bar.

imp: This message needs to be more along the lines of "This hardware no longer relevant to FreeBSD"…
emasteAuthorUnsubmitted
Done
Inline Actions

Here's some examples from the tree, as they'd appear in dmesg:

Deprecated code (to be removed in FreeBSD 13): pccard removed, an doesn't support modern crypto
Deprecated code (to be removed in FreeBSD 13): pccard removed, an doesn't support modern crypto
Deprecated code (to be removed in FreeBSD 13): amr(4) driver
Deprecated code (to be removed in FreeBSD 13): FreeBSD 11.x ABI compat
Deprecated code (to be removed in FreeBSD 14): FreeBSD 12.x ABI compat
Deprecated code (to be removed in FreeBSD 13): drm2 drivers
Deprecated code (to be removed in FreeBSD 14): esp(4) driver
Deprecated code (to be removed in FreeBSD 14): PC Card to be removed
Deprecated code (to be removed in FreeBSD 14): mly(4) removed
prefixed with the device name/number for gone_in_dev of course

IMO something short like "ISA drivers", "obsolete hardware" etc. is what we should suggest

sys/dev/mly/mly.c
339: gone_in_dev(dev, 13, "");

sys/dev/twa/tw_osl_freebsd.c
416: gone_in_dev(dev, 13, "twa(4) removed");

sys/dev/iir/iir_pci.c
339: gone_in_dev(dev, 13, "iir(4) removed");

emaste: Here's some examples from the tree, as they'd appear in dmesg: Deprecated code (to be removed…
/* Attach code omitted. */
gone_in_dev(sc->dev, 14, "Giant-locked driver");
}
.Ed
.Sh HISTORY
The
impUnsubmitted
Done
Inline Actions

11

imp: 11
.Nm
functions first appeared in
.Fx 11 .
View Options

sys/compat/linprocfs/linprocfs.c

  • This file was added.
.\" Copyright (c) 2021 The FreeBSD Foundation
.\"
.\" This document was written by Ed Maste under sponsorhip from
.\" The FreeBSD Foundation.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
.\"
.\" $FreeBSD$
.\"
.Dd August 16, 2021
.Dt GONE_IN 9
.Os
.Sh NAME
.Nm gone_in ,
.Nm gone_in_dev
.Nd deprecation notice functions
.Sh SYNOPSIS
.In sys/systm.h
.Ft void
.Fn gone_in "int major" "const char *msg"
.Ft void
.Fn gone_in_dev "device_t dev" "int major" "const char *msg"
.Sh DESCRIPTION
The
.Fn gone_in
functions are used to provide a notice that the kernel is using a driver or
some other functionality that is deprecated, and will be removed in a future
.Fx
release.
The notice is sent to the kernel
.Xr dmesg 8
log and will appear on the console.
The
.Fa major
argument specifies the major version of the
debdrupUnsubmitted
Done
Inline Actions
.Fa major
- argument specifies the major version of the FreeBSD release that will remove
+ argument specifies the major version of the
+ .Fx
+ release that will remove
the deprecated functionality.
debdrup:
.Fx
release that will remove the deprecated functionality.
.Pp
In releases before
.Fa major
the deprecation notice states
.Do
debdrupUnsubmitted
Not Done
Inline Actions
the deprecation notice states
.Do
- Deprecated code (to be removed in FreeBSD
+ Deprecated code (to be removed in
+ .Fx
.Fa major ):
debdrup:
emasteAuthorUnsubmitted
Done
Inline Actions

I think this one probably should not change because it's literal console output.

emaste: I think this one probably should not change because it's literal console output.
Deprecated code (to be removed in FreeBSD
.Fa major Ns ):
emasteAuthorUnsubmitted
Done
Inline Actions

Added Ns here

emaste: Added Ns here
.Fa msg
.Dc .
In releases equal to and after
.Fa major
the notice states
.Do
Obsolete code will be removed soon:
.Fa msg
.Dc .
.Sh EXAMPLES
.Bd -literal -offset indent
void
sample_init(void)
{
/* Initializaiton code omitted. */
impUnsubmitted
Not Done
Inline Actions

11.x ABI compat isn't the headlining reason to retire, necessarily.
In the past this has been more like "Giant locked filesystem" or "Driver not migrated from old API" or simiar

imp: 11.x ABI compat isn't the headlining reason to retire, necessarily. In the past this has been…
emasteAuthorUnsubmitted
Done
Inline Actions

This was copied from an in-tree one, but indeed "Giant locked filesystem" is probably a good canonical example

emaste: This was copied from an in-tree one, but indeed "Giant locked filesystem" is probably a good…
gone_in(14, "Giant-locked filesystem");
}
impUnsubmitted
Done
Inline Actions

int

imp: int
int
example_driver_attach(struct example_driver_softc *sc)
{
impUnsubmitted
Not Done
Inline Actions

This message needs to be more along the lines of "This hardware no longer relevant to FreeBSD" or "This wifi driver doesn't support FooBar crypto" or some other minimum bar.

imp: This message needs to be more along the lines of "This hardware no longer relevant to FreeBSD"…
emasteAuthorUnsubmitted
Done
Inline Actions

Here's some examples from the tree, as they'd appear in dmesg:

Deprecated code (to be removed in FreeBSD 13): pccard removed, an doesn't support modern crypto
Deprecated code (to be removed in FreeBSD 13): pccard removed, an doesn't support modern crypto
Deprecated code (to be removed in FreeBSD 13): amr(4) driver
Deprecated code (to be removed in FreeBSD 13): FreeBSD 11.x ABI compat
Deprecated code (to be removed in FreeBSD 14): FreeBSD 12.x ABI compat
Deprecated code (to be removed in FreeBSD 13): drm2 drivers
Deprecated code (to be removed in FreeBSD 14): esp(4) driver
Deprecated code (to be removed in FreeBSD 14): PC Card to be removed
Deprecated code (to be removed in FreeBSD 14): mly(4) removed
prefixed with the device name/number for gone_in_dev of course

IMO something short like "ISA drivers", "obsolete hardware" etc. is what we should suggest

sys/dev/mly/mly.c
339: gone_in_dev(dev, 13, "");

sys/dev/twa/tw_osl_freebsd.c
416: gone_in_dev(dev, 13, "twa(4) removed");

sys/dev/iir/iir_pci.c
339: gone_in_dev(dev, 13, "iir(4) removed");

emaste: Here's some examples from the tree, as they'd appear in dmesg: Deprecated code (to be removed…
/* Attach code omitted. */
gone_in_dev(sc->dev, 14, "Giant-locked driver");
}
.Ed
.Sh HISTORY
The
impUnsubmitted
Done
Inline Actions

11

imp: 11
.Nm
functions first appeared in
.Fx 11 .
View Options

sys/compat/linux/linux_file.c

  • This file was added.
.\" Copyright (c) 2021 The FreeBSD Foundation
.\"
.\" This document was written by Ed Maste under sponsorhip from
.\" The FreeBSD Foundation.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
.\"
.\" $FreeBSD$
.\"
.Dd August 16, 2021
.Dt GONE_IN 9
.Os
.Sh NAME
.Nm gone_in ,
.Nm gone_in_dev
.Nd deprecation notice functions
.Sh SYNOPSIS
.In sys/systm.h
.Ft void
.Fn gone_in "int major" "const char *msg"
.Ft void
.Fn gone_in_dev "device_t dev" "int major" "const char *msg"
.Sh DESCRIPTION
The
.Fn gone_in
functions are used to provide a notice that the kernel is using a driver or
some other functionality that is deprecated, and will be removed in a future
.Fx
release.
The notice is sent to the kernel
.Xr dmesg 8
log and will appear on the console.
The
.Fa major
argument specifies the major version of the
debdrupUnsubmitted
Done
Inline Actions
.Fa major
- argument specifies the major version of the FreeBSD release that will remove
+ argument specifies the major version of the
+ .Fx
+ release that will remove
the deprecated functionality.
debdrup:
.Fx
release that will remove the deprecated functionality.
.Pp
In releases before
.Fa major
the deprecation notice states
.Do
debdrupUnsubmitted
Not Done
Inline Actions
the deprecation notice states
.Do
- Deprecated code (to be removed in FreeBSD
+ Deprecated code (to be removed in
+ .Fx
.Fa major ):
debdrup:
emasteAuthorUnsubmitted
Done
Inline Actions

I think this one probably should not change because it's literal console output.

emaste: I think this one probably should not change because it's literal console output.
Deprecated code (to be removed in FreeBSD
.Fa major Ns ):
emasteAuthorUnsubmitted
Done
Inline Actions

Added Ns here

emaste: Added Ns here
.Fa msg
.Dc .
In releases equal to and after
.Fa major
the notice states
.Do
Obsolete code will be removed soon:
.Fa msg
.Dc .
.Sh EXAMPLES
.Bd -literal -offset indent
void
sample_init(void)
{
/* Initializaiton code omitted. */
impUnsubmitted
Not Done
Inline Actions

11.x ABI compat isn't the headlining reason to retire, necessarily.
In the past this has been more like "Giant locked filesystem" or "Driver not migrated from old API" or simiar

imp: 11.x ABI compat isn't the headlining reason to retire, necessarily. In the past this has been…
emasteAuthorUnsubmitted
Done
Inline Actions

This was copied from an in-tree one, but indeed "Giant locked filesystem" is probably a good canonical example

emaste: This was copied from an in-tree one, but indeed "Giant locked filesystem" is probably a good…
gone_in(14, "Giant-locked filesystem");
}
impUnsubmitted
Done
Inline Actions

int

imp: int
int
example_driver_attach(struct example_driver_softc *sc)
{
impUnsubmitted
Not Done
Inline Actions

This message needs to be more along the lines of "This hardware no longer relevant to FreeBSD" or "This wifi driver doesn't support FooBar crypto" or some other minimum bar.

imp: This message needs to be more along the lines of "This hardware no longer relevant to FreeBSD"…
emasteAuthorUnsubmitted
Done
Inline Actions

Here's some examples from the tree, as they'd appear in dmesg:

Deprecated code (to be removed in FreeBSD 13): pccard removed, an doesn't support modern crypto
Deprecated code (to be removed in FreeBSD 13): pccard removed, an doesn't support modern crypto
Deprecated code (to be removed in FreeBSD 13): amr(4) driver
Deprecated code (to be removed in FreeBSD 13): FreeBSD 11.x ABI compat
Deprecated code (to be removed in FreeBSD 14): FreeBSD 12.x ABI compat
Deprecated code (to be removed in FreeBSD 13): drm2 drivers
Deprecated code (to be removed in FreeBSD 14): esp(4) driver
Deprecated code (to be removed in FreeBSD 14): PC Card to be removed
Deprecated code (to be removed in FreeBSD 14): mly(4) removed
prefixed with the device name/number for gone_in_dev of course

IMO something short like "ISA drivers", "obsolete hardware" etc. is what we should suggest

sys/dev/mly/mly.c
339: gone_in_dev(dev, 13, "");

sys/dev/twa/tw_osl_freebsd.c
416: gone_in_dev(dev, 13, "twa(4) removed");

sys/dev/iir/iir_pci.c
339: gone_in_dev(dev, 13, "iir(4) removed");

emaste: Here's some examples from the tree, as they'd appear in dmesg: Deprecated code (to be removed…
/* Attach code omitted. */
gone_in_dev(sc->dev, 14, "Giant-locked driver");
}
.Ed
.Sh HISTORY
The
impUnsubmitted
Done
Inline Actions

11

imp: 11
.Nm
functions first appeared in
.Fx 11 .
View Options

sys/compat/linux/linux_fork.c

Loading...
View Options

sys/compat/linux/linux_misc.c

Loading...
View Options

sys/compat/linuxkpi/common/src/linux_current.c

Loading...
View Options

sys/conf/files

Loading...
View Options

sys/ddb/db_command.c

Loading...
View Options

sys/ddb/db_expr.c

Loading...
View Options

sys/ddb/db_ps.c

Loading...
View Options

sys/ddb/db_sym.c

Loading...
View Options

sys/ddb/db_thread.c

Loading...
View Options

sys/ddb/db_variables.h

Loading...
View Options

sys/ddb/db_variables.c

Loading...
View Options

sys/ddb/ddb.h

Loading...
View Options

sys/dev/filemon/filemon.c

Loading...
View Options

sys/dev/hwpmc/hwpmc_mod.c

Loading...
View Options

sys/fs/devfs/devfs_vnops.c

Loading...
View Options

sys/fs/nfs/nfsport.h

Loading...
View Options

sys/fs/pseudofs/pseudofs_vnops.c

Loading...
View Options

sys/i386/i386/pmap.c

Loading...
View Options

sys/i386/ibcs2/ibcs2_sysvec.c

Loading...
View Options

sys/kern/imgact_elf.c

Loading...
View Options

sys/kern/init_main.c

Loading...
View Options

sys/kern/kern_acct.c

Loading...
View Options

sys/kern/kern_clock.c

Loading...
View Options

sys/kern/kern_cpuset.c

Loading...
View Options

sys/kern/kern_descrip.c

Loading...
View Options

sys/kern/kern_exit.c

Loading...
View Options

sys/kern/kern_fork.c

Loading...
View Options

sys/kern/kern_jail.c

Loading...
View Options

sys/kern/kern_kthread.c

Loading...
View Options

sys/kern/kern_ktrace.c

Loading...
View Options

sys/kern/kern_mib.c

Loading...
View Options

sys/kern/kern_proc.c

Loading...
View Options

sys/kern/kern_procctl.c

Loading...
View Options

sys/kern/kern_prot.c

Loading...
View Options

sys/kern/kern_racct.c

Loading...
View Options

sys/kern/kern_rctl.c

Loading...
View Options

sys/kern/kern_resource.c

Loading...
View Options

sys/kern/kern_shutdown.c

Loading...
View Options

sys/kern/kern_sig.c

Loading...
View Options

sys/kern/kern_sysctl.c

Loading...
View Options

sys/kern/kern_thr.c

Loading...
View Options

sys/kern/kern_thread.c

Loading...
View Options

sys/kern/kern_vps.c

Loading...
View Options

sys/kern/sched_4bsd.c

Loading...
View Options

sys/kern/subr_pcpu.c

Loading...
View Options

sys/kern/subr_prf.c

Loading...
View Options

sys/kern/subr_turnstile.c

Loading...
View Options

sys/kern/subr_witness.c

Loading...
View Options

sys/kern/sys_procdesc.c

Loading...
View Options

sys/kern/sys_process.c

Loading...
View Options

sys/kern/tty.c

Loading...
View Options

sys/kern/tty_tty.c

Loading...
View Options

sys/net/vnet.c

Loading...
View Options

sys/sys/jail.h

Loading...
View Options

sys/sys/kernel.h

Loading...
View Options

sys/sys/proc.h

Loading...
View Options

sys/sys/resourcevar.h

Loading...
View Options

sys/sys/sysctl.h

Loading...
View Options

sys/sys/vps.h

Loading...
View Options

sys/vm/vm_meter.c

Loading...
View Options

sys/vm/vm_object.c

Loading...
View Options

sys/vm/vm_pageout.c

Loading...
View Options

sys/vm/vm_swapout.c

Loading...