Re: [PATCH 2/2] string_helpers: Change semantics of string_escape_mem
From: Andy Shevchenko <andriy.shevchenko@linux.intel.com>
Date: 2015-01-28 20:37:51
Also in:
linux-nfs, lkml
On Wed, 2015-01-28 at 14:25 +0100, Rasmus Villemoes wrote:
The current semantics of string_escape_mem are inadequate for one of its two current users, vsnprintf(). If that is to honour its contract, it must know how much space would be needed for the entire escaped buffer, and string_escape_mem provides no way of obtaining that (short of allocating a large enough buffer (~4 times input string) to let it play with, and that's definitely a big no-no inside vsnprintf). So change the semantics for string_escape_mem to be more snprintf-like: Return the size of the output that would be generated if the destination buffer was big enough, but of course still only write to the part of dst it is allowed to, and don't do '\0'-termination. It is then up to the caller to detect whether output was truncated and to append a '\0' if desired. This also fixes a bug in the escaped_string() helper function, which used to unconditionally pass a length of "end-buf" to string_escape_mem(); since the latter doesn't check osz for being insanely large, it would happily write to dst. For example, kasprintf(GFP_KERNEL, "something and then %pE", ...); is an easy way to trigger an oops.
The patch is somewhat larger than I'd like, but I couldn't find a way of splitting it into smaller pieces. Implementation-wise, I changed the various escape_* helpers to return true if they handled the character, updating dst appropriately, false otherwise. Maybe there's a more elegant way, but this seems to work.
Can we split this to at least two parts: internal API changes to string_escape_mem() and the rest?
In test-string_helpers.c, I removed the now meaningless -ENOMEM test, and replaced it with testing for getting the expected return value even if the buffer is too small. Also ensure that nothing is written when osz==0. In net/sunrpc/cache.c, I think qword_add still has the same semantics. Someone should definitely double-check this.
-- Andy Shevchenko [off-list ref] Intel Finland Oy