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

Re: To "const char *" and cast on free(), or "char *" and no cast...

From
PWPhillip Wood <phillip.wood123@gmail.com>
Date
Oct 15, 2021, 10:03 UTC
Message-ID
<5868076d-69cf-9b77-fa5c-5bb229333bd9@gmail.com>
In-Reply-To
<xmqqlf2vbbl8.fsf@gitster.g>
Hi Junio
On 14/10/2021 21:22, Junio C Hamano wrote:
Show 25 quoted lines
> Ævar Arnfjörð Bjarmason <avarab@gmail.com> writes:
> 
>>> It's great to see these leaks being fixed. I wonder though if it would
>>> be better to change the structure definition so that 'name' and 'path'
>>> are no longer 'const'. That would be a better reflection of the new
>>> regime.[...]
>>
>> I think this is the right thing to do, but I'm not quite sure. There was
>> a thread at it here:
>>
>>      https://lore.kernel.org/git/YUZG0D5ayEWd7MLP@carlos-mbp.lan/
>>
>> Where I chimed in and suggested exactly what you're saying here, but the
>> consensus seemed to go the other way, and if you grep:
>>
>>      git grep -F 'free((char *)'
>>
>> You can see that we use this pattern pretty widely.
> 
> Unfortunately, we probably need to make a trade-off and cannot eat
> the cake and have it at the same time.
> 
> If we leave the .members non-const, the destructor may have to cast
> the constness away.  If it is marked const * const, then we also
> need to let the constructor do the same.

It's not just in the destructor though, there are several other places where we cast the value to free it suggesting it is not actually const. I'd rather pass a "const struct branch_info*" around to all the callers that are not mutating the struct (we already do that in some places but not all) and change the structure definition to avoid the casts where it is mutated.

Show 6 quoted lines
> By marking the .members const, we can be sure that the users of the
> API will not muck with the values once the structure is instanciated
> and given to them, but the destructor need to cast the constness
> away.  It may be lessor of two evils, as the need to cast is isolated
> in the _implementation_ of the API, and casts in the _users_ of the API
> would stand out more.

If it was just the destructor that was free()'ing the values I'd agree but the struct gets mutated in other places as well.

Best Wishes
Phillip
Previous: Junio C HamanoNext: Junio C Hamano
Message 5 of 12 in “checkout: fix "branch info" memory leaks”
  1. checkout: fix "branch info" memory leaksÆvar Arnfjörð Bjarmason, Oct 14, 2021
  2. Phillip WoodOct 14, 2021
  3. To "const char *" and cast on free(), or "char *" and no cast...Ævar Arnfjörð Bjarmason, Oct 14, 2021
  4. Junio C HamanoOct 14, 2021
  5. Phillip WoodOct 15, 2021
  6. Junio C HamanoOct 15, 2021
  7. Eric WongOct 14, 2021
  8. Phillip WoodOct 15, 2021
  9. checkout: fix "branch info" memory leaksÆvar Arnfjörð Bjarmason, Oct 21, 2021
  10. Phillip WoodOct 24, 2021
  11. checkout: fix "branch info" memory leaksÆvar Arnfjörð Bjarmason, Nov 3, 2021
  12. checkout: fix "branch info" memory leaksÆvar Arnfjörð Bjarmason, Nov 16, 2021

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.