git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Re: [PATCH] run-command: avoid undefined behavior in exists_in_PATH

From
brian m. carlson <sandals@crustytoothpaste.net>
Date
Jan 7, 2020, 02:16 UTC
Message-ID
<20200107021611.GK6570@camp.crustytoothpaste.net>
In-Reply-To
<20200107020425.GG92456@google.com>
On 2020-01-07 at 02:04:25, Jonathan Nieder wrote:
Show 34 quoted lines
> brian m. carlson wrote:
> 
> > In this function, we free the pointer we get from locate_in_PATH and
> > then check whether it's NULL.  However, this is undefined behavior if
> > the pointer is non-NULL, since the C standard no longer permits us to
> > use a valid pointer after freeing it.
> [...]
> > Noticed-by: Miriam R. <mirucam@gmail.com>
> > Signed-off-by: brian m. carlson <sandals@crustytoothpaste.net>
> > ---
> >  run-command.c | 3 ++-
> >  1 file changed, 2 insertions(+), 1 deletion(-)
> 
> Reviewed-by: Jonathan Nieder <jrnieder@gmail.com>
> 
> This API that forces the caller to deal with the allocated result when
> they never asked for it seems a bit inconvenient.  Should we clean it up
> a little?  Something like this (on top):
> 
> -- >8 --
> Subject: run-command: let caller pass in buffer to locate_in_PATH
> 
> Instead of returning a buffer that the caller is responsible for
> freeing, use a strbuf output parameter to record the path to the
> searched-for program.
> 
> This makes ownership a little easier to reason about, since the owning
> code declares the buffer.  It's a good habit to follow because it
> allows buffer reuse when calling such a function in a loop.
> 
> It also allows the caller exists_in_PATH that does not care about the
> path to the command to be slightly simplified, by allowing a NULL
> output parameter that means that locate_in_PATH should take care of
> allocating and freeing its temporary buffer.

Sure, I think this is a nice improvement. The user can reuse the buffer in a loop if they want by resetting it, which as you point out would be convenient (and potentially more efficient). And we're already using one internally, so there's no reason not to just pass one in.

-- 
brian m. carlson: Houston, Texas, US
OpenPGP: https://keybase.io/bk2204
Previous: Jonathan NiederNext: Bryan Turner
Message 3 of 11 in “run-command: avoid undefined behavior in exists_in_PATH”
  1. run-command: avoid undefined behavior in exists_in_PATHbrian m. carlson, Jan 7, 2020
  2. Jonathan NiederJan 7, 2020
  3. brian m. carlsonJan 7, 2020
  4. Bryan TurnerJan 7, 2020
  5. Bryan TurnerJan 7, 2020
  6. Jeff KingJan 7, 2020
  7. Jeff KingJan 7, 2020
  8. Junio C HamanoJan 7, 2020
  9. brian m. carlsonJan 8, 2020
  10. Miriam R.Jan 8, 2020
  11. Christian CouderJan 8, 2020

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.