6af23ac66c
The reftable library includes "git-compat-util.h" in order to get a POSIX-like programming environment that papers over various differences between platforms. The header also brings with it a couple of helpers specific to the Git codebase though, and over time we have started to use these helpers in the reftable library, as well. This makes it very hard to use the reftable library as a standalone library without the rest of the Git codebase, so other libraries like e.g. libgit2 cannot easily use it. But now that we have removed all calls to Git-specific functionality and have split out "compat/posix.h" as a separate header we can address this. Stop including "git-compat-util.h" and instead include "compat/posix.h" to finalize the decoupling of the reftable library from the rest of the Git codebase. The only bits which remain specific to Git are "system.h" and "system.c", which projects will have to provide. Signed-off-by: Patrick Steinhardt <ps@pks.im> Signed-off-by: Junio C Hamano <gitster@pobox.com>
109 lines
3.4 KiB
C
109 lines
3.4 KiB
C
/*
|
|
Copyright 2020 Google LLC
|
|
|
|
Use of this source code is governed by a BSD-style
|
|
license that can be found in the LICENSE file or at
|
|
https://developers.google.com/open-source/licenses/bsd
|
|
*/
|
|
|
|
#ifndef SYSTEM_H
|
|
#define SYSTEM_H
|
|
|
|
/* This header glues the reftable library to the rest of Git */
|
|
|
|
#include "compat/posix.h"
|
|
#include "compat/zlib-compat.h"
|
|
|
|
/*
|
|
* Return a random 32 bit integer. This function is expected to return
|
|
* pre-seeded data.
|
|
*/
|
|
uint32_t reftable_rand(void);
|
|
|
|
/*
|
|
* An implementation-specific temporary file. By making this specific to the
|
|
* implementation it becomes possible to tie temporary files into any kind of
|
|
* signal or atexit handlers for cleanup on abnormal situations.
|
|
*/
|
|
struct reftable_tmpfile {
|
|
const char *path;
|
|
int fd;
|
|
void *priv;
|
|
};
|
|
#define REFTABLE_TMPFILE_INIT ((struct reftable_tmpfile) { .fd = -1, })
|
|
|
|
/*
|
|
* Create a temporary file from a pattern similar to how mkstemp(3p) would.
|
|
* The `pattern` shall not be modified. On success, the structure at `out` has
|
|
* been initialized such that it is ready for use. Returns 0 on success, a
|
|
* reftable error code on error.
|
|
*/
|
|
int tmpfile_from_pattern(struct reftable_tmpfile *out, const char *pattern);
|
|
|
|
/*
|
|
* Close the temporary file's file descriptor without removing the file itself.
|
|
* This is a no-op in case the file has already been closed beforehand. Returns
|
|
* 0 on success, a reftable error code on error.
|
|
*/
|
|
int tmpfile_close(struct reftable_tmpfile *t);
|
|
|
|
/*
|
|
* Close the temporary file and delete it. This is a no-op in case the file has
|
|
* already been deleted or renamed beforehand. Returns 0 on success, a reftable
|
|
* error code on error.
|
|
*/
|
|
int tmpfile_delete(struct reftable_tmpfile *t);
|
|
|
|
/*
|
|
* Rename the temporary file to the provided path. The temporary file must be
|
|
* active. Return 0 on success, a reftable error code on error. Deactivates the
|
|
* temporary file.
|
|
*/
|
|
int tmpfile_rename(struct reftable_tmpfile *t, const char *path);
|
|
|
|
/*
|
|
* An implementation-specific file lock. Same as with `reftable_tmpfile`,
|
|
* making this specific to the implementation makes it possible to tie this
|
|
* into signal or atexit handlers such that we know to clean up stale locks on
|
|
* abnormal exits.
|
|
*/
|
|
struct reftable_flock {
|
|
const char *path;
|
|
int fd;
|
|
void *priv;
|
|
};
|
|
#define REFTABLE_FLOCK_INIT ((struct reftable_flock){ .fd = -1, })
|
|
|
|
/*
|
|
* Acquire the lock for the given target path by exclusively creating a file
|
|
* with ".lock" appended to it. If that lock exists, we wait up to `timeout_ms`
|
|
* to acquire the lock. If `timeout_ms` is 0 we don't wait, if it is negative
|
|
* we block indefinitely.
|
|
*
|
|
* Retrun 0 on success, a reftable error code on error.
|
|
*/
|
|
int flock_acquire(struct reftable_flock *l, const char *target_path,
|
|
long timeout_ms);
|
|
|
|
/*
|
|
* Close the lockfile's file descriptor without removing the lock itself. This
|
|
* is a no-op in case the lockfile has already been closed beforehand. Returns
|
|
* 0 on success, a reftable error code on error.
|
|
*/
|
|
int flock_close(struct reftable_flock *l);
|
|
|
|
/*
|
|
* Release the lock by unlinking the lockfile. This is a no-op in case the
|
|
* lockfile has already been released or committed beforehand. Returns 0 on
|
|
* success, a reftable error code on error.
|
|
*/
|
|
int flock_release(struct reftable_flock *l);
|
|
|
|
/*
|
|
* Commit the lock by renaming the lockfile into place. Returns 0 on success, a
|
|
* reftable error code on error.
|
|
*/
|
|
int flock_commit(struct reftable_flock *l);
|
|
|
|
#endif
|