Skip to contentSkip to conversation

Prepare for removing /proc/scsi from the Linux kernel

PATCH In review Bart Van Assche 2 participants 5 messages Aug 10, 2022 – Aug 12, 2022 SCSI

lore
Share & tools
lore
#0 lore raw

cover Prepare for removing /proc/scsi from the Linux kernel

Hi Doug,

The sg3_utils package is the only /proc/scsi user I know of. Although support for systems without /proc/scsi was added to rescan_scsi_bus.sh more than ten years ago, a few references to /proc/scsi remain. Convert these references into the recommended interfaces.

Please consider these patches for inclusion in the sg3_utils package.

Thanks,

Bart.

Bart Van Assche (3):
Change /proc/scsi/sg/allow_dio into
/sys/module/sg/parameters/allow_dio
Replace the references to /proc/scsi/sg/debug
Refer to sg_map instead of /proc/scsi/scsi

 ChangeLog             |  2 +-
 doc/sg_dd.8           |  9 ++++-----
 doc/sg_map.8          |  2 +-
 doc/sg_read.8         |  4 ++--
 doc/sgp_dd.8          |  6 +++---
 examples/sgq_dd.c     |  6 +++---
 src/sg_dd.c           |  6 +++---
 src/sg_read.c         |  6 +++---
 src/sgm_dd.c          |  6 +++---
 src/sgp_dd.c          |  6 +++---
 testing/sg_mrq_dd.cpp | 18 +++++++++---------
 testing/sg_tst_bidi.c |  2 +-
 testing/sgh_dd.cpp    | 18 +++++++++---------
 testing/uapi_sg.h     |  4 ++--
 14 files changed, 47 insertions(+), 48 deletions(-)
#1 lore raw

PATCH 1/3 Change /proc/scsi/sg/allow_dio into /sys/module/sg/parameters/allow_dio

Prepare for the removal of /proc/scsi from the Linux kernel by removing the references to /proc/scsi.

---
 ChangeLog             | 2 +-
 doc/sg_dd.8           | 6 +++---
 doc/sg_read.8         | 4 ++--
 doc/sgp_dd.8          | 4 ++--
 examples/sgq_dd.c     | 6 +++---
 src/sg_dd.c           | 6 +++---
 src/sg_read.c         | 6 +++---
 src/sgm_dd.c          | 6 +++---
 src/sgp_dd.c          | 6 +++---
 testing/sg_mrq_dd.cpp | 6 +++---
 testing/sg_tst_bidi.c | 2 +-
 testing/sgh_dd.cpp    | 6 +++---
 12 files changed, 30 insertions(+), 30 deletions(-)
ChangeLog +1 -1
index 587a7844f631..54a778a653e4 100644
@@ -1811,7 +1811,7 @@ Changelog for sg3_utils-0.96 [20011221]
 Changelog for sg3_utils-0.95 [20010915]
 ----------------------------
   - make sg_dd, sgp_dd and archive/sgq_dd warn if dio selected but
-    /proc/scsi/sg/allow_dio is '0'
+    /sys/module/sg/parameters/allow_dio is '0'
   - sg_map can now do any INQUIRY (when '-i' argument given)
   - expand example in scsi_inquiry
 
doc/sg_dd.8 +3 -3
index 14290e0740e8..3268de32e738 100644
@@ -139,7 +139,7 @@ issued and no copy takes place.
 \fBdio\fR={0|1}
 default is 0 which selects indirect (buffered) IO on sg devices. Value of 1
 attempts direct IO which, if not available, falls back to indirect IO and
-notes this at completion. If direct IO is selected and /proc/scsi/sg/allow_dio
+notes this at completion. If direct IO is selected and /sys/module/sg/parameters/allow_dio
 has the value of 0 then a warning is issued (and indirect IO is performed).
 For finer grain control use 'iflag=dio' or 'oflag=dio'.
 .TP
@@ -333,7 +333,7 @@ utility. See note about READ LONG below.
 dio
 request the sg device node associated with this flag does direct IO. If direct
 IO is not available, falls back to indirect IO and notes this at completion.
