Go to file
Mark Johnston ddf0ed09bd sdt: Implement SDT probes using hot-patching
The idea here is to avoid a memory access and conditional branch per
probe site.  Instead, the probe is represented by an "unreachable"
unconditional function call.  asm goto is used to store the address of
the probe site (represented by a no-op sled) and the address of the
function call into a tracepoint record.  Each SDT probe carries a list
of tracepoints.

When the probe is enabled, the no-op sled corresponding to each
tracepoint is overwritten with a jmp to the corresponding label.  The
implementation uses smp_rendezvous() to park all other CPUs while the
instruction is being overwritten, as this can't be done atomically in
general.  The compiler moves argument marshalling code and the
sdt_probe() function call out-of-line, i.e., to the end of the function.

Per gallatin@ in D43504, this approach has less overhead when probes are
disabled.  To make the implementation a bit simpler, I removed support
for probes with 7 arguments; nothing makes use of this except a
regression test case.  It could be re-added later if need be.

The approach taken in this patch enables some more improvements:
1. We can now automatically fill out the "function" field of SDT probe
   names.  The SDT macros let the programmer specify the function and
   module names, but this is really a bug and shouldn't have been
   allowed.  The intent was to be able to have the same probe in
   multiple functions and to let the user restrict which probes actually
   get enabled by specifying a function name or glob.
2. We can avoid branching on SDT_PROBES_ENABLED() by adding the ability
   to include blocks of code in the out-of-line path.  For example:

	if (SDT_PROBES_ENABLED()) {
		int reason = CLD_EXITED;

		if (WCOREDUMP(signo))
			reason = CLD_DUMPED;
		else if (WIFSIGNALED(signo))
			reason = CLD_KILLED;
		SDT_PROBE1(proc, , , exit, reason);
	}

could be written

	SDT_PROBE1_EXT(proc, , , exit, reason,
		int reason;

		reason = CLD_EXITED;
		if (WCOREDUMP(signo))
			reason = CLD_DUMPED;
		else if (WIFSIGNALED(signo))
			reason = CLD_KILLED;
	);

In the future I would like to use this mechanism more generally, e.g.,
to remove branches and marshalling code used by hwpmc, and generally to
make it easier to add new tracepoint consumers without having to add
more conditional branches to hot code paths.

