2017-11-21 20:58:50 +00:00
|
|
|
#ifndef LIST_OBJECTS_FILTER_OPTIONS_H
|
|
|
|
#define LIST_OBJECTS_FILTER_OPTIONS_H
|
|
|
|
|
|
|
|
#include "parse-options.h"
|
2019-01-08 00:17:09 +00:00
|
|
|
#include "strbuf.h"
|
2017-11-21 20:58:50 +00:00
|
|
|
|
|
|
|
/*
|
|
|
|
* The list of defined filters for list-objects.
|
|
|
|
*/
|
|
|
|
enum list_objects_filter_choice {
|
|
|
|
LOFC_DISABLED = 0,
|
|
|
|
LOFC_BLOB_NONE,
|
|
|
|
LOFC_BLOB_LIMIT,
|
2019-01-09 02:59:13 +00:00
|
|
|
LOFC_TREE_DEPTH,
|
2017-11-21 20:58:50 +00:00
|
|
|
LOFC_SPARSE_OID,
|
|
|
|
LOFC__COUNT /* must be last */
|
|
|
|
};
|
|
|
|
|
|
|
|
struct list_objects_filter_options {
|
|
|
|
/*
|
|
|
|
* 'filter_spec' is the raw argument value given on the command line
|
|
|
|
* or protocol request. (The part after the "--keyword=".) For
|
2019-01-08 00:17:09 +00:00
|
|
|
* commands that launch filtering sub-processes, or for communication
|
|
|
|
* over the network, don't use this value; use the result of
|
|
|
|
* expand_list_objects_filter_spec() instead.
|
2017-11-21 20:58:50 +00:00
|
|
|
*/
|
|
|
|
char *filter_spec;
|
|
|
|
|
|
|
|
/*
|
|
|
|
* 'choice' is determined by parsing the filter-spec. This indicates
|
|
|
|
* the filtering algorithm to use.
|
|
|
|
*/
|
|
|
|
enum list_objects_filter_choice choice;
|
|
|
|
|
2017-12-08 15:58:50 +00:00
|
|
|
/*
|
|
|
|
* Choice is LOFC_DISABLED because "--no-filter" was requested.
|
|
|
|
*/
|
|
|
|
unsigned int no_filter : 1;
|
|
|
|
|
2017-11-21 20:58:50 +00:00
|
|
|
/*
|
|
|
|
* Parsed values (fields) from within the filter-spec. These are
|
|
|
|
* choice-specific; not all values will be defined for any given
|
|
|
|
* choice.
|
|
|
|
*/
|
list-objects-filter: delay parsing of sparse oid
The list-objects-filter code has two steps to its initialization:
1. parse_list_objects_filter() makes sure the spec is a filter we know
about and is syntactically correct. This step is done by "rev-list"
or "upload-pack" that is going to apply a filter, but also by "git
clone" or "git fetch" before they send the spec across the wire.
2. list_objects_filter__init() runs the type-specific initialization
(using function pointers established in step 1). This happens at
the start of traverse_commit_list_filtered(), when we're about to
actually use the filter.
It's a good idea to parse as much as we can in step 1, in order to catch
problems early (e.g., a blob size limit that isn't a number). But one
thing we _shouldn't_ do is resolve any oids at that step (e.g., for
sparse-file contents specified by oid). In the case of a fetch, the oid
has to be resolved on the remote side.
The current code does resolve the oid during the parse phase, but
ignores any error (which we must do, because we might just be sending
the spec across the wire). This leads to two bugs:
- if we're not in a repository (e.g., because it's git-clone parsing
the spec), then we trigger a BUG() trying to resolve the name
- if we did hit the error case, we still have to notice that later and
bail. The code path in rev-list handles this, but the one in
upload-pack does not, leading to a segfault.
We can fix both by moving the oid resolution into the sparse-oid init
function. At that point we know we have a repository (because we're
about to traverse), and handling the error there fixes the segfault.
As a bonus, we can drop the NULL sparse_oid_value check in rev-list,
since this is now handled in the sparse-oid-filter init function.
Signed-off-by: Jeff King <peff@peff.net>
Acked-by: Jeff Hostetler <jeffhost@microsoft.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2019-09-15 16:12:44 +00:00
|
|
|
char *sparse_oid_name;
|
2017-11-21 20:58:50 +00:00
|
|
|
unsigned long blob_limit_value;
|
2019-01-09 02:59:13 +00:00
|
|
|
unsigned long tree_exclude_depth;
|
2017-11-21 20:58:50 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
/* Normalized command line arguments */
|
|
|
|
#define CL_ARG__FILTER "filter"
|
|
|
|
|
|
|
|
int parse_list_objects_filter(
|
|
|
|
struct list_objects_filter_options *filter_options,
|
|
|
|
const char *arg);
|
|
|
|
|
|
|
|
int opt_parse_list_objects_filter(const struct option *opt,
|
|
|
|
const char *arg, int unset);
|
|
|
|
|
|
|
|
#define OPT_PARSE_LIST_OBJECTS_FILTER(fo) \
|
|
|
|
{ OPTION_CALLBACK, 0, CL_ARG__FILTER, fo, N_("args"), \
|
2017-12-05 16:50:13 +00:00
|
|
|
N_("object filtering"), 0, \
|
2017-11-21 20:58:50 +00:00
|
|
|
opt_parse_list_objects_filter }
|
|
|
|
|
2019-01-08 00:17:09 +00:00
|
|
|
/*
|
|
|
|
* Translates abbreviated numbers in the filter's filter_spec into their
|
|
|
|
* fully-expanded forms (e.g., "limit:blob=1k" becomes "limit:blob=1024").
|
|
|
|
*
|
|
|
|
* This form should be used instead of the raw filter_spec field when
|
|
|
|
* communicating with a remote process or subprocess.
|
|
|
|
*/
|
|
|
|
void expand_list_objects_filter_spec(
|
|
|
|
const struct list_objects_filter_options *filter,
|
|
|
|
struct strbuf *expanded_spec);
|
|
|
|
|
2017-12-05 16:50:13 +00:00
|
|
|
void list_objects_filter_release(
|
|
|
|
struct list_objects_filter_options *filter_options);
|
|
|
|
|
2017-12-08 15:58:50 +00:00
|
|
|
static inline void list_objects_filter_set_no_filter(
|
|
|
|
struct list_objects_filter_options *filter_options)
|
|
|
|
{
|
|
|
|
list_objects_filter_release(filter_options);
|
|
|
|
filter_options->no_filter = 1;
|
|
|
|
}
|
|
|
|
|
2017-12-08 15:58:45 +00:00
|
|
|
void partial_clone_register(
|
|
|
|
const char *remote,
|
|
|
|
const struct list_objects_filter_options *filter_options);
|
|
|
|
void partial_clone_get_default_filter_spec(
|
|
|
|
struct list_objects_filter_options *filter_options);
|
|
|
|
|
2017-11-21 20:58:50 +00:00
|
|
|
#endif /* LIST_OBJECTS_FILTER_OPTIONS_H */
|