diff mbox

[v4,1/2] mm: add kstrimdup function

Message ID 1391039304-3172-2-git-send-email-sebastian.capella@linaro.org
State New
Headers show

Commit Message

Sebastian Capella Jan. 29, 2014, 11:48 p.m. UTC
kstrimdup will duplicate and trim spaces from the passed in
null terminated string.  This is useful for strings coming from
sysfs that often include trailing whitespace due to user input.

Signed-off-by: Sebastian Capella <sebastian.capella@linaro.org>
Cc: Andrew Morton <akpm@linux-foundation.org>
Cc: Rik van Riel <riel@redhat.com> (commit_signer:5/10=50%)
Cc: Michel Lespinasse <walken@google.com>
Cc: Shaohua Li <shli@kernel.org>
Cc: Jerome Marchand <jmarchan@redhat.com>
Cc: Mikulas Patocka <mpatocka@redhat.com>
Cc: Joonsoo Kim <iamjoonsoo.kim@lge.com>
---
 include/linux/string.h |    1 +
 mm/util.c              |   19 +++++++++++++++++++
 2 files changed, 20 insertions(+)

Comments

Sebastian Capella Jan. 30, 2014, 1:27 a.m. UTC | #1
Hi Mikulas,

The function body is really verbatim from Andrew's email, as I couldn't
think of any good improvements to add to it.  I'm not sure how best to
credit it to him.

I appreciate you looking it over so carefully.

Sebastian
Sebastian Capella Jan. 30, 2014, 3:41 a.m. UTC | #2
Quoting Joe Perches (2014-01-29 17:24:28)
> Why not minimize the malloc length too?
> 
> maybe something like:
> 
> char *kstrimdup(const char *s, gfp_t gfp)
> {
>         char *buf;
>         const char *begin = skip_spaces(s);
>         size_t len = strlen(begin);
> 
>         while (len && isspace(begin[len - 1]))
>                 len--;
> 
>         buf = kmalloc_track_caller(len + 1, gfp);
>         if (!buf)
>                 return NULL;
> 
>         memcpy(buf, begin, len);
>         buf[len] = 0;
> 
>         return buf;
> }

I figured it would be mostly for small trimming, but it seems like
it could be and advantage and used more generally this way.

I have a couple of small changes to return NULL in empty string/all ws
cases and fix a buffer underrun.

How does this look?

Thanks,

Sebastian


char *kstrimdup(const char *s, gfp_t gfp)
{                                                                                
        char *buf;                                                               
        const char *begin = skip_spaces(s);                                      
        size_t len = strlen(begin);                                              

        if (len == 0)                                                            
                return NULL;                                                     
                                                                                 
        while (len > 1 && isspace(begin[len - 1]))                               
                len--;                                                           
                                                                                 
        buf = kmalloc_track_caller(len + 1, gfp);                                
        if (!buf)                                                                
                return NULL;                                                     
                                                                                 
        memcpy(buf, begin, len);                                                 
        buf[len] = '\0';                                                            
                                                                                 
        return buf;                                                              
}
Sebastian Capella Jan. 30, 2014, 6:07 p.m. UTC | #3
Quoting Joe Perches (2014-01-29 19:50:59)
> What should the return be to this string?
> " "
> Should it be "" or " " or NULL?
> 
> I don't think it should be NULL.
> I don't think it should be " ".

Right, thanks for pointing that out.  It should match how trim behaves :)

Your original looks good. removing the begin declaration adds an
extra line, and I think it reads nicely the way you had it.

	size_t len;
	s = skip_spaces(s);
	len = strlen(begin);

This is what I have now, basically your original with the len > 1 check
and the '\0' replacing 0.

char *kstrimdup(const char *s, gfp_t gfp)
{
	char *buf;
	char *begin = skip_spaces(s);
	size_t len = strlen(begin);

	while (len > 1 && isspace(begin[len - 1]))
		len--;

	buf = kmalloc_track_caller(len + 1, gfp);
	if (!buf)
		return NULL;

	memcpy(buf, begin, len);
	buf[len] = '\0';

	return buf;
}

Any other comments?

Thanks!

Sebastian
Sebastian Capella Jan. 31, 2014, 8 p.m. UTC | #4
Quoting Pavel Machek (2014-01-31 04:24:21)
> Well, your /sys/power/resume patch would be nice cleanup, but it
> changs behaviour, too... which is unnice. Stripping trailing "\n" is
> probably neccessary, because we did it before. (It probably was a
> mistake). But kernel is not right place to second-guess what the user
> meant. Just return -EINVAL. This is kernel ABI, after all, not user
> facing shell.

Thanks guys!  I hadn't thought of these cases.

It sounds like we're really back to stripping one trailing \n to match
the sysfs behavior to which people have become accustomed, and leave
the rest of the string untouched in case the whitespace is intentional.

Should a user intentionally have input ending in a newline, then they
should add an additional newline, expecting it to be stripped, but
otherwise, their string is taken as entered.

Does this sound right?

Meanwhile, I'll try a test to see how name_to_dev_t handles files with
spaces in them.

Thanks,

Sebastian
diff mbox

Patch

diff --git a/include/linux/string.h b/include/linux/string.h
index ac889c5..f29f9a0 100644
--- a/include/linux/string.h
+++ b/include/linux/string.h
@@ -114,6 +114,7 @@  void *memchr_inv(const void *s, int c, size_t n);
 
 extern char *kstrdup(const char *s, gfp_t gfp);
 extern char *kstrndup(const char *s, size_t len, gfp_t gfp);
+extern char *kstrimdup(const char *s, gfp_t gfp);
 extern void *kmemdup(const void *src, size_t len, gfp_t gfp);
 
 extern char **argv_split(gfp_t gfp, const char *str, int *argcp);
diff --git a/mm/util.c b/mm/util.c
index a24aa22..da17de5 100644
--- a/mm/util.c
+++ b/mm/util.c
@@ -63,6 +63,25 @@  char *kstrndup(const char *s, size_t max, gfp_t gfp)
 EXPORT_SYMBOL(kstrndup);
 
 /**
+ * kstrimdup - Trim and copy a %NUL terminated string.
+ * @s: the string to trim and duplicate
+ * @gfp: the GFP mask used in the kmalloc() call when allocating memory
+ *
+ * Returns an address, which the caller must kfree, containing
+ * a duplicate of the passed string with leading and/or trailing
+ * whitespace (as defined by isspace) removed.
+ */
+char *kstrimdup(const char *s, gfp_t gfp)
+{
+	char *ret = kstrdup(skip_spaces(s), gfp);
+
+	if (ret)
+		strim(ret);
+	return ret;
+}
+EXPORT_SYMBOL(kstrimdup);
+
+/**
  * kmemdup - duplicate region of memory
  *
  * @src: memory region to duplicate