Paths

Table of Contentst

hwt(8) utility added
Needs ReviewPublic
Actions

Authored by br on Jun 23 2023, 6:56 PM.

Details

Reviewers

andrew
zachary.leaf_arm.com

Summary

This instrumentation tool is a part of hwt(4) framework. It controls tracing units.

hwt(8) tool takes a path to an executable as an argument, creates kernel tracing context, then runs the application with tracing unit enabled.
Once some traces collected, hwt(8) decodes data using OpenCSD framework (on arm64) and prints the trace results in human readable format to standard output.

Test Plan

Tested with ARM Coresight on ARM Morello board.

Example usage, thread mode.

In this scenario we will be tracing all the threads of "test" executable, but decode only thread 0.

sudo ./hwt -t 0 ./test/test

In this scenario we will be tracing main() fuction of test executable only.

sudo ./hwt -t 0 ./test/test -i test -f main

In this scenario we will be tracing strlen() function of test executable only.

sudo ./hwt -t 0 ./test/test -i libc.so.7 -f strlen

CPU mode. In this scenario tracing context collects information for CPUs number 1 and 3 */

sudo ./hwt -s 3,1 -i kernel -f cpu_switch

Diff Detail

Lint

Lint Skipped

Unit

Tests Skipped

Event Timeline

br created this revision.Jun 23 2023, 6:56 PM

Herald added a reviewer: andrew. · View Herald TranscriptJun 23 2023, 6:56 PM

Herald added a subscriber: emaste. · View Herald Transcript

br requested review of this revision.Jun 23 2023, 6:56 PM

br added a parent revision: D40477: HWT: ARM CoreSight support.

br added a parent revision: D40466: Hardware Trace (HWT) framework.Jun 23 2023, 7:08 PM

Add '-t' argument allowing to specify thread index we want to read trace for.

Regenerate

zachary.leaf_arm.com added a subscriber: zachary.leaf_arm.com.Jul 4 2023, 9:54 AM

ip range filtering added

suspend a single thread on mmap, not entire proc

Abstract tracing devices

usage() added

Add kernel-mode tracing support.

allow tracing multiple cpus in system mode

format flag added

Add -R (fs_root) flag.

decode multiple cpus at the same time

Herald added a reviewer: bdrewery. · View Herald TranscriptAug 3 2023, 6:11 PM

Herald added a reviewer: bhyve. · View Herald Transcript

Herald added subscribers: jrtc27, dab, bcran and 2 others. · View Herald Transcript

Regenerate

br removed reviewers: andrew, bdrewery, bhyve.Aug 3 2023, 6:34 PM

br removed subscribers: delphij, rgrimes, bcran and 2 others.

cleanup

Herald added a reviewer: andrew. · View Herald TranscriptAug 8 2023, 12:35 PM

br edited the test plan for this revision. (Show Details)Aug 8 2023, 1:21 PM

Allow attaching to an existed proc;
Add support for libxo

obtain ETM IDR registers from sysctl. This is needed for Juno

zachary.leaf_arm.com added inline comments.Aug 21 2023, 11:18 AM

usr.sbin/hwt/hwt.c
60	What's `hwt_libxo.h`?

remove hwt_libxo.h as not needed

br added inline comments.Aug 21 2023, 11:48 AM

usr.sbin/hwt/hwt.c
60	That is not needed (Leftovers from libxo integration)

rebase for freebsd

andrew added inline comments.Sep 28 2023, 1:21 PM

usr.sbin/hwt/Makefile
2	`#FreeBSD$`
usr.sbin/hwt/hwt.c
172	This needs to be updated after making cpu_map a pointer.
203	Debug `printf`? And `%#p` isn't valid outsize of CheriBSD.

mhorne mentioned this in D35709: fix pmcstat .Oct 10 2023, 5:24 PM

Intel PT support added by Bojan Novković

zachary.leaf_arm.com added a reviewer: zachary.leaf_arm.com.Mar 14 2024, 5:25 PM

SPE added

Regenerate for Intel PT

Switch coresight to EL2 otherwise it does not trace CPU mode.

hwt_fmt added

Herald added a subscriber: ziaee. · View Herald TranscriptMay 22 2025, 10:56 AM

ziaee added inline comments.Jun 14 2025, 3:07 PM

usr.sbin/hwt/hwt.8
1 ↗	(On Diff #155855)	No need to have the license in the text anymore, or use a dash at the beginning; check out style(9) in current or the licensing guide: https://docs.freebsd.org/en/articles/license-guide/
30 ↗	(On Diff #155855)	No need to quote this, mdoc and style.mdoc both show it unquoted.
54 ↗	(On Diff #155855)
66 ↗	(On Diff #155855)
66 ↗	(On Diff #155855)
67 ↗	(On Diff #155855)
96 ↗	(On Diff #155855)
130 ↗	(On Diff #155855)	This also doesn't need to be quoted

This is so cool! You can check for linter complaints with mandoc -Tlint here/is/the/manual.8

usr.sbin/hwt/hwt.8
25 ↗	(On Diff #155855)	No trailing zero, linter complains
26 ↗	(On Diff #155855)	Dt's are uppercase
56 ↗	(On Diff #155855)
58 ↗	(On Diff #155855)
91 ↗	(On Diff #155855)
96 ↗	(On Diff #155855)	Should we alphabetize these entries?
110 ↗	(On Diff #155855)
131 ↗	(On Diff #155855)	No Pp before Sh
133 ↗	(On Diff #155855)	Linter complains ^.^
137 ↗	(On Diff #155855)

take run time linker path from ELF binary rather than from INTERP record
address ziaee's comments

andrew mentioned this in D51374: packages: add package ucl for libopencsd-all.Jul 17 2025, 3:37 PM

Revision Contents
Changeset List

Path

Size

usr.sbin/

Makefile.aarch64

1 line

ac/

ac.c

2 lines

acpi/

acpiconf/

acpiconf.c

2 lines

acpidb/

acpidb.c

2 lines

acpidump/

2 lines

2 lines

2 lines

2 lines

adduser/

adduser.sh

2 lines

rmuser.sh

2 lines

apmd/

2 lines

2 lines

2 lines

2 lines

autofs/

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

bhyve/

1 line

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

19 lines

2 lines

2 lines

2 lines

11 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

16 lines

2 lines

2 lines

2 lines

7 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

13 lines

22 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

3 lines

147 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

bhyvectl/

bhyvectl.c

2 lines

bhyveload/

bhyveload.c

2 lines

bluetooth/

bcmfw/

bcmfw.c

2 lines

bthidcontrol/

2 lines

2 lines

2 lines

2 lines

bthidd/

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

btpand/

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

hccontrol/

adv_data.c

2 lines

hccontrol.h

2 lines

hccontrol.c

2 lines

host_controller_baseband.c

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

hcsecd/

2 lines

2 lines

2 lines

2 lines

iwmbtfw/

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

l2control/

l2cap.c

2 lines

l2control.h

2 lines

l2control.c

2 lines

l2ping/

l2ping.c

2 lines

rfcomm_pppd/

rfcomm_pppd.c

2 lines

sdpcontrol/

sdpcontrol.h

2 lines

sdpcontrol.c

2 lines

search.c

2 lines

sdpd/

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

boot0cfg/

boot0cfg.c

2 lines

boottrace/

boottrace.8

2 lines

boottrace.c

2 lines

bsdinstall/

distextract/

distextract.c

2 lines

distfetch/

distfetch.c

2 lines

partedit/

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

bsnmpd/

modules/

snmp_bridge/

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

snmp_hast/

hast_snmp.c

2 lines

snmp_pf/

pf_snmp.c

2 lines

snmp_wlan/

wlan_snmp.h

2 lines

wlan_snmp.c

2 lines

wlan_sys.c

2 lines

btxld/

2 lines

2 lines

2 lines

2 lines

certctl/

certctl.8

2 lines

certctl.sh

2 lines

ckdist/

ckdist.c

2 lines

clear_locks/

clear_locks.c

2 lines

cpucontrol/

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

ctladm/

ctladm.c

2 lines

ctld/

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

cxgbetool/

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

daemon/

tests/

daemon_test.sh

2 lines

devinfo/

devinfo.c

2 lines

dumpcis/

main.c

2 lines

efiwake/

Makefile

2 lines

efiwake.8

efiwake.c

2 lines

etcupdate/

etcupdate.sh

2 lines

extattrctl/

extattrctl.c

2 lines

fdcontrol/

fdcontrol.c

2 lines

fdformat/

fdformat.c

2 lines

fdread/

fdread.c

2 lines

fdutil.h

2 lines

fdutil.c

2 lines

fifolog/

fifolog_create/

fifolog_create.c

2 lines

fifolog_reader/

fifolog_reader.c

2 lines

fifolog_writer/

fifolog_writer.c

2 lines

lib/

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

flowctl/

flowctl.c

2 lines

freebsd-update/

freebsd-update.sh

22 lines

fstyp/

befs.c

2 lines

tests/

fstyp_test.sh

2 lines

fwget/

fwget.sh

2 lines

pci/

pci

2 lines

pci_video_amd

2 lines

pci_video_intel

16 lines

gpioctl/

gpioctl.c

2 lines

gssd/

gssd.c

2 lines

gstat/

gstat.c

2 lines

hwt/

21 lines

602 lines

284 lines

781 lines

136 lines

141 lines

142 lines

99 lines

52 lines

58 lines

i2c/

i2c.c

2 lines

inetd/

builtins.c

2 lines

iscsid/

discovery.c

2 lines

iscsid.h

2 lines

iscsid.c

2 lines

jail/

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

tests/

jail_basic_test.sh

2 lines

jexec/

jexec.c

2 lines

jls/

jls.c

2 lines

kbdcontrol/

kbdcontrol.c

2 lines

lex.h

2 lines

lex.l

2 lines

kbdmap/

kbdmap.h

2 lines

kbdmap.c

2 lines

kldxref/

2 lines

2 lines

2 lines

2 lines

2 lines

lpr/

chkprintcap/

skimprintcap.h

2 lines

skimprintcap.c

2 lines

common_source/

2 lines

2 lines

2 lines

2 lines

2 lines

filters.ru/

koi2855/

koi2855.c

2 lines

koi2alt/

koi2alt.c

2 lines

lpc/

movejobs.c

2 lines

makefs/

cd9660.h

2 lines

cd9660.c

2 lines

cd9660/

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

ffs/

2 lines

2 lines

2 lines

2 lines

2 lines

tests/

makefs_zfs_tests.sh

2 lines

zfs.c

2 lines

zfs/

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

memcontrol/

memcontrol.c

2 lines

mfiutil/

mfi_bbu.c

2 lines

mfi_foreign.c

2 lines

mfi_properties.c

2 lines

mlxcontrol/

2 lines

2 lines

2 lines

2 lines

2 lines

mountd/

mountd.c

87 lines

mptable/

mptable.c

2 lines

mtest/

mtest.c

2 lines

newsyslog/

extern.h

2 lines

pciconf/

err.c

2 lines

periodic/

etc/

security/

100.chksetuid

2 lines

110.neggrpperm

2 lines

pkg/

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

pmc/

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

pmcannotate/

pmcannotate.c

2 lines

pmccontrol/

pmccontrol.c

7 lines

pmcstat/

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

4 lines

2 lines

2 lines

2 lines

pnfsdscopymr/

pnfsdscopymr.c

2 lines

pnfsdsfile/

pnfsdsfile.c

2 lines

pnfsdskill/

pnfsdskill.c

2 lines

powerd/

powerd.c

2 lines

ppp/

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

pppctl/

pppctl.c

2 lines

pw/

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

36 lines

2 lines

2 lines

2 lines

2 lines

pwm/

pwm.c

2 lines

rpc.tlsclntd/

rpc.tlsclntd.c

2 lines

rpc.tlsservd/

rpc.tlscommon.h

2 lines

rpc.tlscommon.c

2 lines

rpc.tlsservd.c

2 lines

rpc.umntall/

mounttab.h

2 lines

mounttab.c

2 lines

rpc.umntall.c

2 lines

rpcbind/

util.c

2 lines

rtadvctl/

rtadvctl.c

2 lines

rtadvd/

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

2 lines

sa/

db.c

2 lines

service/

service.sh

2 lines

services_mkdb/

extern.h

2 lines

services_mkdb.c

2 lines

uniq.c

2 lines

setfmac/

setfmac.c

2 lines

smbmsg/

pathnames.h

2 lines

smbmsg.c

2 lines

snapinfo/

snapinfo.c

2 lines

spkrtest/

spkrtest.sh

2 lines

syslogd/

syslogd.c

2 lines

tcpsso/

tcpsso.8

2 lines

tcpsso.c

2 lines

traceroute/

findsaddr-udp.c

2 lines

trim/

trim.c

2 lines

uathload/

uathload.c

2 lines

uefisign/

2 lines

2 lines

2 lines

2 lines

2 lines

ugidfw/

ugidfw.c

2 lines

uhsoctl/

uhsoctl.c

2 lines

unbound/

setup/

local-unbound-setup.sh

2 lines

usbconfig/

dump.h

2 lines

dump.c

2 lines

usbconfig.c

2 lines

usbdump/

usbdump.c

2 lines

utx/

utx.c

2 lines

wake/

wake.c

2 lines

watchdogd/

watchdogd.c

2 lines

wlandebug/

wlandebug.c

2 lines

ypset/

ypset.c

2 lines

hwt(8) utility addedNeeds ReviewPublicActions

Details

Diff Detail

Event Timeline

Revision ContentsChangeset List

Diff 125526

usr.sbin/Makefile.aarch64

usr.sbin/ac/ac.c

usr.sbin/acpi/acpiconf/acpiconf.c

usr.sbin/acpi/acpidb/acpidb.c

usr.sbin/acpi/acpidump/acpi.c

usr.sbin/acpi/acpidump/acpi_user.c

usr.sbin/acpi/acpidump/acpidump.h

usr.sbin/acpi/acpidump/acpidump.c

usr.sbin/adduser/adduser.sh

usr.sbin/adduser/rmuser.sh

usr.sbin/apmd/apmd.h

usr.sbin/apmd/apmd.c

usr.sbin/apmd/apmdlex.l

usr.sbin/apmd/apmdparse.y

usr.sbin/autofs/automount.c

usr.sbin/autofs/automountd.c

usr.sbin/autofs/autounmountd.c

usr.sbin/autofs/common.h

usr.sbin/autofs/common.c

usr.sbin/autofs/defined.c

usr.sbin/autofs/log.c

usr.sbin/autofs/token.l

usr.sbin/bhyve/Makefile

usr.sbin/bhyve/acpi.h

usr.sbin/bhyve/acpi.c

usr.sbin/bhyve/acpi_device.h

usr.sbin/bhyve/acpi_device.c

usr.sbin/bhyve/ahci.h

usr.sbin/bhyve/atkbdc.c

usr.sbin/bhyve/audio.h

usr.sbin/bhyve/audio.c

usr.sbin/bhyve/bhyve.8

usr.sbin/bhyve/bhyvegc.h

usr.sbin/bhyve/bhyvegc.c

usr.sbin/bhyve/bhyverun.h

usr.sbin/bhyve/bhyverun.c

usr.sbin/bhyve/block_if.h

usr.sbin/bhyve/block_if.c

usr.sbin/bhyve/bootrom.h

usr.sbin/bhyve/bootrom.c

usr.sbin/bhyve/config.h

usr.sbin/bhyve/config.c

usr.sbin/bhyve/console.h

usr.sbin/bhyve/console.c

usr.sbin/bhyve/debug.h

usr.sbin/bhyve/e820.c

usr.sbin/bhyve/fwctl.h

usr.sbin/bhyve/fwctl.c

usr.sbin/bhyve/gdb.h

usr.sbin/bhyve/gdb.c

usr.sbin/bhyve/hda_codec.c

usr.sbin/bhyve/hda_reg.h

usr.sbin/bhyve/hdac_reg.h

usr.sbin/bhyve/inout.h

usr.sbin/bhyve/inout.c

usr.sbin/bhyve/ioapic.h

usr.sbin/bhyve/ioapic.c

usr.sbin/bhyve/iov.h

usr.sbin/bhyve/iov.c

usr.sbin/bhyve/ipc.h

usr.sbin/bhyve/kernemu_dev.h

usr.sbin/bhyve/kernemu_dev.c

usr.sbin/bhyve/mem.h

usr.sbin/bhyve/mem.c

usr.sbin/bhyve/mevent.h

usr.sbin/bhyve/mevent.c

usr.sbin/bhyve/mevent_test.c

usr.sbin/bhyve/mptbl.h

usr.sbin/bhyve/mptbl.c

usr.sbin/bhyve/net_backends.h

usr.sbin/bhyve/net_backends.c

usr.sbin/bhyve/net_utils.h

usr.sbin/bhyve/net_utils.c

usr.sbin/bhyve/pci_ahci.c

hwt(8) utility added
Needs ReviewPublic
Actions

Revision Contents
Changeset List