-If direct IO is selected and /proc/scsi/sg/allow_dio has the value of 0 then a
+If direct IO is selected and /sys/module/sg/parameters/allow_dio has the value of 0 then a
 warning is issued (and indirect IO is performed).
 .TP
 direct
@@ -470,7 +470,7 @@ This is called "indirect IO" and there is a 'dio' option to
 select "direct IO" which will DMA directly into user memory. Due to some
 issues "direct IO" is disabled in the sg driver and needs a
 configuration change to activate it. This is typically done
-with 'echo 1 > /proc/scsi/sg/allow_dio'.
+with 'echo 1 > /sys/module/sg/parameters/allow_dio'.
 .PP
 All informative, warning and error output is sent to stderr so that
 dd's output file can be stdout and remain unpolluted. If no options
doc/sg_read.8 +2 -2
index c12dd57f087f..3f370a62f42d 100644
@@ -71,7 +71,7 @@ to be transferred. This option is mandatory.
 default is 0 which selects indirect IO. Value of 1 attempts direct
 IO which, if not available, falls back to indirect IO and notes this
 at completion. This option is only active if \fIIFILE\fR is an sg device.
-If direct IO is selected and /proc/scsi/sg/allow_dio
+If direct IO is selected and /sys/module/sg/parameters/allow_dio
 has the value of 0 then a warning is issued (and indirect IO is performed)
 .TP
 \fBdpo\fR=0 | 1
@@ -140,7 +140,7 @@ This is called "indirect IO" and there is a "dio" option to select
 "direct IO" which will DMA directly into user memory. Due to some
 issues "direct IO" is disabled in the sg driver and needs a
 configuration change to activate it. This is typically done with
-"echo 1 > /proc/scsi/sg/allow_dio". An alternate way to avoid the
+"echo 1 > /sys/module/sg/parameters/allow_dio". An alternate way to avoid the
 2 stage copy is to select memory mapped IO with 'mmap=1'.
 .SH SIGNALS
 The signal handling has been borrowed from dd: SIGINT, SIGQUIT and
doc/sgp_dd.8 +2 -2
index 7f6115da5bb4..99afcf30f085 100644
@@ -77,7 +77,7 @@ of debug (max debug output when \fIVERB\fR is 9).
 \fBdio\fR=0 | 1
 default is 0 which selects indirect IO. Value of 1 attempts direct
 IO which, if not available, falls back to indirect IO and notes this
-at completion. If direct IO is selected and /proc/scsi/sg/allow_dio
+at completion. If direct IO is selected and /sys/module/sg/parameters/allow_dio
 has the value of 0 then a warning is issued (and indirect IO is performed)
 For finer grain control use 'iflag=dio' or 'oflag=dio'.
 .TP
@@ -184,7 +184,7 @@ reported to stderr and the copy continues (as if nothing went wrong).
 dio
 request the sg device node associated with this flag does direct IO.
 If direct IO is not available, falls back to indirect IO and notes
-this at completion. If direct IO is selected and /proc/scsi/sg/allow_dio
+this at completion. If direct IO is selected and /sys/module/sg/parameters/allow_dio
 has the value of 0 then a warning is issued (and indirect IO is performed).
 .TP
 direct
examples/sgq_dd.c +3 -3
index 2f163ef16ee9..66c52efe25d9 100644
@@ -148,7 +148,7 @@ static struct pollfd in_pollfd_arr[MAX_NUM_THREADS];
 static struct pollfd out_pollfd_arr[MAX_NUM_THREADS];
 static int dd_count = -1;
 
-static const char * proc_allow_dio = "/proc/scsi/sg/allow_dio";
+static const char * sg_allow_dio = "/sys/module/sg/parameters/allow_dio";
 
 static int sg_finish_io(int wr, Rq_elem * rep);
 
@@ -1214,11 +1214,11 @@ main(int argc, char * argv[])
 
         fprintf(stderr, ">> Direct IO requested but incomplete %d times\n",
                 rcoll.dio_incomplete);
