coredirector - Intel TD/HFI driver - Part6: Add coredirector's man file & Makefile.

[koinec_yahoo.co.jp]

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 coredirector'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.

[koinec_yahoo.co.jp]

Attach the full context patch file.

part6_add_coredirector_man4_fbsd15c.patch20 KBDownload

[koinec_yahoo.co.jp]

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

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

[minsoochoo0122_proton.me]

share/man/man4/coredirector.4

34

trivial thing: you can omit "your".

47

ditto

[ziaee]

share/man/man4/coredirector.4

1

Since you wrote this, we updated the preferred license for new files -- https://docs.freebsd.org/en/articles/license-guide/

31

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

We have a standardish section for these

[ziaee]

share/man/man4/coredirector.4

34

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.

[minsoochoo0122_proton.me]

share/man/man4/coredirector.4

34

I didn't know that. Then we can keep this.

[ziaee]

share/man/man4/coredirector.4

34

This inspired me to send a mail to arch@ to see if we can move forward on this.