Page MenuHomeFreeBSD
Differential D44844

ctl: Add CTL_IO_ASSERT wrapper macro
ClosedPublic
Actions

Authored by jhb on Apr 18 2024, 5:45 PM.
Tags
None
Referenced Files
Unknown Object (File)
Thu, Apr 10, 9:16 AM
Unknown Object (File)
Thu, Mar 27, 11:28 AM
Unknown Object (File)
Mar 15 2025, 4:57 AM
Unknown Object (File)
Mar 11 2025, 8:09 AM
Unknown Object (File)
Feb 27 2025, 4:47 AM
Unknown Object (File)
Feb 26 2025, 11:50 PM
Unknown Object (File)
Feb 26 2025, 7:27 PM
Unknown Object (File)
Feb 26 2025, 5:18 AM
View All Files
Subscribers
None

Details

Reviewers
imp
ken
Group Reviewers
cam
Commits
rGac7a514e20f3: ctl: Add CTL_IO_ASSERT wrapper macro
Summary

Currently, this pattern is commonly used to assert that a union ctl_io
is a SCSI request. In the future it will be used to assert other
types.

Suggested by: imp
Sponsored by: Chelsio Communications

Diff Detail

Repository
rG FreeBSD src repository
Lint
Lint Skipped
Unit
Tests Skipped
Build Status
Buildable 57504
Build 54392: arc lint + arc unit

Event Timeline

jhb created this revision.Apr 18 2024, 5:45 PM
Herald added a reviewer: cam. · View Herald TranscriptApr 18 2024, 5:45 PM
jhb requested review of this revision.Apr 18 2024, 5:45 PM
Harbormaster completed remote builds in B57183: Diff 137322.Apr 18 2024, 5:45 PM
jhb added a parent revision: D44716: ctl: Avoid an upcast for calling ctl_scsi_path_string.Apr 18 2024, 5:46 PM
jhb added a child revision: D44845: nvme: Add constants for the Fused Operation (FUSE) field in commands.
jhb added inline comments.Apr 18 2024, 6:11 PM
sys/cam/ctl/ctl_io.h
595

I also added a CTL_IO_ASSERT_NVME(io) that I use later in this series.

However, I still end up with a few places that want to assert the io_type is 2 different types (e.g. NVME or NVME_ADMIN, or NVME or SCSI). I wonder if it makes sense to get a bit fancy and instead add a couple of helper macros that take a VA_ARGS number of types so you can say something like:

CTL_IO_ASSERT_TYPE(SCSI);
CTL_IO_ASSERT_TYPE(NVME);
CTL_IO_ASSERT_TYPE(SCSI, NVME);

Where the last one asserts that the type is either SCSI or NVME. Under the hood there would be a CTL_IO_ASSERT_TYPE_1 and CTL_IO_ASSERT_TYPE_2 and CTL_IO_ASSERT would pick the right backing macro based on the number of arguments passed similar to how CTR maps to CTRn.

imp accepted this revision.Apr 19 2024, 2:10 AM
imp added inline comments.
sys/cam/ctl/ctl_io.h
595

It would be cool if we could...

This revision is now accepted and ready to land.Apr 19 2024, 2:10 AM
jhb retitled this revision from ctl: Add CTL_IO_ASSERT_SCSI wrapper macro to ctl: Add CTL_IO_ASSERT wrapper macro.May 1 2024, 8:27 PM
jhb edited the summary of this revision. (Show Details)
jhb updated this revision to Diff 137968.May 1 2024, 8:28 PM

Rework macro to allow for one or more types as var-args

This revision now requires review to proceed.May 1 2024, 8:28 PM
Harbormaster completed remote builds in B57504: Diff 137968.May 1 2024, 8:28 PM
This revision was not accepted when it landed; it landed in state Needs Review.May 3 2024, 12:16 AM
Closed by commit rGac7a514e20f3: ctl: Add CTL_IO_ASSERT wrapper macro (authored by jhb). · Explain Why
This revision was automatically updated to reflect the committed changes.
jhb added a commit: rGac7a514e20f3: ctl: Add CTL_IO_ASSERT wrapper macro.

Revision Contents
Changeset List