Reviewed by:	Domagoj Stolfa, avg
MFC after:	2 months
Differential Revision:	https://reviews.freebsd.org/D44483
2024-06-19 16:57:41 -04:00
.cirrus-ci
.github .github: Update the path used for the homebrew LLVM install on macOS 2024-05-02 15:05:15 -07:00
bin csh: Remove hardlink /.cshrc 2024-05-29 09:56:58 +02:00
cddl sdt: Implement SDT probes using hot-patching 2024-06-19 16:57:41 -04:00
contrib pf: convert DIOCBEGINADDRS to netlink 2024-06-08 04:46:43 +02:00
crypto posix_async: FreeBSD also defines {make|swap|get|set}context 2024-05-31 10:53:39 -06:00
etc BSD.tests.dist: add entry for virstor test 2024-06-10 11:56:18 -07:00
gnu misc: Remove ancient SCCS tags. 2023-11-26 22:23:27 -07:00
include stddef.h/stdlib.h: Remove unused rune_t 2024-06-02 19:41:22 +01:00
kerberos5 kerberos5: Mitigate the possibility of using an old libcrypto 2024-01-18 07:12:14 -08:00
lib libsysdecode: support rfork(RFSPAWN) 2024-06-19 21:38:31 +01:00
libexec rc.subr: improve description for ${name}_offcmd 2024-06-18 16:13:51 +07:00
release release: Publish non-uploaded cloudware bits 2024-06-19 12:36:44 -07:00
rescue Remove gbde from rescue 2024-05-07 07:23:38 +00:00
sbin ifconfig: make interface address without mask an error 2024-06-17 20:21:06 -04:00
secure openssl: don't export nonexistant symbols 2024-04-22 21:28:51 +01:00
share arch.7: armv6 will be removed prior to FreeBSD 15.0 2024-06-19 13:40:08 -04:00
stand boot/efi: Fix warning for non-standard formats when debugging 2024-06-14 11:11:05 -06:00
sys sdt: Implement SDT probes using hot-patching 2024-06-19 16:57:41 -04:00
targets Remove gbde from the "userland" pseudo-target 2024-05-07 07:35:14 +00:00
tests virstor: basic functional test 2024-06-10 10:32:22 -07:00
tools stress2: Revert change accidentally added in ff4a72c159 2024-06-15 08:33:14 +02:00
usr.bin uniq tests: Make uniq_test:stdout more reliable 2024-06-13 20:00:47 -04:00
usr.sbin Update leap-seconds to leap-seconds.3676924800 2024-06-18 19:10:33 -07:00
.arcconfig arcanist: use FreeBSD/git project repository instead of FreeBSD/svn 2022-08-23 14:16:41 +00:00
.arclint
.cirrus.yml Cirrus-CI: switch to llvm18 by default 2024-04-07 17:23:25 -04:00
.clang-format clang-format: Minor tweaks 2024-04-30 17:33:43 -04:00
.git-blame-ignore-revs Add another commit to .git-blame-ignore-revs 2024-03-15 23:11:52 +00:00
.gitattributes Remove SVN related Git attributes 2023-12-26 10:28:28 -07:00
.gitignore .gitignore: add sys/*/compile 2024-02-02 09:20:36 -07:00
.mailmap mailmap: Translate olce's personal address to olce@FreeBSD.org 2024-01-04 15:59:01 +01:00
CONTRIBUTING.md CONTRIBUTING.md/style: spring cleaning 2024-05-10 15:07:03 -06:00
COPYRIGHT ntp: Vendor import of ntp-4.2.8p18 2024-05-26 15:55:52 -07:00
LOCKS Update LOCKS for Git 2023-12-26 10:28:25 -07:00
MAINTAINERS MAINTAINERS: change linuxkpi review Phabricator group. 2024-01-16 19:23:39 +00:00
Makefile contrib/bsddialog: Import version 1.0.3 2024-05-27 19:51:37 +02:00
Makefile.inc1 Makefile.inc1: Allow showconfig and test-system-* if (X)CC is GCC 2024-06-03 00:16:58 +01:00
Makefile.libcompat build{libcompat}: Pass UNIVERSE_TOOLCHAIN_PATH to the _lc_build-tools submake 2023-08-21 21:00:45 -07:00
Makefile.sys.inc Remove $FreeBSD$: one-line sh pattern 2023-08-16 11:55:03 -06:00
ObsoleteFiles.inc ObsoleteFiles.inc: Add missed riscv64 file for LLVM 17 2024-06-04 18:07:56 +01:00
README.md contrib/bsddialog: Import version 1.0.3 2024-05-27 19:51:37 +02:00
RELNOTES RELNOTES: document MAC/do 2024-05-22 14:05:57 +02:00
UPDATING ifconfig: make interface address without mask an error 2024-06-17 20:21:06 -04:00

FreeBSD Source:

This is the top level of the FreeBSD source directory.

FreeBSD is an operating system used to power modern servers, desktops, and embedded platforms. A large community has continually developed it for more than thirty years. Its advanced networking, security, and storage features have made FreeBSD the platform of choice for many of the busiest web sites and most pervasive embedded networking and storage devices.

For copyright information, please see the file COPYRIGHT in this directory. Additional copyright information also exists for some sources in this tree - please see the specific source directories for more information.

The Makefile in this directory supports a number of targets for building components (or all) of the FreeBSD source tree. See build(7), config(8), FreeBSD handbook on building userland, and Handbook for kernels for more information, including setting make(1) variables.

For information on the CPU architectures and platforms supported by FreeBSD, see the FreeBSD website's Platforms page.

For official FreeBSD bootable images, see the release page.

Source Roadmap:

Directory Description
bin System/user commands.
cddl Various commands and libraries under the Common Development and Distribution License.
contrib Packages contributed by 3rd parties.
crypto Cryptography stuff (see crypto/README).
etc Template files for /etc.
gnu Commands and libraries under the GNU General Public License (GPL) or Lesser General Public License (LGPL). Please see gnu/COPYING and gnu/COPYING.LIB for more information.
include System include files.
kerberos5 Kerberos5 (Heimdal) package.
lib System libraries.
libexec System daemons.
release Release building Makefile & associated tools.
rescue Build system for statically linked /rescue utilities.
sbin System commands.
secure Cryptographic libraries and commands.
share Shared resources.
stand Boot loader sources.
sys Kernel sources (see sys/README.md).
targets Support for experimental DIRDEPS_BUILD
tests Regression tests which can be run by Kyua. See tests/README for additional information.
tools Utilities for regression testing and miscellaneous tasks.
usr.bin User commands.
usr.sbin System administration commands.

For information on synchronizing your source tree with one or more of the FreeBSD Project's development branches, please see FreeBSD Handbook.