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

Re: [PATCH v2 14/16] fsmonitor: support case-insensitive events

From
Junio C Hamano <gitster@pobox.com>
Date
Feb 23, 2024, 18:14 UTC
Message-ID
<xmqqjzmvt5d3.fsf@gitster.g>
In-Reply-To
<288f3f4e54e98a68d72e97125b1520605c138c3c.1708658300.git.gitgitgadget@gmail.com>
"Jeff Hostetler via GitGitGadget" <gitgitgadget@gmail.com> writes:
Show 39 quoted lines
> +/*
> + * Use the name-hash to do a case-insensitive cache-entry lookup with
> + * the pathname and invalidate the cache-entry.
> + *
> + * Returns the number of cache-entries that we invalidated.
> + */
> +static size_t handle_using_name_hash_icase(
> +	struct index_state *istate, const char *name)
> +{
> +	struct cache_entry *ce = NULL;
> +
> +	ce = index_file_exists(istate, name, strlen(name), 1);
> +	if (!ce)
> +		return 0;
> +
> +	/*
> +	 * A case-insensitive search in the name-hash using the
> +	 * observed pathname found a cache-entry, so the observed path
> +	 * is case-incorrect.  Invalidate the cache-entry and use the
> +	 * correct spelling from the cache-entry to invalidate the
> +	 * untracked-cache.  Since we now have sparse-directories in
> +	 * the index, the observed pathname may represent a regular
> +	 * file or a sparse-index directory.
> +	 *
> +	 * Note that we should not have seen FSEvents for a
> +	 * sparse-index directory, but we handle it just in case.
> +	 *
> +	 * Either way, we know that there are not any cache-entries for
> +	 * children inside the cone of the directory, so we don't need to
> +	 * do the usual scan.
> +	 */
> +	trace_printf_key(&trace_fsmonitor,
> +			 "fsmonitor_refresh_callback MAP: '%s' '%s'",
> +			 name, ce->name);
> +
> +	untracked_cache_invalidate_trimmed_path(istate, ce->name, 0);
> +	ce->ce_flags &= ~CE_FSMONITOR_VALID;
> +	return 1;
> +}

You first ask the name-hash to turn the incoming "name" into the case variant that we know about, i.e. ce->name, and use that to access the untracked cache. Clever and makes sense. But if we have ce->name, doesn't it mean the name is tracked? Do we find anything useful to do in the untracked cache invalidation codepath in that case?

An FSmonitor event with case-incorrect pathname for a directory may not be this trivial, I presume, and I expect that is what the remainder of this patch is about.

Show 10 quoted lines
> +
> +/*
> + * Use the dir-name-hash to find the correct-case spelling of the
> + * directory.  Use the canonical spelling to invalidate all of the
> + * cache-entries within the matching cone.
> + *
> + * Returns the number of cache-entries that we invalidated.
> + */
> +static size_t handle_using_dir_name_hash_icase(
> +	struct index_state *istate, const char *name)

It is a bit unfortunate that here on the name-hash side we contrast the two helper function variants as "dir-name" vs "name", while the original handle_path side use "without_slash" vs "with_slash".

If I understand correctly, it is not like there are two distinct hashes, "name-hash" vs "dir-name-hash". Both of these helpers use the same "name-hash" mechanism, and this function differs from the previous one in that it is about a directory, which is why it has "dir" in its name. I wonder if we renamed the other one with "nondir" in its name, and the other without_slash and with_slash pair to match, e.g., handle_nondir_path() vs handle_dir_path(), or something like that, the resulting names for these four functions become easier to contrast and understand?