-        if ((fd = open(proc_allow_dio, O_RDONLY)) >= 0) {
+        if ((fd = open(sg_allow_dio, O_RDONLY)) >= 0) {
             if (1 == read(fd, &c, 1)) {
                 if ('0' == c)
                     fprintf(stderr, ">>> %s set to '0' but should be set "
-                            "to '1' for direct IO\n", proc_allow_dio);
+                            "to '1' for direct IO\n", sg_allow_dio);
             }
             close(fd);
         }
src/sg_dd.c +3 -3
index 10ede6fd01da..cba519dc39d4 100644
@@ -182,7 +182,7 @@ static long seed;
 static struct drand48_data drand;/* opaque, used by srand48_r and mrand48_r */
 #endif
 
-static const char * proc_allow_dio = "/proc/scsi/sg/allow_dio";
+static const char * sg_allow_dio = "/sys/module/sg/parameters/allow_dio";
 
 struct flags_t {
     bool append;
@@ -2733,11 +2733,11 @@ bypass_copy:
 
         pr2serr(">> Direct IO requested but incomplete %d times\n",
                 dio_incomplete_count);
-        if ((fd = open(proc_allow_dio, O_RDONLY)) >= 0) {
+        if ((fd = open(sg_allow_dio, O_RDONLY)) >= 0) {
             if (1 == read(fd, &c, 1)) {
                 if ('0' == c)
                     pr2serr(">>> %s set to '0' but should be set to '1' for "
-                            "direct IO\n", proc_allow_dio);
+                            "direct IO\n", sg_allow_dio);
             }
             close(fd);
         }
src/sg_read.c +3 -3
index a4f7ceec7a11..0538472f9023 100644
@@ -98,7 +98,7 @@ static int in_partial = 0;
 static int pack_id_count = 0;
 static int verbose = 0;
 
-static const char * proc_allow_dio = "/proc/scsi/sg/allow_dio";
+static const char * sg_allow_dio = "/sys/module/sg/parameters/allow_dio";
 
 
 static void
@@ -916,11 +916,11 @@ main(int argc, char * argv[])
 
         pr2serr(">> Direct IO requested but incomplete %d times\n",
                 dio_incomplete);
-        if ((fd = open(proc_allow_dio, O_RDONLY)) >= 0) {
+        if ((fd = open(sg_allow_dio, O_RDONLY)) >= 0) {
             if (1 == read(fd, &c, 1)) {
                 if ('0' == c)
                     pr2serr(">>> %s set to '0' but should be set to '1' for "
-                            "direct IO\n", proc_allow_dio);
+                            "direct IO\n", sg_allow_dio);
             }
             close(fd);
         }
src/sgm_dd.c +3 -3
index aa656b390f6a..57ca1e17cae8 100644
@@ -126,7 +126,7 @@ static struct timeval start_tm;
 static int blk_sz = 0;
 static uint32_t glob_pack_id = 0;       /* pre-increment */
 
-static const char * proc_allow_dio = "/proc/scsi/sg/allow_dio";
+static const char * sg_allow_dio = "/sys/module/sg/parameters/allow_dio";
 
 struct flags_t {
     bool append;
@@ -1286,11 +1286,11 @@ main(int argc, char * argv[])
         int fd;
         char c;
 
-        if ((fd = open(proc_allow_dio, O_RDONLY)) >= 0) {
+        if ((fd = open(sg_allow_dio, O_RDONLY)) >= 0) {
             if (1 == read(fd, &c, 1)) {
                 if ('0' == c)
                     pr2serr(">>> %s set to '0' but should be set to '1' for "
-                            "direct IO\n", proc_allow_dio);
+                            "direct IO\n", sg_allow_dio);
             }
             close(fd);
         }
src/sgp_dd.c +3 -3
index a36d9d03a96d..7f69406beec4 100644
@@ -214,7 +214,7 @@ typedef struct request_element
 static sigset_t signal_set;
 static pthread_t sig_listen_thread_id;
 
-static const char * proc_allow_dio = "/proc/scsi/sg/allow_dio";
+static const char * sg_allow_dio = "/sys/module/sg/parameters/allow_dio";
 
 static void sg_in_operation(struct opts_t * clp, Rq_elem * rep);
 static void sg_out_operation(struct opts_t * clp, Rq_elem * rep,
@@ -1991,11 +1991,11 @@ fini:
 
         pr2serr(">> Direct IO requested but incomplete %d times\n",
                 clp->dio_incomplete_count);
-        if ((fd = open(proc_allow_dio, O_RDONLY)) >= 0) {
+        if ((fd = open(sg_allow_dio, O_RDONLY)) >= 0) {
             if (1 == read(fd, &c, 1)) {
                 if ('0' == c)
                     pr2serr(">>> %s set to '0' but should be set to '1' for "
-                            "direct IO\n", proc_allow_dio);
+                            "direct IO\n", sg_allow_dio);
             }
             close(fd);
         }
testing/sg_mrq_dd.cpp +3 -3
index 9f17146c31c6..dc50ad21b8cf 100644
@@ -396,7 +396,7 @@ static atomic<bool> vb_first_time(true);
 static sigset_t signal_set;
 static sigset_t orig_signal_set;
 
-static const char * proc_allow_dio = "/proc/scsi/sg/allow_dio";
+static const char * sg_allow_dio = "/sys/module/sg/parameters/allow_dio";
 
 static int do_both_sg_segment(Rq_elem * rep, scat_gath_iter & i_sg_it,
                               scat_gath_iter & o_sg_it, int seg_blks,
@@ -4614,11 +4614,11 @@ fini:
 
         pr2serr(">> Direct IO requested but incomplete %d times\n",
                 clp->dio_incomplete_count.load());
-        if ((fd = open(proc_allow_dio, O_RDONLY)) >= 0) {
+        if ((fd = open(sg_allow_dio, O_RDONLY)) >= 0) {
             if (1 == read(fd, &c, 1)) {
                 if ('0' == c)
                     pr2serr(">>> %s set to '0' but should be set to '1' for "
-                            "direct IO\n", proc_allow_dio);
+                            "direct IO\n", sg_allow_dio);
             }
             close(fd);
         }
testing/sg_tst_bidi.c +1 -1
index 6865e9a9245f..981a64fb9303 100644
@@ -585,7 +585,7 @@ rep_async:
     }
     if (direct_io && (dirio_count < q_len)) {
         pr2serr("Direct IO requested %d times, done %d times\nMaybe need "
-                "'echo 1 > /proc/scsi/sg/allow_dio'\n", q_len, dirio_count);
+                "'echo 1 > /sys/module/sg/parameters/allow_dio'\n", q_len, dirio_count);
     }
     if (rep_count-- > 0)
         goto rep_async;
testing/sgh_dd.cpp +3 -3
index 2c1f24336595..e329f6bc52f7 100644
@@ -387,7 +387,7 @@ static sigset_t signal_set;
 static sigset_t orig_signal_set;
 static pthread_t sig_listen_thread_id;
 
-static const char * proc_allow_dio = "/proc/scsi/sg/allow_dio";
+static const char * sg_allow_dio = "/sys/module/sg/parameters/allow_dio";
 
 static void sg_in_rd_cmd(struct global_collection * clp, Rq_elem * rep,
                          mrq_arr_t & def_arr);
@@ -5040,11 +5040,11 @@ fini:
 
         pr2serr(">> Direct IO requested but incomplete %d times\n",
                 clp->dio_incomplete_count.load());
-        if ((fd = open(proc_allow_dio, O_RDONLY)) >= 0) {
+        if ((fd = open(sg_allow_dio, O_RDONLY)) >= 0) {
             if (1 == read(fd, &c, 1)) {
                 if ('0' == c)
                     pr2serr(">>> %s set to '0' but should be set to '1' for "
-                            "direct IO\n", proc_allow_dio);
+                            "direct IO\n", sg_allow_dio);
             }
             close(fd);
         }
#2 lore raw

PATCH 2/3 Replace the references to /proc/scsi/sg/debug

In reply to Bart Van Assche

Prepare for the removal of /proc/scsi from the Linux kernel by removing the references to /proc/scsi.

---
 testing/sg_mrq_dd.cpp | 12 ++++++------
 testing/sgh_dd.cpp    | 12 ++++++------
 testing/uapi_sg.h     |  4 ++--
 3 files changed, 14 insertions(+), 14 deletions(-)
testing/sg_mrq_dd.cpp +6 -6
index dc50ad21b8cf..40de12316b6d 100644
@@ -632,12 +632,12 @@ page4:
             "each issued\nSCSI command. When both IFILE and OFILE are sg "
             "devices, then the READ in\neach read-write pair is issued an "
             "even pack_id and its WRITE pair is\ngiven the pack_id one "
-            "higher (i.e. an odd number). This enables a\n'cat '"
-            "/proc/scsi/sg/debug' user to see that progress is being "
+            "higher (i.e. an odd number). This enables a\n'dmesg -w' "
+            "user to see that progress is being "
             "made.\n\n");
     pr2serr("Debugging:\n"
             "Apart from using one or more '--verbose' options which gets a "
-            "bit noisy\n'cat /proc/scsi/sg/debug' can give a good overview "
+            "bit noisy\n'dmesg -w' can give a good overview "
             "of what is happening.\nThat does a sg driver object tree "
             "traversal that does minimal locking\nto make sure that each "
             "traversal is 'safe'. So it is important to note\nthe whole "
@@ -650,7 +650,7 @@ page4:
             "request entered it while some other nodes were being "
             "printed.\n\n");
     pr2serr("Busy state:\n"
-            "Busy state (abbreviated to 'bsy' in the /proc/scsi/sg/debug "
+            "Busy state (abbreviated to 'bsy' in the dmesg "
             "output)\nis entered during request setup and completion. It "
             "is intended to be\na temporary state. It should not block "
             "but does sometimes (e.g. in\nblock_get_request()). Even so "
@@ -1255,7 +1255,7 @@ bypass:
     }
     if (clp->verbose) {
         t = 1;
-        /* more info in /proc/scsi/sg/debug */
+        /* more info in the kernel log */
         res = ioctl(fd, SG_SET_DEBUG, &t);
         if (res < 0)
             perror("sg_mrq_dd: SG_SET_DEBUG error");
@@ -1507,7 +1507,7 @@ sig_listen_thread(struct global_collection * clp)
                     } else
                         pr2serr_lk("%s: subsequent stall at pack_id=%d\n",
                                    __func__, pack_id);
-                    system_wrapper("/usr/bin/cat /proc/scsi/sg/debug\n");
+                    system_wrapper("/usr/bin/dmesg\n");
                 } else
                     prev_pack_id = pack_id;
             } else if (EAGAIN != err)
