Linux CIFS filesystem development
 help / color / mirror / Atom feed
From: Enzo Matsumiya <ematsumiya@suse.de>
To: Steve French <smfrench@gmail.com>
Cc: linux-cifs@vger.kernel.org, pc@cjr.nz, ronniesahlberg@gmail.com,
	nspmangalore@gmail.com
Subject: Re: [RFC PATCH v2 07/10] cifs: rename cifsFYI to debug_level
Date: Wed, 27 Jul 2022 12:21:52 -0300	[thread overview]
Message-ID: <20220727152152.ogsac4tiluemqts6@cyberdelia> (raw)
In-Reply-To: <CAH2r5mu9cDykWcyZ_2SYiST7JQVyeaF-75zX_7QoHfDM46LNnQ@mail.gmail.com>

On 07/27, Steve French wrote:
>cifsFYI is user facing so changing from camel case is probably a bad
>idea for the name of the existing proc entry (internal changes in c
>code from camel case may be ok, though lower priority)

I understand and agree.
This is part of my branch where the module was renamed "smbfs" and I
took the chance to remove "cifs" naming from user-facing stuff.

Will we still keep it "cifsFYI" when SMB1 gets isolated? What about
module renaming?

>On Mon, Jul 25, 2022 at 5:37 PM Enzo Matsumiya <ematsumiya@suse.de> wrote:
>>
>> Rename "cifsFYI" to "debug_level" to add more meaning to it.
>>
>> Signed-off-by: Enzo Matsumiya <ematsumiya@suse.de>
>> ---
>>  fs/cifs/Kconfig        |  2 +-
>>  fs/cifs/cifs_debug.c   | 26 +++++++++++++-------------
>>  fs/cifs/cifs_debug.h   | 19 +++++++++----------
>>  fs/cifs/cifs_spnego.c  |  2 +-
>>  fs/cifs/cifsfs.c       |  4 ++--
>>  fs/cifs/netmisc.c      |  2 +-
>>  fs/cifs/smb2maperror.c |  2 +-
>>  fs/cifs/smb2misc.c     |  2 +-
>>  fs/cifs/transport.c    |  2 +-
>>  9 files changed, 30 insertions(+), 31 deletions(-)
>>
>> diff --git a/fs/cifs/Kconfig b/fs/cifs/Kconfig
>> index 3b7e3b9e4fd2..5b3a6dbc6eda 100644
>> --- a/fs/cifs/Kconfig
>> +++ b/fs/cifs/Kconfig
>> @@ -61,7 +61,7 @@ config CIFS_STATS2
>>           Enabling this option will allow more detailed statistics on SMB
>>           request timing to be displayed in /proc/fs/cifs/DebugData and also
>>           allow optional logging of slow responses to dmesg (depending on the
>> -         value of /proc/fs/cifs/cifsFYI). See Documentation/admin-guide/cifs/usage.rst
>> +         value of /proc/fs/cifs/debug_level). See Documentation/admin-guide/cifs/usage.rst
>>           for more details. These additional statistics may have a minor effect
>>           on performance and memory utilization.
>>
>> diff --git a/fs/cifs/cifs_debug.c b/fs/cifs/cifs_debug.c
>> index c88bea9d3ac3..0c08166f8f30 100644
>> --- a/fs/cifs/cifs_debug.c
>> +++ b/fs/cifs/cifs_debug.c
>> @@ -670,7 +670,7 @@ PROC_FILE_DEFINE(smbd_receive_credit_max);
>>  #endif
>>
>>  static struct proc_dir_entry *proc_fs_cifs;
>> -static const struct proc_ops cifsFYI_proc_ops;
>> +static const struct proc_ops debug_level_proc_ops;
>>  static const struct proc_ops cifs_lookup_cache_proc_ops;
>>  static const struct proc_ops traceSMB_proc_ops;
>>  static const struct proc_ops cifs_security_flags_proc_ops;
>> @@ -691,7 +691,7 @@ cifs_proc_init(void)
>>                         cifs_debug_files_proc_show);
>>
>>         proc_create("Stats", 0644, proc_fs_cifs, &cifs_stats_proc_ops);
>> -       proc_create("cifsFYI", 0644, proc_fs_cifs, &cifsFYI_proc_ops);
>> +       proc_create("debug_level", 0644, proc_fs_cifs, &debug_level_proc_ops);
>>         proc_create("traceSMB", 0644, proc_fs_cifs, &traceSMB_proc_ops);
>>         proc_create("LinuxExtensionsEnabled", 0644, proc_fs_cifs,
>>                     &cifs_linux_ext_proc_ops);
>> @@ -734,7 +734,7 @@ cifs_proc_clean(void)
>>
>>         remove_proc_entry("DebugData", proc_fs_cifs);
>>         remove_proc_entry("open_files", proc_fs_cifs);
>> -       remove_proc_entry("cifsFYI", proc_fs_cifs);
>> +       remove_proc_entry("debug_level", proc_fs_cifs);
>>         remove_proc_entry("traceSMB", proc_fs_cifs);
>>         remove_proc_entry("Stats", proc_fs_cifs);
>>         remove_proc_entry("SecurityFlags", proc_fs_cifs);
>> @@ -758,18 +758,18 @@ cifs_proc_clean(void)
>>         remove_proc_entry("fs/cifs", NULL);
>>  }
>>
>> -static int cifsFYI_proc_show(struct seq_file *m, void *v)
>> +static int debug_level_proc_show(struct seq_file *m, void *v)
>>  {
>> -       seq_printf(m, "%d\n", cifsFYI);
>> +       seq_printf(m, "%d\n", debug_level);
>>         return 0;
>>  }
>>
>> -static int cifsFYI_proc_open(struct inode *inode, struct file *file)
>> +static int debug_level_proc_open(struct inode *inode, struct file *file)
>>  {
>> -       return single_open(file, cifsFYI_proc_show, NULL);
>> +       return single_open(file, debug_level_proc_show, NULL);
>>  }
>>
>> -static ssize_t cifsFYI_proc_write(struct file *file, const char __user *buffer,
>> +static ssize_t debug_level_proc_write(struct file *file, const char __user *buffer,
>>                 size_t count, loff_t *ppos)
>>  {
>>         char c[2] = { '\0' };
>> @@ -780,21 +780,21 @@ static ssize_t cifsFYI_proc_write(struct file *file, const char __user *buffer,
>>         if (rc)
>>                 return rc;
>>         if (strtobool(c, &bv) == 0)
>> -               cifsFYI = bv;
>> +               debug_level = bv;
>>         else if ((c[0] > '1') && (c[0] <= '9'))
>> -               cifsFYI = (int) (c[0] - '0'); /* see cifs_debug.h for meanings */
>> +               debug_level = (int) (c[0] - '0'); /* see cifs_debug.h for meanings */
>>         else
>>                 return -EINVAL;
>>
>>         return count;
>>  }
>>
>> -static const struct proc_ops cifsFYI_proc_ops = {
>> -       .proc_open      = cifsFYI_proc_open,
>> +static const struct proc_ops debug_level_proc_ops = {
>> +       .proc_open      = debug_level_proc_open,
>>         .proc_read      = seq_read,
>>         .proc_lseek     = seq_lseek,
>>         .proc_release   = single_release,
>> -       .proc_write     = cifsFYI_proc_write,
>> +       .proc_write     = debug_level_proc_write,
>>  };
>>
>>  static int cifs_linux_ext_proc_show(struct seq_file *m, void *v)
>> diff --git a/fs/cifs/cifs_debug.h b/fs/cifs/cifs_debug.h
>> index 2ac0e384fd12..3e5f9a68c62d 100644
>> --- a/fs/cifs/cifs_debug.h
>> +++ b/fs/cifs/cifs_debug.h
>> @@ -5,13 +5,10 @@
>>   *   Modified by Steve French (sfrench@us.ibm.com)
>>   */
>>
>> -#ifndef _H_CIFS_DEBUG
>> -#define _H_CIFS_DEBUG
>> +#ifndef _CIFS_DEBUG_H
>> +#define _CIFS_DEBUG_H
>>
>> -#ifdef pr_fmt
>>  #undef pr_fmt
>> -#endif
>> -
>>  #define pr_fmt(fmt) "CIFS: " fmt
>>
>>  void cifs_dump_mem(char *, void *, int );
>> @@ -19,13 +16,15 @@ void cifs_dump_detail(void *, struct cifs_server_info *);
>>  void cifs_dump_mids(struct cifs_server_info *);
>>  extern bool traceSMB;          /* flag which enables the function below */
>>  void dump_smb(void *, int);
>> +
>>  #define CIFS_INFO      0x01
>>  #define CIFS_RC                0x02
>>  #define CIFS_TIMER     0x04
>>
>>  #define VFS 1
>>  #define FYI 2
>> -extern int cifsFYI;
>> +extern int debug_level;
>> +
>>  #ifdef CONFIG_CIFS_DEBUG2
>>  #define NOISY 4
>>  #else
>> @@ -61,7 +60,7 @@ extern int cifsFYI;
>>  /* information message: e.g., configuration, major event */
>>  #define cifs_dbg_func(ratefunc, type, fmt, ...)                                \
>>  do {                                                                   \
>> -       if ((type) & FYI && cifsFYI & CIFS_INFO) {                      \
>> +       if ((type) & FYI && debug_level & CIFS_INFO) {                  \
>>                 pr_debug_ ## ratefunc("%s: " fmt,                       \
>>                                       __FILE__, ##__VA_ARGS__);         \
>>         } else if ((type) & VFS) {                                      \
>> @@ -84,7 +83,7 @@ do {                                                                  \
>>         const char *sn = "";                                            \
>>         if (server && server->hostname)                                 \
>>                 sn = server->hostname;                                  \
>> -       if ((type) & FYI && cifsFYI & CIFS_INFO) {                      \
>> +       if ((type) & FYI && debug_level & CIFS_INFO) {                  \
>>                 pr_debug_ ## ratefunc("%s: \\\\%s " fmt,                \
>>                                       __FILE__, sn, ##__VA_ARGS__);     \
>>         } else if ((type) & VFS) {                                      \
>> @@ -110,7 +109,7 @@ do {                                                                        \
>>         const char *tn = "";                                            \
>>         if (tcon && tcon->treeName)                                     \
>>                 tn = tcon->treeName;                                    \
>> -       if ((type) & FYI && cifsFYI & CIFS_INFO) {                      \
>> +       if ((type) & FYI && debug_level & CIFS_INFO) {                  \
>>                 pr_debug_ ## ratefunc("%s: %s " fmt,                    \
>>                                       __FILE__, tn, ##__VA_ARGS__);     \
>>         } else if ((type) & VFS) {                                      \
>> @@ -157,4 +156,4 @@ do {                                                                        \
>>         pr_info(fmt, ##__VA_ARGS__)
>>  #endif
>>
>> -#endif                         /* _H_CIFS_DEBUG */
>> +#endif /* _CIFS_DEBUG_H */
>> diff --git a/fs/cifs/cifs_spnego.c b/fs/cifs/cifs_spnego.c
>> index 60f551deb443..46a50aceb23d 100644
>> --- a/fs/cifs/cifs_spnego.c
>> +++ b/fs/cifs/cifs_spnego.c
>> @@ -162,7 +162,7 @@ cifs_get_spnego_key(struct cifs_ses *sesInfo,
>>         revert_creds(saved_cred);
>>
>>  #ifdef CONFIG_CIFS_DEBUG2
>> -       if (cifsFYI && !IS_ERR(spnego_key)) {
>> +       if (debug_level && !IS_ERR(spnego_key)) {
>>                 struct cifs_spnego_msg *msg = spnego_key->payload.data[0];
>>                 cifs_dump_mem("SPNEGO reply blob:", msg->data, min(1024U,
>>                                 msg->secblob_len + msg->sesskey_len));
>> diff --git a/fs/cifs/cifsfs.c b/fs/cifs/cifsfs.c
>> index 59e2966b3594..8017198c4a35 100644
>> --- a/fs/cifs/cifsfs.c
>> +++ b/fs/cifs/cifsfs.c
>> @@ -56,7 +56,7 @@
>>  #define SMB_DATE_MIN (0<<9 | 1<<5 | 1)
>>  #define SMB_TIME_MAX (23<<11 | 59<<5 | 29)
>>
>> -int cifsFYI = 0;
>> +int debug_level = 0;
>>  bool traceSMB;
>>  bool enable_oplocks = true;
>>  bool linuxExtEnabled = true;
>> @@ -856,7 +856,7 @@ cifs_smb3_do_mount(struct file_system_type *fs_type,
>>          * Prints in Kernel / CIFS log the attempted mount operation
>>          *      If CIFS_DEBUG && cifs_FYI
>>          */
>> -       if (cifsFYI)
>> +       if (debug_level)
>>                 cifs_dbg(FYI, "Devname: %s flags: %d\n", old_ctx->UNC, flags);
>>         else
>>                 cifs_info("Attempting to mount %s\n", old_ctx->UNC);
>> diff --git a/fs/cifs/netmisc.c b/fs/cifs/netmisc.c
>> index 0efd58db351e..33beaf148223 100644
>> --- a/fs/cifs/netmisc.c
>> +++ b/fs/cifs/netmisc.c
>> @@ -827,7 +827,7 @@ map_smb_to_linux_error(char *buf, bool logErr)
>>                 __u32 err = le32_to_cpu(smb->Status.CifsError);
>>                 if (logErr && (err != (NT_STATUS_MORE_PROCESSING_REQUIRED)))
>>                         cifs_print_status(err);
>> -               else if (cifsFYI & CIFS_RC)
>> +               else if (debug_level & CIFS_RC)
>>                         cifs_print_status(err);
>>                 ntstatus_to_dos(err, &smberrclass, &smberrcode);
>>         } else {
>> diff --git a/fs/cifs/smb2maperror.c b/fs/cifs/smb2maperror.c
>> index 194799ddd382..1b0eae9c367b 100644
>> --- a/fs/cifs/smb2maperror.c
>> +++ b/fs/cifs/smb2maperror.c
>> @@ -2456,7 +2456,7 @@ map_smb2_to_linux_error(char *buf, bool log_err)
>>         if (log_err && (smb2err != STATUS_MORE_PROCESSING_REQUIRED) &&
>>             (smb2err != STATUS_END_OF_FILE))
>>                 smb2_print_status(smb2err);
>> -       else if (cifsFYI & CIFS_RC)
>> +       else if (debug_level & CIFS_RC)
>>                 smb2_print_status(smb2err);
>>
>>         for (i = 0; i < sizeof(smb2_error_map_table) /
>> diff --git a/fs/cifs/smb2misc.c b/fs/cifs/smb2misc.c
>> index dbaee6343fdc..587362124842 100644
>> --- a/fs/cifs/smb2misc.c
>> +++ b/fs/cifs/smb2misc.c
>> @@ -260,7 +260,7 @@ smb2_check_message(char *buf, unsigned int len, struct cifs_server_info *server)
>>                         return 0;
>>
>>                 /* Only log a message if len was really miscalculated */
>> -               if (unlikely(cifsFYI))
>> +               if (unlikely(debug_level))
>>                         cifs_dbg(FYI, "Server response too short: calculated "
>>                                  "length %u doesn't match read length %u (cmd=%d, mid=%llu)\n",
>>                                  calc_len, len, command, mid);
>> diff --git a/fs/cifs/transport.c b/fs/cifs/transport.c
>> index 81022ef20d62..98a40615c871 100644
>> --- a/fs/cifs/transport.c
>> +++ b/fs/cifs/transport.c
>> @@ -137,7 +137,7 @@ static void _cifs_mid_q_entry_release(struct kref *refcount)
>>
>>                 trace_smb3_slow_rsp(smb_cmd, midEntry->mid, midEntry->pid,
>>                                midEntry->when_sent, midEntry->when_received);
>> -               if (cifsFYI & CIFS_TIMER) {
>> +               if (debug_level & CIFS_TIMER) {
>>                         pr_debug("slow rsp: cmd %d mid %llu",
>>                                  midEntry->command, midEntry->mid);
>>                         cifs_info("A: 0x%lx S: 0x%lx R: 0x%lx\n",
>> --
>> 2.35.3
>>
>
>
>-- 
>Thanks,
>
>Steve

  reply	other threads:[~2022-07-27 15:21 UTC|newest]

Thread overview: 20+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-07-25 22:36 [RFC PATCH v2 00/10] cifs: rename of several structs and variables Enzo Matsumiya
2022-07-25 22:36 ` [RFC PATCH v2 01/10] cifs: rename xid/mid globals Enzo Matsumiya
2022-07-25 22:36 ` [RFC PATCH v2 02/10] cifs: rename global counters Enzo Matsumiya
2022-07-25 22:37 ` [RFC PATCH v2 05/10] cifs: convert server info vars to snake_case Enzo Matsumiya
2022-07-27 14:32   ` Steve French
2022-07-27 15:17     ` Enzo Matsumiya
2022-07-27 15:29       ` Steve French
2022-07-27 15:35         ` Enzo Matsumiya
2022-07-25 22:37 ` [RFC PATCH v2 06/10] cifs: change status and security types enums to constants Enzo Matsumiya
2022-07-27 14:35   ` Steve French
2022-07-27 15:20     ` Enzo Matsumiya
2022-07-25 22:37 ` [RFC PATCH v2 07/10] cifs: rename cifsFYI to debug_level Enzo Matsumiya
2022-07-27 14:36   ` Steve French
2022-07-27 15:21     ` Enzo Matsumiya [this message]
2022-07-25 22:37 ` [RFC PATCH v2 08/10] cifs: rename list_head fields Enzo Matsumiya
2022-07-25 22:37 ` [RFC PATCH v2 10/10] cifs: rename more list_heads, remove redundant prefixes Enzo Matsumiya
2022-07-26  2:23 ` [RFC PATCH v2 00/10] cifs: rename of several structs and variables Tom Talpey
2022-07-26  2:41   ` Enzo Matsumiya
2022-07-29 19:12     ` Tom Talpey
     [not found] ` <20220725223707.14477-4-ematsumiya@suse.de>
     [not found]   ` <CAH2r5msHgxzC6HYhj70cMce+=t6Fz2p1C5X3HCM1WKFEq7rnhQ@mail.gmail.com>
     [not found]     ` <20220727153836.sllbblfagnstcza7@cyberdelia>
2022-07-27 19:24       ` Fwd: [RFC PATCH v2 03/10] cifs: rename "TCP_Server_Info" struct to "cifs_server_info" Enzo Matsumiya

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20220727152152.ogsac4tiluemqts6@cyberdelia \
    --to=ematsumiya@suse.de \
    --cc=linux-cifs@vger.kernel.org \
    --cc=nspmangalore@gmail.com \
    --cc=pc@cjr.nz \
    --cc=ronniesahlberg@gmail.com \
    --cc=smfrench@gmail.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox