mbox series

[v3,00/15] lib/string_helpers: get rid of ugly *_escape_mem_ascii()

Message ID 20210504180819.73127-1-andriy.shevchenko@linux.intel.com (mailing list archive)
Headers show
Series lib/string_helpers: get rid of ugly *_escape_mem_ascii() | expand

Message

Andy Shevchenko May 4, 2021, 6:08 p.m. UTC
Get rid of ugly *_escape_mem_ascii() API since it's not flexible and
has the only single user. Provide better approach based on usage of the
string_escape_mem() with appropriate flags.

Test cases has been expanded accordingly to cover new functionality.

This is assumed to go either thru VFS or Andrew's tree. I don't expect
too many changes in string_helpers.

Changelog v3:
- dropped moving seq_escape() to the header due to a lot of complaints from
  the (very) old code
- added seq_escape_str() inliner
- converted seq_escape() to use seq_escape_str() instead of seq_escape_mem()

Changelog v2:
- introduced seq_escape_mem() instead of poking seq_get_buf() (Al)
- to keep balance of seq_get_buf() usage, convert seq_escape() to use above
- added missed ESCAPE_APPEND flag in NFSv4 patch
- moved indentation patch closer to the beginning of the series
- reshuffled series to be in two groups: generic library extension
  followed by seq_file updates

Andy Shevchenko (15):
  lib/string_helpers: Switch to use BIT() macro
  lib/string_helpers: Move ESCAPE_NP check inside 'else' branch in a
    loop
  lib/string_helpers: Drop indentation level in string_escape_mem()
  lib/string_helpers: Introduce ESCAPE_NA for escaping non-ASCII
  lib/string_helpers: Introduce ESCAPE_NAP to escape non-ASCII and
    non-printable
  lib/string_helpers: Allow to append additional characters to be
    escaped
  lib/test-string_helpers: Print flags in hexadecimal format
  lib/test-string_helpers: Get rid of trailing comma in terminators
  lib/test-string_helpers: Add test cases for new features
  MAINTAINERS: Add myself as designated reviewer for generic string
    library
  seq_file: Introduce seq_escape_mem()
  seq_file: Add seq_escape_str() as replica of string_escape_str()
  seq_file: Convert seq_escape() to use seq_escape_str()
  nfsd: Avoid non-flexible API in seq_quote_mem()
  seq_file: Drop unused *_escape_mem_ascii()

 MAINTAINERS                    |   8 ++
 fs/nfsd/nfs4state.c            |   2 +-
 fs/seq_file.c                  |  43 +++++----
 include/linux/seq_file.h       |  10 ++-
 include/linux/string_helpers.h |  31 ++++---
 lib/string_helpers.c           | 102 ++++++++++++---------
 lib/test-string_helpers.c      | 157 +++++++++++++++++++++++++++++----
 7 files changed, 264 insertions(+), 89 deletions(-)

Comments

J. Bruce Fields May 11, 2021, 6:57 p.m. UTC | #1
These look good to me, thanks for doing this!

--b.

On Tue, May 04, 2021 at 09:08:04PM +0300, Andy Shevchenko wrote:
> Get rid of ugly *_escape_mem_ascii() API since it's not flexible and
> has the only single user. Provide better approach based on usage of the
> string_escape_mem() with appropriate flags.
> 
> Test cases has been expanded accordingly to cover new functionality.
> 
> This is assumed to go either thru VFS or Andrew's tree. I don't expect
> too many changes in string_helpers.
> 
> Changelog v3:
> - dropped moving seq_escape() to the header due to a lot of complaints from
>   the (very) old code
> - added seq_escape_str() inliner
> - converted seq_escape() to use seq_escape_str() instead of seq_escape_mem()
> 
> Changelog v2:
> - introduced seq_escape_mem() instead of poking seq_get_buf() (Al)
> - to keep balance of seq_get_buf() usage, convert seq_escape() to use above
> - added missed ESCAPE_APPEND flag in NFSv4 patch
> - moved indentation patch closer to the beginning of the series
> - reshuffled series to be in two groups: generic library extension
>   followed by seq_file updates
> 
> Andy Shevchenko (15):
>   lib/string_helpers: Switch to use BIT() macro
>   lib/string_helpers: Move ESCAPE_NP check inside 'else' branch in a
>     loop
>   lib/string_helpers: Drop indentation level in string_escape_mem()
>   lib/string_helpers: Introduce ESCAPE_NA for escaping non-ASCII
>   lib/string_helpers: Introduce ESCAPE_NAP to escape non-ASCII and
>     non-printable
>   lib/string_helpers: Allow to append additional characters to be
>     escaped
>   lib/test-string_helpers: Print flags in hexadecimal format
>   lib/test-string_helpers: Get rid of trailing comma in terminators
>   lib/test-string_helpers: Add test cases for new features
>   MAINTAINERS: Add myself as designated reviewer for generic string
>     library
>   seq_file: Introduce seq_escape_mem()
>   seq_file: Add seq_escape_str() as replica of string_escape_str()
>   seq_file: Convert seq_escape() to use seq_escape_str()
>   nfsd: Avoid non-flexible API in seq_quote_mem()
>   seq_file: Drop unused *_escape_mem_ascii()
> 
>  MAINTAINERS                    |   8 ++
>  fs/nfsd/nfs4state.c            |   2 +-
>  fs/seq_file.c                  |  43 +++++----
>  include/linux/seq_file.h       |  10 ++-
>  include/linux/string_helpers.h |  31 ++++---
>  lib/string_helpers.c           | 102 ++++++++++++---------
>  lib/test-string_helpers.c      | 157 +++++++++++++++++++++++++++++----
>  7 files changed, 264 insertions(+), 89 deletions(-)
> 
> -- 
> 2.30.2