testing/sgh_dd.cpp +6 -6
index e329f6bc52f7..5482b0c39dc8 100644
@@ -660,12 +660,12 @@ page4:
             "each issued\nSCSI command. When both IFILE and OFILE are sg "
             "devices, then the READ in\neach read-write pair is issued an "
             "even pack_id and its WRITE pair is\ngiven the pack_id one "
-            "higher (i.e. an odd number). This enables a\n'cat '"
-            "/proc/scsi/sg/debug' user to see that progress is being "
+            "higher (i.e. an odd number). This enables a\n'dmesg -w' "
+            "user to see that progress is being "
             "made.\n\n");
     pr2serr("Debugging:\n"
             "Apart from using one or more '--verbose' options which gets a "
-            "bit noisy\n'cat /proc/scsi/sg/debug' can give a good overview "
+            "bit noisy\n'dmesg -w' can give a good overview "
             "of what is happening.\nThat does a sg driver object tree "
             "traversal that does minimal locking\nto make sure that each "
             "traversal is 'safe'. So it is important to note\nthe whole "
@@ -678,7 +678,7 @@ page4:
             "request entered it while some other nodes were being "
             "printed.\n\n");
     pr2serr("Busy state:\n"
-            "Busy state (abbreviated to 'bsy' in the /proc/scsi/sg/debug "
+            "Busy state (abbreviated to 'bsy' in the dmesg "
             "output)\nis entered during request setup and completion. It "
             "is intended to be\na temporary state. It should not block "
             "but does sometimes (e.g. in\nblock_get_request()). Even so "
@@ -1258,7 +1258,7 @@ sig_listen_thread(void * v_clp)
                     } else
                         pr2serr_lk("%s: subsequent stall at pack_id=%d\n",
                                __func__, pack_id);
