Details

Reviewers

Group Reviewers

Contributor Reviews (src)
manpages
scheduler

Summary

I developed the Intel Thread Director (ITD) / Hardware Feedback Interfce (HFI) device driver to obtain performance/efficiency information for each CPU core, which was implemented to improve the performance of Intel hybrid architecture CPUs. (e.g. Raptor Lake (refresh), Alder Lake, LakeField processors)

This driver simply obtains performance/efficiency information from the CPU and stores it in the "cpu_group" struct data referenced by the ULE scheduler.
However, since the ULE scheduler side is not yet supported, performance/efficiency cannot be improved by installing this driver at this time.

I will try to modify the ULE scheduler side in the future, but I posted this driver first because it can be implemented independently of this driver and it is difficult to modify the ULE scheduler.

There are seven patches, and this is the Part 6.
This patch adds the intelhfi's man file & Makefile.

Test Plan

With the remaining patches to be submitted later, I ran the tests listed below.

FreeBSD 15-current: Be able to apply patches to the latest source tree as of 2024/03/20.
FreeBSD 14.0-Release: The source tree can be patched. And the manual can be displayed using the man command.

Due to my development environment, I developed it on FreeBSD 14.0-RELEASE and ported it to FreeBSD 15-current on a virtual environment.
However, I have also confirmed that the parts related to the code modified this time have hardly changed between 14.0-RELEASE and 15-current.
For this reason, I believe that it will probably work with 15-current, but if you are able to test it, please help confirm that it works.

Diff Detail

Repository

rG FreeBSD src repository

Lint

Lint Skipped

Unit

Tests Skipped

Event Timeline

koinec_yahoo.co.jp requested review of this revision.Mar 21 2024, 12:41 PM

koinec_yahoo.co.jp created this revision.

emaste added a parent revision: D44457: intelhfi - Intel TD/HFI driver - Part5: Add intelhfi driver line to the kernel configuration file (GENERIC) & NOTES file..Mar 23 2024, 2:34 PM

emaste added a child revision: D44459: intelhfi - Intel TD/HFI driver - Part7: Add kerneldoc's Doxyfile.

Attach the full context patch file.

part6_add_coredirector_man4_fbsd15c.patch20 KBDownload

koinec_yahoo.co.jp attached a referenced file: F79836364: part6_add_coredirector_man4_fbsd15c.patch. (Show Details)Mar 24 2024, 11:58 AM

Attach the patch file created with the git format-patch command.

0006-Add-the-coredirector-driver-s-man-file-Makefile.patch20 KBDownload

koinec_yahoo.co.jp updated this revision to Diff 138354.May 10 2024, 12:46 PM

koinec_yahoo.co.jp attached a referenced file: F83434448: 0006-Add-the-coredirector-driver-s-man-file-Makefile.patch. (Show Details)

mchoo added a reviewer: Contributor Reviews (src).Jan 7 2026, 6:10 PM

mchoo set the repository for this revision to rG FreeBSD src repository.

mchoo added a project: Contributor Reviews (src).

Herald added subscribers: ziaee, imp. · View Herald TranscriptJan 7 2026, 6:10 PM

mchoo added a subscriber: mchoo.Jan 7 2026, 6:49 PM

mchoo added inline comments.

