object-file.h: move declarations for object-file.c functions from cache.h

Signed-off-by: Elijah Newren <newren@gmail.com>
Acked-by: Calvin Wan <calvinwan@google.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
Elijah Newren 2023-04-11 00:41:53 -07:00 committed by Junio C Hamano
parent d530c04e2c
commit 87bed17907
57 changed files with 184 additions and 123 deletions

View File

@ -23,6 +23,7 @@
#include "ll-merge.h"
#include "lockfile.h"
#include "object-name.h"
#include "object-file.h"
#include "parse-options.h"
#include "quote.h"
#include "rerere.h"

View File

@ -8,6 +8,7 @@
#include "hook.h"
#include "hook-list.h"
#include "diagnose.h"
#include "object-file.h"
#include "setup.h"
#include "wrapper.h"

View File

@ -20,6 +20,7 @@
#include "tree-walk.h"
#include "oid-array.h"
#include "packfile.h"
#include "object-file.h"
#include "object-name.h"
#include "object-store.h"
#include "replace-object.h"

View File

@ -21,6 +21,7 @@
#include "fetch-pack.h"
#include "refs.h"
#include "refspec.h"
#include "object-file.h"
#include "object-store.h"
#include "tree.h"
#include "tree-walk.h"

View File

@ -2,6 +2,7 @@
#include "abspath.h"
#include "alloc.h"
#include "gettext.h"
#include "object-file.h"
#include "parse-options.h"
#ifndef NO_UNIX_SOCKETS

View File

@ -1,6 +1,7 @@
#include "builtin.h"
#include "abspath.h"
#include "gettext.h"
#include "object-file.h"
#include "parse-options.h"
#include "diagnose.h"

View File

@ -25,6 +25,7 @@
#include "strvec.h"
#include "strbuf.h"
#include "lockfile.h"
#include "object-file.h"
#include "object-store.h"
#include "dir.h"
#include "entry.h"

View File

@ -10,6 +10,7 @@
#include "hex.h"
#include "refs.h"
#include "refspec.h"
#include "object-file.h"
#include "object-store.h"
#include "commit.h"
#include "object.h"

View File

@ -19,6 +19,7 @@
#include "dir.h"
#include "run-command.h"
#include "packfile.h"
#include "object-file.h"
#include "object-name.h"
#include "object-store.h"
#include "mem-pool.h"

View File

@ -2,6 +2,7 @@
#include "alloc.h"
#include "gettext.h"
#include "hex.h"
#include "object-file.h"
#include "pkt-line.h"
#include "fetch-pack.h"
#include "remote.h"

View File

@ -19,6 +19,7 @@
#include "streaming.h"
#include "decorate.h"
#include "packfile.h"
#include "object-file.h"
#include "object-name.h"
#include "object-store.h"
#include "replace-object.h"

View File

@ -25,6 +25,7 @@
#include "commit.h"
#include "commit-graph.h"
#include "packfile.h"
#include "object-file.h"
#include "object-store.h"
#include "pack.h"
#include "pack-objects.h"

View File

@ -26,6 +26,7 @@
#include "setup.h"
#include "submodule.h"
#include "submodule-config.h"
#include "object-file.h"
#include "object-name.h"
#include "object-store.h"
#include "packfile.h"

View File

@ -9,6 +9,7 @@
#include "config.h"
#include "gettext.h"
#include "hex.h"
#include "object-file.h"
#include "object-store.h"
#include "blob.h"
#include "quote.h"

View File

@ -18,6 +18,7 @@
#include "thread-utils.h"
#include "packfile.h"
#include "pack-revindex.h"
#include "object-file.h"
#include "object-store.h"
#include "oid-array.h"
#include "replace-object.h"

View File

@ -11,6 +11,7 @@
#include "refs.h"
#include "builtin.h"
#include "exec-cmd.h"
#include "object-file.h"
#include "parse-options.h"
#include "setup.h"
#include "worktree.h"

View File

@ -12,6 +12,7 @@
#include "gettext.h"
#include "hex.h"
#include "refs.h"
#include "object-file.h"
#include "object-name.h"
#include "object-store.h"
#include "color.h"

View File

@ -4,6 +4,7 @@
#include "parse-options.h"
#include "tag.h"
#include "replace-object.h"
#include "object-file.h"
#include "object-store.h"
#include "fsck.h"
#include "config.h"

View File

@ -11,6 +11,7 @@
#include "config.h"
#include "environment.h"
#include "gettext.h"
#include "object-file.h"
#include "pathspec.h"
#include "lockfile.h"
#include "dir.h"

View File

