Files
git/reftable/reftable-fsck.h
Patrick Steinhardt 34c17b840d reftable: introduce "reftable-system.h" header
We're including a couple of standard headers like <stdint.h> in a bunch
of locations, which makes it hard for a project to plug in their own
logic for making required functionality available. For us this is for
example via "compat/posix.h", which already includes all of the system
headers relevant to us.

Introduce a new "reftable-system.h" header that allows projects to
provide their own headers. This new header is supposed to contain all
the project-specific bits to provide the POSIX-like environment, and some
additional supporting code. With this change, we thus have the following
split in our system-specific code:

  - "reftable/reftable-system.h" is the project-specific header that
    provides a POSIX-like environment. Every project is expected to
    provide their own implementation.

  - "reftable/system.h" contains the project-independent definition of
    the interfaces that a project needs to implement. This file should
    not be touched by a project.

  - "reftable/system.c" contains the project-specific implementation of
    the interfaces defined in "system.h". Again, every project is
    expected to provide their own implementation.

Signed-off-by: Patrick Steinhardt <ps@pks.im>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2026-04-02 10:45:43 -07:00

42 lines
1.2 KiB
C

#ifndef REFTABLE_FSCK_H
#define REFTABLE_FSCK_H
#include "reftable-system.h"
#include "reftable-stack.h"
enum reftable_fsck_error {
/* Invalid table name */
REFTABLE_FSCK_ERROR_TABLE_NAME = 0,
/* Used for bounds checking, must be last */
REFTABLE_FSCK_MAX_VALUE,
};
/* Represents an individual error encountered during the FSCK checks. */
struct reftable_fsck_info {
enum reftable_fsck_error error;
const char *msg;
const char *path;
};
typedef int reftable_fsck_report_fn(struct reftable_fsck_info *info,
void *cb_data);
typedef void reftable_fsck_verbose_fn(const char *msg, void *cb_data);
/*
* Given a reftable stack, perform consistency checks on the stack.
*
* If an issue is encountered, the issue is reported to the callee via the
* provided 'report_fn'. If the issue is non-recoverable the flow will not
* continue. If it is recoverable, the flow will continue and further issues
* will be reported as identified.
*
* The 'verbose_fn' will be invoked to provide verbose information about
* the progress and state of the consistency checks.
*/
int reftable_fsck_check(struct reftable_stack *stack,
reftable_fsck_report_fn report_fn,
reftable_fsck_verbose_fn verbose_fn,
void *cb_data);
#endif /* REFTABLE_FSCK_H */