PathSize
sys/
cam/
ctl/
12 lines
3 lines
15 lines
3 lines

Diff 137968

View Options

sys/cam/ctl/ctl.c

Show First 20 Lines • Show All 547 Lines • ▼ Show 20 Lines case XPT_DEV_MATCH: {
inccb->ccb_h.path = xpt_periph->path; inccb->ccb_h.path = xpt_periph->path;
bzero(&mapinfo, sizeof(mapinfo)); bzero(&mapinfo, sizeof(mapinfo));
/* /*
* Map the pattern and match buffers into kernel * Map the pattern and match buffers into kernel
* virtual address space. * virtual address space.
*/ */
error = cam_periph_mapmem(inccb, &mapinfo, MAXPHYS); error = cam_periph_mapmem(inccb, &mapinfo, maxphys);
if (error) { if (error) {
inccb->ccb_h.path = old_path; inccb->ccb_h.path = old_path;
break; break;
} }
/* /*
* This is an immediate CCB, we can send it on directly. * This is an immediate CCB, we can send it on directly.
▲ Show 20 Lines • Show All 5,022 Lines • Show Last 20 Lines
View Options

sys/cam/ctl/ctl_backend_block.c

Show First 20 Lines • Show All 547 Lines • ▼ Show 20 Lines case XPT_DEV_MATCH: {
inccb->ccb_h.path = xpt_periph->path; inccb->ccb_h.path = xpt_periph->path;
bzero(&mapinfo, sizeof(mapinfo)); bzero(&mapinfo, sizeof(mapinfo));
/* /*
* Map the pattern and match buffers into kernel * Map the pattern and match buffers into kernel
* virtual address space. * virtual address space.
*/ */
error = cam_periph_mapmem(inccb, &mapinfo, MAXPHYS); error = cam_periph_mapmem(inccb, &mapinfo, maxphys);
if (error) { if (error) {
inccb->ccb_h.path = old_path; inccb->ccb_h.path = old_path;
break; break;
} }
/* /*
* This is an immediate CCB, we can send it on directly. * This is an immediate CCB, we can send it on directly.
▲ Show 20 Lines • Show All 5,022 Lines • Show Last 20 Lines
View Options

sys/cam/ctl/ctl_io.h

Show First 20 Lines • Show All 547 Lines • ▼ Show 20 Lines case XPT_DEV_MATCH: {
inccb->ccb_h.path = xpt_periph->path; inccb->ccb_h.path = xpt_periph->path;
bzero(&mapinfo, sizeof(mapinfo)); bzero(&mapinfo, sizeof(mapinfo));
/* /*
* Map the pattern and match buffers into kernel * Map the pattern and match buffers into kernel
* virtual address space. * virtual address space.
*/ */
error = cam_periph_mapmem(inccb, &mapinfo, MAXPHYS); error = cam_periph_mapmem(inccb, &mapinfo, maxphys);
if (error) { if (error) {
inccb->ccb_h.path = old_path; inccb->ccb_h.path = old_path;
break; break;
} }
/* /*
* This is an immediate CCB, we can send it on directly. * This is an immediate CCB, we can send it on directly.
▲ Show 20 Lines • Show All 5,022 Lines • Show Last 20 Lines
View Options

sys/cam/ctl/scsi_ctl.c

Show First 20 Lines • Show All 547 Lines • ▼ Show 20 Lines case XPT_DEV_MATCH: {
inccb->ccb_h.path = xpt_periph->path; inccb->ccb_h.path = xpt_periph->path;
bzero(&mapinfo, sizeof(mapinfo)); bzero(&mapinfo, sizeof(mapinfo));
/* /*
* Map the pattern and match buffers into kernel * Map the pattern and match buffers into kernel
* virtual address space. * virtual address space.
*/ */
error = cam_periph_mapmem(inccb, &mapinfo, MAXPHYS); error = cam_periph_mapmem(inccb, &mapinfo, maxphys);
if (error) { if (error) {
inccb->ccb_h.path = old_path; inccb->ccb_h.path = old_path;
break; break;
} }
/* /*
* This is an immediate CCB, we can send it on directly. * This is an immediate CCB, we can send it on directly.
▲ Show 20 Lines • Show All 5,022 Lines • Show Last 20 Lines