Show 26 quoted lines
> +{
> +	struct strbuf canonical_path = STRBUF_INIT;
> +	int pos;
> +	size_t len = strlen(name);
> +	size_t nr_in_cone;
> +
> +	if (name[len - 1] == '/')
> +		len--;
> +
> +	if (!index_dir_find(istate, name, len, &canonical_path))
> +		return 0; /* name is untracked */
> +
> +	if (!memcmp(name, canonical_path.buf, canonical_path.len)) {
> +		strbuf_release(&canonical_path);
> +		/*
> +		 * NEEDSWORK: Our caller already tried an exact match
> +		 * and failed to find one.  They called us to do an
> +		 * ICASE match, so we should never get an exact match,
> +		 * so we could promote this to a BUG() here if we
> +		 * wanted to.  It doesn't hurt anything to just return
> +		 * 0 and go on becaus we should never get here.  Or we
> +		 * could just get rid of the memcmp() and this "if"
> +		 * clause completely.
> +		 */
> +		return 0; /* should not happen */
> +	}
"becaus" -> "because".

If we should never get here, having BUG("we should never get here") would not hurt anything, either. On the other hand, silently returning 0 will hide the bug under the carpet, and I am not sure it is fair to call it "doesn't hurt anything".

Show 19 quoted lines
> +
> +	trace_printf_key(&trace_fsmonitor,
> +			 "fsmonitor_refresh_callback MAP: '%s' '%s'",
> +			 name, canonical_path.buf);
> +
> +	/*
> +	 * The dir-name-hash only tells us the corrected spelling of
> +	 * the prefix.  We have to use this canonical path to do a
> +	 * lookup in the cache-entry array so that we repeat the
> +	 * original search using the case-corrected spelling.
> +	 */
> +	strbuf_addch(&canonical_path, '/');
> +	pos = index_name_pos(istate, canonical_path.buf,
> +			     canonical_path.len);
> +	nr_in_cone = handle_path_with_trailing_slash(
> +		istate, canonical_path.buf, pos);
> +	strbuf_release(&canonical_path);
> +	return nr_in_cone;
> +}

Nice. Do we need to give this corrected name to help untracked cache invalidation from the caller that called us?

Show 16 quoted lines
> @@ -319,6 +416,19 @@ static void fsmonitor_refresh_callback(struct index_state *istate, char *name)
>  	else
>  		nr_in_cone = handle_path_without_trailing_slash(istate, name, pos);
>  
> +	/*
> +	 * If we did not find an exact match for this pathname or any
> +	 * cache-entries with this directory prefix and we're on a
> +	 * case-insensitive file system, try again using the name-hash
> +	 * and dir-name-hash.
> +	 */
> +	if (!nr_in_cone && ignore_case) {
> +		nr_in_cone = handle_using_name_hash_icase(istate, name);
> +		if (!nr_in_cone)
> +			nr_in_cone = handle_using_dir_name_hash_icase(
> +				istate, name);
> +	}

It might be interesting to learn how often we go through these "fallback" code paths by tracing. Maybe it will become too noisy? I dunno.

