mirror of
https://github.com/git/git.git
synced 2024-05-05 10:36:11 +02:00
2841e8f81c
Some `clean` / `smudge` filters may require a significant amount of
time to process a single blob (e.g. the Git LFS smudge filter might
perform network requests). During this process the Git checkout
operation is blocked and Git needs to wait until the filter is done to
continue with the checkout.
Teach the filter process protocol, introduced in edcc8581 ("convert: add
filter.<driver>.process option", 2016-10-16), to accept the status
"delayed" as response to a filter request. Upon this response Git
continues with the checkout operation. After the checkout operation Git
calls "finish_delayed_checkout" which queries the filter for remaining
blobs. If the filter is still working on the completion, then the filter
is expected to block. If the filter has completed all remaining blobs
then an empty response is expected.
Git has a multiple code paths that checkout a blob. Support delayed
checkouts only in `clone` (in unpack-trees.c) and `checkout` operations
for now. The optimization is most effective in these code paths as all
files of the tree are processed.
Signed-off-by: Lars Schneider <larsxschneider@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
112 lines
3.3 KiB
C
112 lines
3.3 KiB
C
/*
|
|
* Copyright (c) 2011, Google Inc.
|
|
*/
|
|
#ifndef CONVERT_H
|
|
#define CONVERT_H
|
|
|
|
#include "string-list.h"
|
|
|
|
enum safe_crlf {
|
|
SAFE_CRLF_FALSE = 0,
|
|
SAFE_CRLF_FAIL = 1,
|
|
SAFE_CRLF_WARN = 2,
|
|
SAFE_CRLF_RENORMALIZE = 3
|
|
};
|
|
|
|
extern enum safe_crlf safe_crlf;
|
|
|
|
enum auto_crlf {
|
|
AUTO_CRLF_FALSE = 0,
|
|
AUTO_CRLF_TRUE = 1,
|
|
AUTO_CRLF_INPUT = -1
|
|
};
|
|
|
|
extern enum auto_crlf auto_crlf;
|
|
|
|
enum eol {
|
|
EOL_UNSET,
|
|
EOL_CRLF,
|
|
EOL_LF,
|
|
#ifdef NATIVE_CRLF
|
|
EOL_NATIVE = EOL_CRLF
|
|
#else
|
|
EOL_NATIVE = EOL_LF
|
|
#endif
|
|
};
|
|
|
|
enum ce_delay_state {
|
|
CE_NO_DELAY = 0,
|
|
CE_CAN_DELAY = 1,
|
|
CE_RETRY = 2
|
|
};
|
|
|
|
struct delayed_checkout {
|
|
/*
|
|
* State of the currently processed cache entry. If the state is
|
|
* CE_CAN_DELAY, then the filter can delay the current cache entry.
|
|
* If the state is CE_RETRY, then this signals the filter that the
|
|
* cache entry was requested before.
|
|
*/
|
|
enum ce_delay_state state;
|
|
/* List of filter drivers that signaled delayed blobs. */
|
|
struct string_list filters;
|
|
/* List of delayed blobs identified by their path. */
|
|
struct string_list paths;
|
|
};
|
|
|
|
extern enum eol core_eol;
|
|
extern const char *get_cached_convert_stats_ascii(const char *path);
|
|
extern const char *get_wt_convert_stats_ascii(const char *path);
|
|
extern const char *get_convert_attr_ascii(const char *path);
|
|
|
|
/* returns 1 if *dst was used */
|
|
extern int convert_to_git(const char *path, const char *src, size_t len,
|
|
struct strbuf *dst, enum safe_crlf checksafe);
|
|
extern int convert_to_working_tree(const char *path, const char *src,
|
|
size_t len, struct strbuf *dst);
|
|
extern int async_convert_to_working_tree(const char *path, const char *src,
|
|
size_t len, struct strbuf *dst,
|
|
void *dco);
|
|
extern int async_query_available_blobs(const char *cmd, struct string_list *available_paths);
|
|
extern int renormalize_buffer(const char *path, const char *src, size_t len,
|
|
struct strbuf *dst);
|
|
static inline int would_convert_to_git(const char *path)
|
|
{
|
|
return convert_to_git(path, NULL, 0, NULL, 0);
|
|
}
|
|
/* Precondition: would_convert_to_git_filter_fd(path) == true */
|
|
extern void convert_to_git_filter_fd(const char *path, int fd,
|
|
struct strbuf *dst,
|
|
enum safe_crlf checksafe);
|
|
extern int would_convert_to_git_filter_fd(const char *path);
|
|
|
|
/*****************************************************************
|
|
*
|
|
* Streaming conversion support
|
|
*
|
|
*****************************************************************/
|
|
|
|
struct stream_filter; /* opaque */
|
|
|
|
extern struct stream_filter *get_stream_filter(const char *path, const unsigned char *);
|
|
extern void free_stream_filter(struct stream_filter *);
|
|
extern int is_null_stream_filter(struct stream_filter *);
|
|
|
|
/*
|
|
* Use as much input up to *isize_p and fill output up to *osize_p;
|
|
* update isize_p and osize_p to indicate how much buffer space was
|
|
* consumed and filled. Return 0 on success, non-zero on error.
|
|
*
|
|
* Some filters may need to buffer the input and look-ahead inside it
|
|
* to decide what to output, and they may consume more than zero bytes
|
|
* of input and still not produce any output. After feeding all the
|
|
* input, pass NULL as input and keep calling this function, to let
|
|
* such filters know there is no more input coming and it is time for
|
|
* them to produce the remaining output based on the buffered input.
|
|
*/
|
|
extern int stream_filter(struct stream_filter *,
|
|
const char *input, size_t *isize_p,
|
|
char *output, size_t *osize_p);
|
|
|
|
#endif /* CONVERT_H */
|