1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
|
#ifndef ODB_TRANSACTION_H
#define ODB_TRANSACTION_H
#include "gettext.h"
#include "odb.h"
/*
* Options controlling how odb_transaction_write_pack() ingests a packfile.
*/
struct odb_transaction_write_pack_opts {
/*
* Optional fsck severity configuration to apply when incoming objects
* are verified.
*/
const char *fsck_msg_types;
/*
* Path to an alternative shallow file describing the shallow boundaries
* to honor while ingesting the pack.
*/
const char *shallow_file;
/*
* The max size in bytes of the incoming packfile allowed. No limit is
* enforced when set to 0.
*/
off_t max_input_size;
/*
* Whether the validity of incoming objects should be verified.
*/
int fsck_objects;
/*
* Whether to reject an incoming packfile if it is "thin".
*/
int reject_thin;
/*
* Optional file descriptor for reporting progress and errors. Set to 0
* for none.
*/
int err_fd;
/*
* Suppresses progress reporting.
*/
int quiet;
};
/*
* A transaction may be started for an object database prior to writing new
* objects via odb_transaction_begin(). These objects are not committed until
* odb_transaction_commit() is invoked. Only a single transaction may be pending
* at a time.
*
* Each ODB source is expected to implement its own transaction handling.
*/
struct odb_transaction {
/* The ODB source the transaction is opened against. */
struct odb_source *source;
/*
* The ODB source specific callback invoked to commit a transaction.
* Returns 0 on success, a negative error code otherwise.
*/
int (*commit)(struct odb_transaction *transaction);
/*
* Optional ODB source specific callback invoked when the transaction
* needs to perform any deferred cleanup after objects have been
* committed. Returns 0 on success, a negative error code otherwise.
*/
int (*finalize)(struct odb_transaction *transaction);
/*
* This callback is expected to write the given object stream into
* the ODB transaction.
*
* The resulting object ID shall be written into the out pointer. The
* callback is expected to return 0 on success, a negative error code
* otherwise.
*/
int (*write_object_stream)(struct odb_transaction *transaction,
struct odb_stream *stream,
struct object_id *oid);
/*
* This callback is expected to ingest the packfile readable via
* `pack_fd` into the transaction. Returns 0 on success, a negative
* error code otherwise. On failure, a human-readable description is
* appended to `err_msg`.
*/
int (*write_pack)(struct odb_transaction *transaction, int pack_fd,
struct strbuf *err_msg,
const struct odb_transaction_write_pack_opts *opts);
/*
* This callback is expected to populate the provided strvec with the
* environment variables that a child process should inherit so that its
* object writes participate in the transaction. Returns 0 on success, a
* negative error code otherwise.
*/
int (*env)(struct odb_transaction *transaction, struct strvec *env);
};
/* Flags used to configure an ODB transaction. */
enum odb_transaction_flags {
/* Configures the transaction for use with git-receive-pack(1). */
ODB_TRANSACTION_RECEIVE = (1 << 0),
};
/*
* Starts an ODB transaction and returns it via `out`. Subsequent objects are
* written to the transaction and not committed until odb_transaction_commit()
* is invoked on the transaction. Returns 0 on success and a negative value on
* error. Note that it is considered an error to start a new transaction if the
* ODB already has an inflight transaction pending.
*/
int odb_transaction_begin(struct object_database *odb,
struct odb_transaction **out,
enum odb_transaction_flags flags);
static inline void odb_transaction_begin_or_die(struct object_database *odb,
struct odb_transaction **out,
enum odb_transaction_flags flags)
{
if (odb_transaction_begin(odb, out, flags))
die(_("failed to start ODB transaction"));
}
/*
* Commits an ODB transaction making the written objects visible. Returns 0 on
* success, a negative error code otherwise. Note that, if the specified
* transaction is NULL, the function is a no-op and no error is returned.
*/
int odb_transaction_commit(struct odb_transaction *transaction);
/*
* Finalizes an ODB transaction, performing any deferred cleanup and freeing it.
* Must be called for every successfully started transaction. Note that, if the
* specified transaction is NULL, the function is a no-op. Returns 0 on success,
* a negative error code otherwise.
*/
int odb_transaction_finalize(struct odb_transaction *transaction);
static inline void odb_transaction_commit_and_finalize_or_die(struct odb_transaction *transaction)
{
if (odb_transaction_commit(transaction))
die(_("failed to commit ODB transaction"));
if (odb_transaction_finalize(transaction))
die(_("failed to finalize ODB transaction"));
}
/*
* Writes the object in the provided stream into the transaction. The resulting
* object ID is written into the out pointer. Returns 0 on success, a negative
* error code otherwise.
*/
int odb_transaction_write_object_stream(struct odb_transaction *transaction,
struct odb_stream *stream,
struct object_id *oid);
/*
* Ingests the packfile readable via `pack_fd` into the transaction. Returns 0
* on success, a negative error code otherwise. On failure, a human-readable
* description is appended to `err_msg`.
*/
int odb_transaction_write_pack(struct odb_transaction *transaction, int pack_fd,
struct strbuf *err_msg,
const struct odb_transaction_write_pack_opts *opts);
/*
* Populates the provided strvec with the environment variables that a child
* process should inherit so that its object writes participate in the
* transaction, suitable for using via child_process.env. Returns 0 on success,
* a negative error code otherwise. Note that, if the specified transaction is
* NULL, the function is a no-op and no error is returned.
*/
int odb_transaction_env(struct odb_transaction *transaction, struct strvec *env);
#endif
|