>  	if (nr_in_cone)
>  		trace_printf_key(&trace_fsmonitor,
>  				 "fsmonitor_refresh_callback CNT: %d",
Previous: Jeff Hostetler via GitGitGadgetNext: Jeff Hostetler
Message 63 of 91 in “FSMonitor edge cases on case-insensitive file systems”
  1. 00/12 FSMonitor edge cases on case-insensitive file systemsJeff Hostetler via GitGitGadget, Feb 13, 2024
  2. 01/12 sparse-index: pass string length to index_file_exists()Jeff Hostetler via GitGitGadget, Feb 13, 2024
  3. Junio C HamanoFeb 13, 2024
  4. Jeff HostetlerFeb 20, 2024
  5. 02/12 name-hash: add index_dir_exists2()Jeff Hostetler via GitGitGadget, Feb 13, 2024
  6. Junio C HamanoFeb 13, 2024
  7. Jeff HostetlerFeb 20, 2024
  8. Junio C HamanoFeb 20, 2024
  9. Patrick SteinhardtFeb 15, 2024
  10. 03/12 t7527: add case-insensitve test for FSMonitorJeff Hostetler via GitGitGadget, Feb 13, 2024
  11. 04/12 fsmonitor: refactor refresh callback on directory eventsJeff Hostetler via GitGitGadget, Feb 13, 2024
  12. Patrick SteinhardtFeb 15, 2024
  13. Jeff HostetlerFeb 20, 2024
  14. Patrick SteinhardtFeb 21, 2024
  15. 05/12 fsmonitor: refactor refresh callback for non-directory eventsJeff Hostetler via GitGitGadget, Feb 13, 2024
  16. Junio C HamanoFeb 14, 2024
  17. Patrick SteinhardtFeb 15, 2024
  18. 06/12 fsmonitor: clarify handling of directory events in callbackJeff Hostetler via GitGitGadget, Feb 13, 2024
  19. Junio C HamanoFeb 14, 2024
  20. Jeff HostetlerFeb 20, 2024
  21. Junio C HamanoFeb 20, 2024
  22. Patrick SteinhardtFeb 15, 2024
  23. Jeff HostetlerFeb 20, 2024
  24. 07/12 fsmonitor: refactor untracked-cache invalidationJeff Hostetler via GitGitGadget, Feb 13, 2024
  25. Junio C HamanoFeb 14, 2024
  26. Patrick SteinhardtFeb 15, 2024
  27. 08/12 fsmonitor: support case-insensitive directory eventsJeff Hostetler via GitGitGadget, Feb 13, 2024
  28. Patrick SteinhardtFeb 15, 2024
  29. 09/12 fsmonitor: refactor non-directory callbackJeff Hostetler via GitGitGadget, Feb 13, 2024
  30. Patrick SteinhardtFeb 15, 2024
  31. 10/12 fsmonitor: support case-insensitive non-directory eventsJeff Hostetler via GitGitGadget, Feb 13, 2024
  32. 11/12 fsmonitor: refactor bit invalidation in refresh callbackJeff Hostetler via GitGitGadget, Feb 13, 2024
  33. Patrick SteinhardtFeb 15, 2024
  34. 12/12 t7527: update case-insenstive fsmonitor testJeff Hostetler via GitGitGadget, Feb 13, 2024
  35. 00/16 FSMonitor edge cases on case-insensitive file systemsJeff Hostetler via GitGitGadget, Feb 23, 2024
  36. 01/16 name-hash: add index_dir_find()Jeff Hostetler via GitGitGadget, Feb 23, 2024
  37. Junio C HamanoFeb 23, 2024
  38. 03/16 t7527: temporarily disable case-insensitive testsJeff Hostetler via GitGitGadget, Feb 23, 2024
  39. Junio C HamanoFeb 23, 2024
  40. Jeff HostetlerFeb 26, 2024
  41. 02/16 t7527: add case-insensitve test for FSMonitorJeff Hostetler via GitGitGadget, Feb 23, 2024
  42. 05/16 fsmonitor: clarify handling of directory events in callback helperJeff Hostetler via GitGitGadget, Feb 23, 2024
  43. 04/16 fsmonitor: refactor refresh callback on directory eventsJeff Hostetler via GitGitGadget, Feb 23, 2024
  44. Junio C HamanoFeb 23, 2024
  45. 06/16 fsmonitor: refactor refresh callback for non-directory eventsJeff Hostetler via GitGitGadget, Feb 23, 2024
  46. Junio C HamanoFeb 23, 2024
  47. Torsten BögershausenFeb 25, 2024
  48. Junio C HamanoFeb 25, 2024
  49. 07/16 dir: create untracked_cache_invalidate_trimmed_path()Jeff Hostetler via GitGitGadget, Feb 23, 2024
  50. Torsten BögershausenFeb 25, 2024
  51. 08/16 fsmonitor: refactor untracked-cache invalidationJeff Hostetler via GitGitGadget, Feb 23, 2024
  52. 09/16 fsmonitor: move untracked invalidation into helper functionsJeff Hostetler via GitGitGadget, Feb 23, 2024
  53. Junio C HamanoFeb 23, 2024
  54. Jeff HostetlerFeb 26, 2024
  55. 10/16 fsmonitor: return invalidated cache-entry count on directory eventJeff Hostetler via GitGitGadget, Feb 23, 2024
  56. 11/16 fsmonitor: remove custom loop from non-directory path handlerJeff Hostetler via GitGitGadget, Feb 23, 2024
  57. Junio C HamanoFeb 23, 2024
  58. 13/16 fsmonitor: trace the new invalidated cache-entry countJeff Hostetler via GitGitGadget, Feb 23, 2024
  59. Junio C HamanoFeb 23, 2024
  60. 12/16 fsmonitor: return invalided cache-entry count on non-directory eventJeff Hostetler via GitGitGadget, Feb 23, 2024
  61. Junio C HamanoFeb 23, 2024
  62. 14/16 fsmonitor: support case-insensitive eventsJeff Hostetler via GitGitGadget, Feb 23, 2024
  63. Junio C HamanoFeb 23, 2024
  64. Jeff HostetlerFeb 26, 2024
  65. Junio C HamanoFeb 26, 2024
  66. Torsten BögershausenFeb 25, 2024
  67. Jeff HostetlerFeb 26, 2024
  68. 15/16 fsmonitor: refactor bit invalidation in refresh callbackJeff Hostetler via GitGitGadget, Feb 23, 2024
  69. Junio C HamanoFeb 23, 2024
  70. 16/16 t7527: update case-insenstive fsmonitor testJeff Hostetler via GitGitGadget, Feb 23, 2024
  71. 00/14 FSMonitor edge cases on case-insensitive file systemsJeff Hostetler via GitGitGadget, Feb 26, 2024
  72. 01/14 name-hash: add index_dir_find()Jeff Hostetler via GitGitGadget, Feb 26, 2024
  73. 02/14 t7527: add case-insensitve test for FSMonitorJeff Hostetler via GitGitGadget, Feb 26, 2024
  74. 03/14 fsmonitor: refactor refresh callback on directory eventsJeff Hostetler via GitGitGadget, Feb 26, 2024
  75. 04/14 fsmonitor: clarify handling of directory events in callback helperJeff Hostetler via GitGitGadget, Feb 26, 2024
  76. 05/14 fsmonitor: refactor refresh callback for non-directory eventsJeff Hostetler via GitGitGadget, Feb 26, 2024
  77. 06/14 dir: create untracked_cache_invalidate_trimmed_path()Jeff Hostetler via GitGitGadget, Feb 26, 2024
  78. 07/14 fsmonitor: refactor untracked-cache invalidationJeff Hostetler via GitGitGadget, Feb 26, 2024
  79. 08/14 fsmonitor: move untracked-cache invalidation into helper functionsJeff Hostetler via GitGitGadget, Feb 26, 2024
  80. 09/14 fsmonitor: return invalidated cache-entry count on directory eventJeff Hostetler via GitGitGadget, Feb 26, 2024
  81. 10/14 fsmonitor: remove custom loop from non-directory path handlerJeff Hostetler via GitGitGadget, Feb 26, 2024
  82. 11/14 fsmonitor: return invalided cache-entry count on non-directory eventJeff Hostetler via GitGitGadget, Feb 26, 2024
  83. Patrick SteinhardtMar 6, 2024
  84. 12/14 fsmonitor: trace the new invalidated cache-entry countJeff Hostetler via GitGitGadget, Feb 26, 2024
  85. 13/14 fsmonitor: refactor bit invalidation in refresh callbackJeff Hostetler via GitGitGadget, Feb 26, 2024
  86. 14/14 fsmonitor: support case-insensitive eventsJeff Hostetler via GitGitGadget, Feb 26, 2024
  87. Patrick SteinhardtMar 6, 2024
  88. Junio C HamanoFeb 27, 2024
  89. Patrick SteinhardtMar 6, 2024
  90. Junio C HamanoMar 6, 2024
  91. Jeff HostetlerMar 6, 2024

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.