f332121e75
For sanity, we should probably do one of the following:
(a) make C and header files both depend upon everything they need
(b) consistently exclude git-compat-util.h from headers and require it
be the first include in C files
Currently, we have some of the headers following (a) and others
following (b), which makes things messy. In the past I was pushed
towards (b), as per [1] and [2]. Further, during this series I
discovered that this mixture empirically will mean that we end up with C
files that do not directly include git-compat-util.h, and do include
headers that don't include git-compat-util.h, with the result that we
likely have headers included before an indirect inclusion of
git-compat-util.h. Since git-compat-util.h has tricky platform-specific
stuff that is meant to be included before everything else, this state of
affairs is risky and may lead to things breaking in subtle ways (and
only on some platforms) as per [1] and [2].
Since including git-compat-util.h in existing header files makes it
harder for us to catch C files that are missing that include, let's
switch to (b) to make the enforcement of this rule easier. Remove the
inclusion of git-compat-util.h from header files other than the ones
that have been approved as alternate first includes.
[1] https://lore.kernel.org/git/20180811173406.GA9119@sigill.intra.peff.net/
[2] https://lore.kernel.org/git/20180811174301.GA9287@sigill.intra.peff.net/
Signed-off-by: Elijah Newren <newren@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
71 lines
1.9 KiB
C
71 lines
1.9 KiB
C
#ifndef CHUNK_FORMAT_H
|
|
#define CHUNK_FORMAT_H
|
|
|
|
#include "hash.h"
|
|
|
|
struct hashfile;
|
|
struct chunkfile;
|
|
|
|
#define CHUNK_TOC_ENTRY_SIZE (sizeof(uint32_t) + sizeof(uint64_t))
|
|
|
|
/*
|
|
* Initialize a 'struct chunkfile' for writing _or_ reading a file
|
|
* with the chunk format.
|
|
*
|
|
* If writing a file, supply a non-NULL 'struct hashfile *' that will
|
|
* be used to write.
|
|
*
|
|
* If reading a file, use a NULL 'struct hashfile *' and then call
|
|
* read_table_of_contents(). Supply the memory-mapped data to the
|
|
* pair_chunk() or read_chunk() methods, as appropriate.
|
|
*
|
|
* DO NOT MIX THESE MODES. Use different 'struct chunkfile' instances
|
|
* for reading and writing.
|
|
*/
|
|
struct chunkfile *init_chunkfile(struct hashfile *f);
|
|
void free_chunkfile(struct chunkfile *cf);
|
|
int get_num_chunks(struct chunkfile *cf);
|
|
typedef int (*chunk_write_fn)(struct hashfile *f, void *data);
|
|
void add_chunk(struct chunkfile *cf,
|
|
uint32_t id,
|
|
size_t size,
|
|
chunk_write_fn fn);
|
|
int write_chunkfile(struct chunkfile *cf, void *data);
|
|
|
|
int read_table_of_contents(struct chunkfile *cf,
|
|
const unsigned char *mfile,
|
|
size_t mfile_size,
|
|
uint64_t toc_offset,
|
|
int toc_length);
|
|
|
|
#define CHUNK_NOT_FOUND (-2)
|
|
|
|
/*
|
|
* Find 'chunk_id' in the given chunkfile and assign the
|
|
* given pointer to the position in the mmap'd file where
|
|
* that chunk begins.
|
|
*
|
|
* Returns CHUNK_NOT_FOUND if the chunk does not exist.
|
|
*/
|
|
int pair_chunk(struct chunkfile *cf,
|
|
uint32_t chunk_id,
|
|
const unsigned char **p);
|
|
|
|
typedef int (*chunk_read_fn)(const unsigned char *chunk_start,
|
|
size_t chunk_size, void *data);
|
|
/*
|
|
* Find 'chunk_id' in the given chunkfile and call the
|
|
* given chunk_read_fn method with the information for
|
|
* that chunk.
|
|
*
|
|
* Returns CHUNK_NOT_FOUND if the chunk does not exist.
|
|
*/
|
|
int read_chunk(struct chunkfile *cf,
|
|
uint32_t chunk_id,
|
|
chunk_read_fn fn,
|
|
void *data);
|
|
|
|
uint8_t oid_version(const struct git_hash_algo *algop);
|
|
|
|
#endif
|