@ -33,6 +33,7 @@
#include "strvec.h"
#include "list.h"
#include "packfile.h"
#include "object-file.h"
#include "object-store.h"
#include "replace-object.h"
#include "dir.h"

View File

@ -11,6 +11,7 @@
#include "progress.h"
#include "prune-packed.h"
#include "replace-object.h"
#include "object-file.h"
#include "object-name.h"
#include "object-store.h"
#include "shallow.h"

View File

@ -21,6 +21,7 @@
#include "cache-tree.h"
#include "unpack-trees.h"
#include "lockfile.h"
#include "object-file.h"
#include "object-name.h"
#include "parse-options.h"
#include "commit.h"

View File

@ -17,6 +17,7 @@
#include "refs.h"
#include "parse-options.h"
#include "run-command.h"
#include "object-file.h"
#include "object-name.h"
#include "object-store.h"
#include "replace-object.h"

View File

@ -11,6 +11,7 @@
#include "list-objects-filter-options.h"
#include "object.h"
#include "object-name.h"
#include "object-file.h"
#include "object-store.h"
#include "pack.h"
#include "pack-bitmap.h"

View File

@ -4,6 +4,7 @@
#include "dir.h"
#include "environment.h"
#include "gettext.h"
#include "object-file.h"
#include "object-name.h"
#include "parse-options.h"
#include "pathspec.h"

View File

@ -24,6 +24,7 @@
#include "revision.h"
#include "diffcore.h"
#include "diff.h"
#include "object-file.h"
#include "object-name.h"
#include "object-store.h"
#include "advice.h"

View File

@ -15,6 +15,7 @@
#include "cache-tree.h"
#include "tree-walk.h"
#include "builtin.h"
#include "object-file.h"
#include "refs.h"
#include "resolve-undo.h"
#include "parse-options.h"

View File

@ -7,6 +7,7 @@
#include "environment.h"
#include "gettext.h"
#include "hex.h"
#include "object-file.h"
#include "object-name.h"
#include "parse-options.h"
#include "strvec.h"

View File

@ -15,6 +15,7 @@
#include "string-list.h"
#include "tmp-objdir.h"
#include "packfile.h"
#include "object-file.h"
#include "object-store.h"
static int odb_transaction_nesting;

View File

@ -7,6 +7,7 @@
#include "tree-walk.h"
#include "cache-tree.h"
#include "bulk-checkin.h"
#include "object-file.h"
#include "object-store.h"
#include "replace-object.h"
#include "promisor-remote.h"

123
cache.h
View File

