1
0
Fork 0
mirror of https://github.com/git/git.git synced 2024-06-03 14:36:10 +02:00
git/replace-object.h
Derrick Stolee f1178380ac replace-objects: create wrapper around setting
The 'read_replace_objects' constant is initialized by git_default_config
(if core.useReplaceRefs is disabled) and within setup_git_env (if
GIT_NO_REPLACE_OBJECTS) is set. To ensure that this variable cannot be
set accidentally in other places, wrap it in a replace_refs_enabled()
method.

Since we still assign this global in config.c, we are not able to remove
the global scope of this variable and make it a static within
replace-object.c. This will happen in a later change which will also
prevent the variable from being read before it is initialized.

Centralizing read access to the variable is an important first step.

Signed-off-by: Derrick Stolee <derrickstolee@github.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2023-06-12 13:34:55 -07:00

72 lines
2.4 KiB
C

#ifndef REPLACE_OBJECT_H
#define REPLACE_OBJECT_H
#include "oidmap.h"
#include "repository.h"
#include "object-store.h"
/*
* Do replace refs need to be checked this run? This variable is
* initialized to true unless --no-replace-object is used or
* $GIT_NO_REPLACE_OBJECTS is set, but is set to false by some
* commands that do not want replace references to be active.
*/
extern int read_replace_refs;
struct replace_object {
struct oidmap_entry original;
struct object_id replacement;
};
void prepare_replace_object(struct repository *r);
/*
* This internal function is only declared here for the benefit of
* lookup_replace_object(). Please do not call it directly.
*/
const struct object_id *do_lookup_replace_object(struct repository *r,
const struct object_id *oid);
/*
* Some commands disable replace-refs unconditionally, and otherwise each
* repository could alter the core.useReplaceRefs config value.
*
* Return 1 if and only if all of the following are true:
*
* a. disable_replace_refs() has not been called.
* b. GIT_NO_REPLACE_OBJECTS is unset or zero.
* c. the given repository does not have core.useReplaceRefs=false.
*/
int replace_refs_enabled(struct repository *r);
/*
* If object sha1 should be replaced, return the replacement object's
* name (replaced recursively, if necessary). The return value is
* either sha1 or a pointer to a permanently-allocated value. When
* object replacement is suppressed, always return sha1.
*
* Note: some thread debuggers might point a data race on the
* replace_map_initialized reading in this function. However, we know there's no
* problem in the value being updated by one thread right after another one read
* it here (and it should be written to only once, anyway).
*/
static inline const struct object_id *lookup_replace_object(struct repository *r,
const struct object_id *oid)
{
if (!replace_refs_enabled(r) ||
(r->objects->replace_map_initialized &&
r->objects->replace_map->map.tablesize == 0))
return oid;
return do_lookup_replace_object(r, oid);
}
/*
* Some commands override config and environment settings for using
* replace references. Use this method to disable the setting and ensure
* those other settings will not override this choice. This applies
* globally to all in-process repositories.
*/
void disable_replace_refs(void);
#endif /* REPLACE_OBJECT_H */