share/man/man4/coredirector.4
34 ↗	(On Diff #138354)	trivial thing: you can omit "your".
47 ↗	(On Diff #138354)	ditto

ziaee added a reviewer: manpages.Jan 7 2026, 6:51 PM

ziaee added inline comments.

share/man/man4/coredirector.4
1 ↗	(On Diff #138354)	Since you wrote this, we updated the preferred license for new files -- https://docs.freebsd.org/en/articles/license-guide/
31 ↗	(On Diff #138354)	You could save a bit of space writing it like this, which is important on .Nd's so it will fit in one line in apropos results.
62 ↗	(On Diff #138354)	We have a standardish section for these

ziaee added inline comments.Jan 7 2026, 6:55 PM

share/man/man4/coredirector.4
34 ↗	(On Diff #138354)	trivial thing: you can omit "your". Lore: Honestly, this is the historical style we use in FreeBSD, but upstream says it's wrong to put prose in SYNOPSIS. SYNOPSIS is supposed be showing how it's used, like it does in sections 1,2,3,8, and 9. I gave a talk on this at BSDcan, and we do have over 100 driver manuals that are written this way.

mchoo added inline comments.Jan 7 2026, 7:05 PM

share/man/man4/coredirector.4
34 ↗	(On Diff #138354)	I didn't know that. Then we can keep this.

ziaee added inline comments.Jan 7 2026, 9:05 PM

share/man/man4/coredirector.4
34 ↗	(On Diff #138354)	This inspired me to send a mail to arch@ to see if we can move forward on this.

Fix the driver name (coredirector -> intelhfi)
Fix file name with changed the driver name.
Fix review findings. (Copyright style, etc)

koinec_yahoo.co.jp retitled this revision from intelhfi - Intel TD/HFI driver - Part6: Add coredirector's man file & Makefile. to intelhfi - Intel TD/HFI driver - Part6: Add intelhfi's man file & Makefile..Feb 4 2026, 12:54 PM

mchoo requested changes to this revision.Feb 4 2026, 7:37 PM

mchoo added inline comments.

share/man/man4/Makefile
125–126	alphabetical order
858–859	alphabetical order

This revision now requires changes to proceed.Feb 4 2026, 7:37 PM

Correct the driver name insertion line to be in alphabetical order (My mistake. Sorry)

The diff is off. Could you rebase main and create diff with git format-patch -U999999 --stdout main > change.diff?

You can squash all your previous and this one into one commit. (and that's preferred)

This revision now requires changes to proceed.Feb 11 2026, 2:25 PM

Squash the previous review fixes and re-create the patch commit.
Correct the driver name insertion line to be in alphabetical order

mchoo requested changes to this revision.Feb 15 2026, 5:40 PM

mchoo added inline comments.

share/man/man4/intelhfi.4
53	If it works, you can say something like intelhfi driver first appeared in FreeBSD 16.0

This revision now requires changes to proceed.Feb 15 2026, 5:40 PM

ziaee added inline comments.Feb 15 2026, 6:13 PM

share/man/man4/intelhfi.4
1	This hyphen was for an old abandoned parser. Our style guides no longer recommend it.
53	There's more lore here :) "currently under development" was once so common that the mdoc(7) language even has a .Ud macro to type it for you. It's been deprecated since before either of us were born because it was discovered over the generations to be effectively misinformation in practice.

Fix the old style of comments at the beginning of the file (removed hyphens).
Change the HISTORY section from "under development" to "released from FreeBSD 16.0."

LGTM

This revision is now accepted and ready to land.Feb 17 2026, 3:32 PM

mchoo mentioned this in D44459: intelhfi - Intel TD/HFI driver - Part7: Add kerneldoc's Doxyfile.Mar 22 2026, 2:07 AM

Fix and improvement related to HMP(4) support

This revision now requires review to proceed.May 17 2026, 10:20 AM

mchoo requested changes to this revision.May 17 2026, 5:41 PM

mchoo added inline comments.

share/man/man4/intelhfi.4
3	2026
7	This should be the date it was last updated

This revision now requires changes to proceed.May 17 2026, 5:41 PM

ziaee added inline comments.May 17 2026, 6:03 PM

share/man/man4/intelhfi.4
3	I think you can also say `2024, 2025, 2026`, and commonly people write 2024-2026.

Fix the year of creation in the file comment.
Fix the creation date.

LGTM

This revision is now accepted and ready to land.May 23 2026, 11:43 PM

@koinec_yahoo.co.jp Are you fine if I update the diff to match FreeBSD's man style? The content is fine, I just need to rephrase and move sections around for consistency with other man pages. You will still be the only person on the copyright notice and git author.

koinec_yahoo.co.jp marked 8 inline comments as done.Jun 28 2026, 4:24 AM

koinec_yahoo.co.jp mentioned this in D57939: hmp(4): Interface changes for sched_ule(4) integration.Jun 29 2026, 11:51 AM

koinec_yahoo.co.jp mentioned this in D57940: intelhfi - Intel TD/HFI driver - Part4b: Modifications due to hmp(4) interface change.Jun 29 2026, 12:02 PM

koinec_yahoo.co.jp added a child revision: D57940: intelhfi - Intel TD/HFI driver - Part4b: Modifications due to hmp(4) interface change.

koinec_yahoo.co.jp mentioned this in D57941: sched_ule(4): Improve of CPU core selection logic using capacity and score in hmp(4) (support for heterogeneous multi-core architectures).Jun 29 2026, 12:15 PM

mchoo added a reviewer: scheduler.Thu, Aug 20, 4:25 PM

mchoo added a subscriber: scheduler.