@ -3,7 +3,6 @@
#include "git-compat-util.h"
#include "strbuf.h"
#include "git-zlib.h"
#include "hashmap.h"
#include "list.h"
#include "gettext.h"
@ -596,13 +595,6 @@ int has_racy_timestamp(struct index_state *istate);
int ie_match_stat(struct index_state *, const struct cache_entry *, struct stat *, unsigned int);
int ie_modified(struct index_state *, const struct cache_entry *, struct stat *, unsigned int);
#define HASH_WRITE_OBJECT 1
#define HASH_FORMAT_CHECK 2
#define HASH_RENORMALIZE 4
#define HASH_SILENT 8
int index_fd(struct index_state *istate, struct object_id *oid, int fd, struct stat *st, enum object_type type, const char *path, unsigned flags);
int index_path(struct index_state *istate, struct object_id *oid, const char *path, struct stat *st, unsigned flags);
/*
* Record to sd the data from st that we use to check whether a file
* might have changed.
@ -664,107 +656,6 @@ extern int quote_path_fully;
#define DATA_CHANGED 0x0020
#define TYPE_CHANGED 0x0040
/*
* Create the directory containing the named path, using care to be
* somewhat safe against races. Return one of the scld_error values to
* indicate success/failure. On error, set errno to describe the
* problem.
*
* SCLD_VANISHED indicates that one of the ancestor directories of the
* path existed at one point during the function call and then
* suddenly vanished, probably because another process pruned the
* directory while we were working. To be robust against this kind of
* race, callers might want to try invoking the function again when it
* returns SCLD_VANISHED.
*
* safe_create_leading_directories() temporarily changes path while it
* is working but restores it before returning.
* safe_create_leading_directories_const() doesn't modify path, even
* temporarily. Both these variants adjust the permissions of the
* created directories to honor core.sharedRepository, so they are best
* suited for files inside the git dir. For working tree files, use
* safe_create_leading_directories_no_share() instead, as it ignores
* the core.sharedRepository setting.
*/
enum scld_error {
SCLD_OK = 0,
SCLD_FAILED = -1,
SCLD_PERMS = -2,
SCLD_EXISTS = -3,
SCLD_VANISHED = -4
};
enum scld_error safe_create_leading_directories(char *path);
enum scld_error safe_create_leading_directories_const(const char *path);
enum scld_error safe_create_leading_directories_no_share(char *path);
int mkdir_in_gitdir(const char *path);
int git_open_cloexec(const char *name, int flags);
#define git_open(name) git_open_cloexec(name, O_RDONLY)
/**
* unpack_loose_header() initializes the data stream needed to unpack
* a loose object header.
*
* Returns:
*
* - ULHR_OK on success
* - ULHR_BAD on error
* - ULHR_TOO_LONG if the header was too long
*
* It will only parse up to MAX_HEADER_LEN bytes unless an optional
* "hdrbuf" argument is non-NULL. This is intended for use with
* OBJECT_INFO_ALLOW_UNKNOWN_TYPE to extract the bad type for (error)
* reporting. The full header will be extracted to "hdrbuf" for use
* with parse_loose_header(), ULHR_TOO_LONG will still be returned
* from this function to indicate that the header was too long.
*/
enum unpack_loose_header_result {
ULHR_OK,
ULHR_BAD,
ULHR_TOO_LONG,
};
enum unpack_loose_header_result unpack_loose_header(git_zstream *stream,
unsigned char *map,
unsigned long mapsize,
void *buffer,
unsigned long bufsiz,
struct strbuf *hdrbuf);
/**
* parse_loose_header() parses the starting "<type> <len>\0" of an
* object. If it doesn't follow that format -1 is returned. To check
* the validity of the <type> populate the "typep" in the "struct
* object_info". It will be OBJ_BAD if the object type is unknown. The
* parsed <len> can be retrieved via "oi->sizep", and from there
* passed to unpack_loose_rest().
*/
struct object_info;
int parse_loose_header(const char *hdr, struct object_info *oi);
/**
* With in-core object data in "buf", rehash it to make sure the
* object name actually matches "oid" to detect object corruption.
*
* A negative value indicates an error, usually that the OID is not
* what we expected, but it might also indicate another error.
*/
int check_object_signature(struct repository *r, const struct object_id *oid,
void *map, unsigned long size,
enum object_type type);
/**
* A streaming version of check_object_signature().
* Try reading the object named with "oid" using
* the streaming interface and rehash it to do the same.
*/
int stream_object_signature(struct repository *r, const struct object_id *oid);
int finalize_object_file(const char *tmpfile, const char *filename);
/* Helper to check and "touch" a file */
int check_and_freshen_file(const char *fn, int freshen);
int base_name_compare(const char *name1, size_t len1, int mode1,
const char *name2, size_t len2, int mode2);
int df_name_compare(const char *name1, size_t len1, int mode1,
@ -772,12 +663,6 @@ int df_name_compare(const char *name1, size_t len1, int mode1,
int name_compare(const char *name1, size_t len1, const char *name2, size_t len2);
int cache_name_stage_compare(const char *name1, int len1, int stage1, const char *name2, int len2, int stage2);
void *read_object_with_reference(struct repository *r,
const struct object_id *oid,
enum object_type required_type,
unsigned long *size,
struct object_id *oid_ret);
const char *git_editor(void);
const char *git_sequence_editor(void);
const char *git_pager(int stdout_is_tty);
@ -819,14 +704,6 @@ struct pack_entry {
struct packed_git *p;
};
/*
* Set this to 0 to prevent oid_object_info_extended() from fetching missing
* blobs. This has a difference only if extensions.partialClone is set.
*
* Its default value is 1.
*/
extern int fetch_if_missing;
/* Dumb servers support */
int update_server_info(int);

View File

@ -11,6 +11,7 @@
#include "revision.h"
#include "hash-lookup.h"
#include "commit-graph.h"
#include "object-file.h"
#include "object-store.h"
#include "oid-array.h"
#include "alloc.h"

1
diff.c
View File

@ -35,6 +35,7 @@
#include "help.h"
#include "promisor-remote.h"
#include "dir.h"
#include "object-file.h"
#include "object-name.h"
#include "setup.h"
#include "strmap.h"

1
dir.c
View File

@ -13,6 +13,7 @@
#include "dir.h"
#include "environment.h"
#include "gettext.h"
#include "object-file.h"
#include "object-store.h"
#include "attr.h"
#include "refs.h"

View File

@ -19,6 +19,7 @@
#include "fmt-merge-msg.h"
#include "commit.h"
#include "strvec.h"
#include "object-file.h"
#include "object-store.h"
#include "replace-object.h"
#include "tmp-objdir.h"

1
http.c
View File

@ -17,6 +17,7 @@
#include "packfile.h"
#include "protocol.h"
#include "string-list.h"
#include "object-file.h"
#include "object-store.h"
static struct trace_key trace_curl = TRACE_KEY_INIT(CURL);

View File

@ -22,6 +22,7 @@
#include "hex.h"
#include "ll-merge.h"
#include "lockfile.h"
#include "object-file.h"
#include "object-name.h"
#include "object-store.h"
#include "repository.h"

1
midx.c
View File

@ -8,6 +8,7 @@
#include "hex.h"
#include "lockfile.h"
#include "packfile.h"
#include "object-file.h"
#include "object-store.h"
#include "hash-lookup.h"
#include "midx.h"

View File

@ -3,6 +3,7 @@
#include "commit.h"
#include "gettext.h"
#include "refs.h"
#include "object-file.h"
#include "object-name.h"
#include "object-store.h"
#include "repository.h"

View File

@ -36,6 +36,7 @@
#include "mergesort.h"
#include "quote.h"
#include "packfile.h"
#include "object-file.h"
#include "object-store.h"
#include "promisor-remote.h"
#include "setup.h"

129
object-file.h Normal file
View File

@ -0,0 +1,129 @@
#ifndef OBJECT_FILE_H
#define OBJECT_FILE_H
#include "git-zlib.h"
#include "object.h"
/*
* Set this to 0 to prevent oid_object_info_extended() from fetching missing
* blobs. This has a difference only if extensions.partialClone is set.
*
* Its default value is 1.
*/
extern int fetch_if_missing;
#define HASH_WRITE_OBJECT 1
#define HASH_FORMAT_CHECK 2
#define HASH_RENORMALIZE 4
#define HASH_SILENT 8
int index_fd(struct index_state *istate, struct object_id *oid, int fd, struct stat *st, enum object_type type, const char *path, unsigned flags);
int index_path(struct index_state *istate, struct object_id *oid, const char *path, struct stat *st, unsigned flags);
/*
* Create the directory containing the named path, using care to be
* somewhat safe against races. Return one of the scld_error values to
* indicate success/failure. On error, set errno to describe the
* problem.
*
* SCLD_VANISHED indicates that one of the ancestor directories of the
* path existed at one point during the function call and then
* suddenly vanished, probably because another process pruned the
* directory while we were working. To be robust against this kind of
* race, callers might want to try invoking the function again when it
* returns SCLD_VANISHED.
*
* safe_create_leading_directories() temporarily changes path while it
* is working but restores it before returning.
* safe_create_leading_directories_const() doesn't modify path, even
* temporarily. Both these variants adjust the permissions of the
* created directories to honor core.sharedRepository, so they are best
* suited for files inside the git dir. For working tree files, use
* safe_create_leading_directories_no_share() instead, as it ignores
* the core.sharedRepository setting.
*/
enum scld_error {
SCLD_OK = 0,
SCLD_FAILED = -1,
SCLD_PERMS = -2,
SCLD_EXISTS = -3,
SCLD_VANISHED = -4
};
enum scld_error safe_create_leading_directories(char *path);
enum scld_error safe_create_leading_directories_const(const char *path);
enum scld_error safe_create_leading_directories_no_share(char *path);
int mkdir_in_gitdir(const char *path);
int git_open_cloexec(const char *name, int flags);
#define git_open(name) git_open_cloexec(name, O_RDONLY)
/**
* unpack_loose_header() initializes the data stream needed to unpack
* a loose object header.
*
* Returns:
*
* - ULHR_OK on success
* - ULHR_BAD on error
* - ULHR_TOO_LONG if the header was too long
*
* It will only parse up to MAX_HEADER_LEN bytes unless an optional
* "hdrbuf" argument is non-NULL. This is intended for use with
* OBJECT_INFO_ALLOW_UNKNOWN_TYPE to extract the bad type for (error)
* reporting. The full header will be extracted to "hdrbuf" for use
* with parse_loose_header(), ULHR_TOO_LONG will still be returned
* from this function to indicate that the header was too long.
*/
enum unpack_loose_header_result {
ULHR_OK,
ULHR_BAD,
ULHR_TOO_LONG,
};
enum unpack_loose_header_result unpack_loose_header(git_zstream *stream,
unsigned char *map,
unsigned long mapsize,
void *buffer,
unsigned long bufsiz,
struct strbuf *hdrbuf);
/**
* parse_loose_header() parses the starting "<type> <len>\0" of an
* object. If it doesn't follow that format -1 is returned. To check
* the validity of the <type> populate the "typep" in the "struct
* object_info". It will be OBJ_BAD if the object type is unknown. The
* parsed <len> can be retrieved via "oi->sizep", and from there
* passed to unpack_loose_rest().
*/
struct object_info;
int parse_loose_header(const char *hdr, struct object_info *oi);
/**
* With in-core object data in "buf", rehash it to make sure the
* object name actually matches "oid" to detect object corruption.
*
* A negative value indicates an error, usually that the OID is not
* what we expected, but it might also indicate another error.
*/
int check_object_signature(struct repository *r, const struct object_id *oid,
void *map, unsigned long size,
enum object_type type);
/**
* A streaming version of check_object_signature().
* Try reading the object named with "oid" using
* the streaming interface and rehash it to do the same.
*/
int stream_object_signature(struct repository *r, const struct object_id *oid);
int finalize_object_file(const char *tmpfile, const char *filename);
/* Helper to check and "touch" a file */
int check_and_freshen_file(const char *fn, int freshen);
void *read_object_with_reference(struct repository *r,
const struct object_id *oid,
enum object_type required_type,
unsigned long *size,
struct object_id *oid_ret);
#endif /* OBJECT_FILE_H */

View File

@ -3,6 +3,7 @@
#include "hex.h"
#include "object.h"
#include "replace-object.h"
#include "object-file.h"
#include "object-store.h"
#include "blob.h"
#include "tree.h"

View File

@ -16,6 +16,7 @@
#include "packfile.h"
#include "repository.h"
#include "trace2.h"
#include "object-file.h"
#include "object-store.h"
#include "list-objects-filter-options.h"
#include "midx.h"

View File

@ -6,6 +6,7 @@
#include "pack-revindex.h"
#include "progress.h"
#include "packfile.h"
#include "object-file.h"
#include "object-store.h"
struct idx_entry {

View File

@ -1,6 +1,7 @@
#include "cache.h"
#include "gettext.h"
#include "pack-mtimes.h"
#include "object-file.h"
#include "object-store.h"
#include "packfile.h"

View File

@ -1,6 +1,7 @@
#include "cache.h"
#include "gettext.h"
#include "pack-revindex.h"
#include "object-file.h"
#include "object-store.h"
#include "packfile.h"
#include "trace2.h"

View File

@ -18,6 +18,7 @@
#include "trace.h"
#include "tree-walk.h"
#include "tree.h"
#include "object-file.h"
#include "object-store.h"
#include "midx.h"
#include "commit-graph.h"

View File

@ -14,6 +14,7 @@
#include "cache-tree.h"
#include "refs.h"
#include "dir.h"
#include "object-file.h"
#include "object-store.h"
#include "oid-array.h"
#include "tree.h"

View File

@ -12,6 +12,7 @@
#include "../dir-iterator.h"
#include "../lockfile.h"
#include "../object.h"
#include "../object-file.h"
#include "../dir.h"
#include "../chdir-notify.h"
#include "../setup.h"

View File

@ -13,6 +13,7 @@
#include "ll-merge.h"
#include "attr.h"
#include "pathspec.h"
#include "object-file.h"
#include "object-store.h"
#include "hash-lookup.h"
#include "strmap.h"

View File

@ -5,6 +5,7 @@
#include "gettext.h"
#include "hex.h"
#include "object-name.h"
#include "object-file.h"
#include "object-store.h"
#include "tag.h"
#include "blob.h"

View File

@ -8,6 +8,7 @@
#include "hex.h"
#include "lockfile.h"
#include "dir.h"
#include "object-file.h"
#include "object-name.h"
#include "object-store.h"
#include "object.h"

View File

@ -9,6 +9,7 @@
#include "commit.h"
#include "tag.h"
#include "packfile.h"
#include "object-file.h"
#include "object-store.h"
#include "strbuf.h"
#include "wrapper.h"

View File

@ -6,6 +6,7 @@
#include "environment.h"
#include "streaming.h"
#include "repository.h"
#include "object-file.h"
#include "object-store.h"
#include "replace-object.h"
#include "packfile.h"

View File

@ -24,6 +24,7 @@
#include "remote.h"
#include "worktree.h"
#include "parse-options.h"
#include "object-file.h"
#include "object-name.h"
#include "object-store.h"
#include "commit-reach.h"

View File

@ -4,6 +4,7 @@
#include "chdir-notify.h"
#include "dir.h"
#include "environment.h"
#include "object-file.h"
#include "sigchain.h"
#include "string-list.h"
#include "strbuf.h"

View File

@ -4,6 +4,7 @@
#include "dir.h"
#include "gettext.h"
#include "hex.h"
#include "object-file.h"
#include "object-store.h"
#include "trace2.h"
#include "tree.h"