-                    system_wrapper("/usr/bin/cat /proc/scsi/sg/debug\n");
+                    system_wrapper("/usr/bin/dmesg\n");
                 } else
                     prev_pack_id = pack_id;
             } else if (EAGAIN != err)
@@ -3752,7 +3752,7 @@ bypass:
         }
     }
     t = 1;
-    res = ioctl(fd, SG_SET_DEBUG, &t);  /* more info in /proc/scsi/sg/debug */
+    res = ioctl(fd, SG_SET_DEBUG, &t);  /* more info in the kernel log */
     if (res < 0)
         perror("sgs_dd: SG_SET_DEBUG error");
     return (res < 0) ? 0 : num;
testing/uapi_sg.h +2 -2
index 270ad4689ea7..9cc51dc00654 100644
@@ -442,8 +442,8 @@ struct sg_header {
 #define SG_SET_COMMAND_Q 0x2271   /* Change queuing state with 0 or 1 */
 
 /*
- * Turn on/off error sense trace (1 and 0 respectively, default is off).
- * Try using: "# cat /proc/scsi/sg/debug" instead in the v3 driver
+ * Turn on/off error sense trace in the kernel log (1 and 0 respectively, default is
+ * off).
  */
 #define SG_SET_DEBUG 0x227e    /* 0 -> turn off debug */
 
#3 lore raw

PATCH 3/3 Refer to sg_map instead of /proc/scsi/scsi

In reply to Bart Van Assche

Prepare for the removal of /proc/scsi from the Linux kernel by removing the references to /proc/scsi.

---
 doc/sg_dd.8  | 3 +--
 doc/sg_map.8 | 2 +-
 doc/sgp_dd.8 | 2 +-
 3 files changed, 3 insertions(+), 4 deletions(-)
doc/sg_dd.8 +1 -2
index 3268de32e738..fa182022fd49 100644
@@ -484,8 +484,7 @@ A raw device must be bound to a block device prior to using sg_dd.
 See
 .B raw(8)
 for more information about binding raw devices. To be safe, the sg device
-mapping to SCSI block devices should be checked with 'cat /proc/scsi/scsi',
-or sg_map before use.
+mapping to SCSI block devices should be checked with sg_map before use.
 .PP
 Disk partition information can often be found with
 .B fdisk(8)
doc/sg_map.8 +1 -1
index 5cbb4c2a82f0..abe0935d3ae4 100644
@@ -73,7 +73,7 @@ called devfsd whose default configuration adds back the
 Linux device names in their traditional positions.
 .PP
 Quite often the mapping information can be derived by
-observing the output of the command: "cat /proc/scsi/scsi".
+observing the output of the command: "sg_map".
 However if devices have been added since boot this can
 be deceptive.
 .PP
doc/sgp_dd.8 +1 -1
index 99afcf30f085..6e40295e4443 100644
@@ -246,7 +246,7 @@ A raw device must be bound to a block device prior to using sgp_dd.
 See
 .B raw(8)
 for more information about binding raw devices. To be safe, the sg device
-mapping to SCSI block devices should be checked with 'cat /proc/scsi/scsi'
+mapping to SCSI block devices should be checked with 'sg_map'
 before use.
 .PP
 Raw device partition information can often be found with
#4 lore raw
In reply to Bart Van Assche
Quoted 8 lines · Bart Van Assche

Hi Doug,

The sg3_utils package is the only /proc/scsi user I know of. Although support for systems without /proc/scsi was added to rescan_scsi_bus.sh more than ten years ago, a few references to /proc/scsi remain. Convert these references into the recommended interfaces.

Please consider these patches for inclusion in the sg3_utils package.

The three patches in this series have been applied to my upstream subversion repository as revision 968 with a few cosmetic changes. That should now be mirrored at: https://github.com/doug-gilbert/sg3_utils

Thanks
Doug Gilbert