1#ifndef REFS_H 2#define REFS_H 3 4struct ref_lock { 5 char *ref_name; 6 char *orig_ref_name; 7 struct lock_file *lk; 8 unsigned char old_sha1[20]; 9 int lock_fd; 10 int force_write; 11}; 12 13/* 14 * A ref_transaction represents a collection of ref updates 15 * that should succeed or fail together. 16 * 17 * Calling sequence 18 * ---------------- 19 * - Allocate and initialize a `struct ref_transaction` by calling 20 * `ref_transaction_begin()`. 21 * 22 * - List intended ref updates by calling functions like 23 * `ref_transaction_update()` and `ref_transaction_create()`. 24 * 25 * - Call `ref_transaction_commit()` to execute the transaction. 26 * If this succeeds, the ref updates will have taken place and 27 * the transaction cannot be rolled back. 28 * 29 * - At any time call `ref_transaction_free()` to discard the 30 * transaction and free associated resources. In particular, 31 * this rolls back the transaction if it has not been 32 * successfully committed. 33 * 34 * Error handling 35 * -------------- 36 * 37 * On error, transaction functions append a message about what 38 * went wrong to the 'err' argument. The message mentions what 39 * ref was being updated (if any) when the error occurred so it 40 * can be passed to 'die' or 'error' as-is. 41 * 42 * The message is appended to err without first clearing err. 43 * err will not be '\n' terminated. 44 */ 45struct ref_transaction; 46 47/* 48 * Bit values set in the flags argument passed to each_ref_fn(): 49 */ 50 51/* Reference is a symbolic reference. */ 52#define REF_ISSYMREF 0x01 53 54/* Reference is a packed reference. */ 55#define REF_ISPACKED 0x02 56 57/* 58 * Reference cannot be resolved to an object name: dangling symbolic 59 * reference (directly or indirectly), corrupt reference file, 60 * reference exists but name is bad, or symbolic reference refers to 61 * ill-formatted reference name. 62 */ 63#define REF_ISBROKEN 0x04 64 65/* 66 * Reference name is not well formed. 67 * 68 * See git-check-ref-format(1) for the definition of well formed ref names. 69 */ 70#define REF_BAD_NAME 0x08 71 72/* 73 * The signature for the callback function for the for_each_*() 74 * functions below. The memory pointed to by the refname and sha1 75 * arguments is only guaranteed to be valid for the duration of a 76 * single callback invocation. 77 */ 78typedef int each_ref_fn(const char *refname, 79 const unsigned char *sha1, int flags, void *cb_data); 80 81/* 82 * The following functions invoke the specified callback function for 83 * each reference indicated. If the function ever returns a nonzero 84 * value, stop the iteration and return that value. Please note that 85 * it is not safe to modify references while an iteration is in 86 * progress, unless the same callback function invocation that 87 * modifies the reference also returns a nonzero value to immediately 88 * stop the iteration. 89 */ 90extern int head_ref(each_ref_fn, void *); 91extern int for_each_ref(each_ref_fn, void *); 92extern int for_each_ref_in(const char *, each_ref_fn, void *); 93extern int for_each_tag_ref(each_ref_fn, void *); 94extern int for_each_branch_ref(each_ref_fn, void *); 95extern int for_each_remote_ref(each_ref_fn, void *); 96extern int for_each_replace_ref(each_ref_fn, void *); 97extern int for_each_glob_ref(each_ref_fn, const char *pattern, void *); 98extern int for_each_glob_ref_in(each_ref_fn, const char *pattern, const char* prefix, void *); 99 100extern int head_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data); 101extern int for_each_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data); 102extern int for_each_ref_in_submodule(const char *submodule, const char *prefix, 103 each_ref_fn fn, void *cb_data); 104extern int for_each_tag_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data); 105extern int for_each_branch_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data); 106extern int for_each_remote_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data); 107 108extern int head_ref_namespaced(each_ref_fn fn, void *cb_data); 109extern int for_each_namespaced_ref(each_ref_fn fn, void *cb_data); 110 111static inline const char *has_glob_specials(const char *pattern) 112{ 113 return strpbrk(pattern, "?*["); 114} 115 116/* can be used to learn about broken ref and symref */ 117extern int for_each_rawref(each_ref_fn, void *); 118 119extern void warn_dangling_symref(FILE *fp, const char *msg_fmt, const char *refname); 120extern void warn_dangling_symrefs(FILE *fp, const char *msg_fmt, const struct string_list *refnames); 121 122/* 123 * Lock the packed-refs file for writing. Flags is passed to 124 * hold_lock_file_for_update(). Return 0 on success. 125 * Errno is set to something meaningful on error. 126 */ 127extern int lock_packed_refs(int flags); 128 129/* 130 * Add a reference to the in-memory packed reference cache. This may 131 * only be called while the packed-refs file is locked (see 132 * lock_packed_refs()). To actually write the packed-refs file, call 133 * commit_packed_refs(). 134 */ 135extern void add_packed_ref(const char *refname, const unsigned char *sha1); 136 137/* 138 * Write the current version of the packed refs cache from memory to 139 * disk. The packed-refs file must already be locked for writing (see 140 * lock_packed_refs()). Return zero on success. 141 * Sets errno to something meaningful on error. 142 */ 143extern int commit_packed_refs(void); 144 145/* 146 * Rollback the lockfile for the packed-refs file, and discard the 147 * in-memory packed reference cache. (The packed-refs file will be 148 * read anew if it is needed again after this function is called.) 149 */ 150extern void rollback_packed_refs(void); 151 152/* 153 * Flags for controlling behaviour of pack_refs() 154 * PACK_REFS_PRUNE: Prune loose refs after packing 155 * PACK_REFS_ALL: Pack _all_ refs, not just tags and already packed refs 156 */ 157#define PACK_REFS_PRUNE 0x0001 158#define PACK_REFS_ALL 0x0002 159 160/* 161 * Write a packed-refs file for the current repository. 162 * flags: Combination of the above PACK_REFS_* flags. 163 */ 164int pack_refs(unsigned int flags); 165 166extern int repack_without_refs(const char **refnames, int n, 167 struct strbuf *err); 168 169extern int ref_exists(const char *); 170 171extern int is_branch(const char *refname); 172 173/* 174 * If refname is a non-symbolic reference that refers to a tag object, 175 * and the tag can be (recursively) dereferenced to a non-tag object, 176 * store the SHA1 of the referred-to object to sha1 and return 0. If 177 * any of these conditions are not met, return a non-zero value. 178 * Symbolic references are considered unpeelable, even if they 179 * ultimately resolve to a peelable tag. 180 */ 181extern int peel_ref(const char *refname, unsigned char *sha1); 182 183/* 184 * Flags controlling lock_any_ref_for_update(), ref_transaction_update(), 185 * ref_transaction_create(), etc. 186 * REF_NODEREF: act on the ref directly, instead of dereferencing 187 * symbolic references. 188 * REF_DELETING: tolerate broken refs 189 * 190 * Flags >= 0x100 are reserved for internal use. 191 */ 192#define REF_NODEREF 0x01 193#define REF_DELETING 0x02 194/* 195 * This function sets errno to something meaningful on failure. 196 */ 197extern struct ref_lock *lock_any_ref_for_update(const char *refname, 198 const unsigned char *old_sha1, 199 int flags, int *type_p); 200 201/* 202 * Setup reflog before using. Set errno to something meaningful on failure. 203 */ 204int log_ref_setup(const char *refname, char *logfile, int bufsize); 205 206/** Reads log for the value of ref during at_time. **/ 207extern int read_ref_at(const char *refname, unsigned int flags, 208 unsigned long at_time, int cnt, 209 unsigned char *sha1, char **msg, 210 unsigned long *cutoff_time, int *cutoff_tz, int *cutoff_cnt); 211 212/** Check if a particular reflog exists */ 213extern int reflog_exists(const char *refname); 214 215/** Delete a reflog */ 216extern int delete_reflog(const char *refname); 217 218/* iterate over reflog entries */ 219typedef int each_reflog_ent_fn(unsigned char *osha1, unsigned char *nsha1, const char *, unsigned long, int, const char *, void *); 220int for_each_reflog_ent(const char *refname, each_reflog_ent_fn fn, void *cb_data); 221int for_each_reflog_ent_reverse(const char *refname, each_reflog_ent_fn fn, void *cb_data); 222 223/* 224 * Calls the specified function for each reflog file until it returns nonzero, 225 * and returns the value 226 */ 227extern int for_each_reflog(each_ref_fn, void *); 228 229#define REFNAME_ALLOW_ONELEVEL 1 230#define REFNAME_REFSPEC_PATTERN 2 231 232/* 233 * Return 0 iff refname has the correct format for a refname according 234 * to the rules described in Documentation/git-check-ref-format.txt. 235 * If REFNAME_ALLOW_ONELEVEL is set in flags, then accept one-level 236 * reference names. If REFNAME_REFSPEC_PATTERN is set in flags, then 237 * allow a "*" wildcard character in place of one of the name 238 * components. No leading or repeated slashes are accepted. 239 */ 240extern int check_refname_format(const char *refname, int flags); 241 242extern const char *prettify_refname(const char *refname); 243extern char *shorten_unambiguous_ref(const char *refname, int strict); 244 245/** rename ref, return 0 on success **/ 246extern int rename_ref(const char *oldref, const char *newref, const char *logmsg); 247 248/** 249 * Resolve refname in the nested "gitlink" repository that is located 250 * at path. If the resolution is successful, return 0 and set sha1 to 251 * the name of the object; otherwise, return a non-zero value. 252 */ 253extern int resolve_gitlink_ref(const char *path, const char *refname, unsigned char *sha1); 254 255enum action_on_err { 256 UPDATE_REFS_MSG_ON_ERR, 257 UPDATE_REFS_DIE_ON_ERR, 258 UPDATE_REFS_QUIET_ON_ERR 259}; 260 261/* 262 * Begin a reference transaction. The reference transaction must 263 * be freed by calling ref_transaction_free(). 264 */ 265struct ref_transaction *ref_transaction_begin(struct strbuf *err); 266 267/* 268 * The following functions add a reference check or update to a 269 * ref_transaction. In all of them, refname is the name of the 270 * reference to be affected. The functions make internal copies of 271 * refname and msg, so the caller retains ownership of these parameters. 272 * flags can be REF_NODEREF; it is passed to update_ref_lock(). 273 */ 274 275/* 276 * Add a reference update to transaction. new_sha1 is the value that 277 * the reference should have after the update, or null_sha1 if it should 278 * be deleted. If have_old is true, then old_sha1 holds the value 279 * that the reference should have had before the update, or zeros if 280 * it must not have existed beforehand. 281 * Function returns 0 on success and non-zero on failure. A failure to update 282 * means that the transaction as a whole has failed and will need to be 283 * rolled back. 284 */ 285int ref_transaction_update(struct ref_transaction *transaction, 286 const char *refname, 287 const unsigned char *new_sha1, 288 const unsigned char *old_sha1, 289 int flags, int have_old, const char *msg, 290 struct strbuf *err); 291 292/* 293 * Add a reference creation to transaction. new_sha1 is the value 294 * that the reference should have after the update; it must not be the 295 * null SHA-1. It is verified that the reference does not exist 296 * already. 297 * Function returns 0 on success and non-zero on failure. A failure to create 298 * means that the transaction as a whole has failed and will need to be 299 * rolled back. 300 */ 301int ref_transaction_create(struct ref_transaction *transaction, 302 const char *refname, 303 const unsigned char *new_sha1, 304 int flags, const char *msg, 305 struct strbuf *err); 306 307/* 308 * Add a reference deletion to transaction. If have_old is true, then 309 * old_sha1 holds the value that the reference should have had before 310 * the update (which must not be the null SHA-1). 311 * Function returns 0 on success and non-zero on failure. A failure to delete 312 * means that the transaction as a whole has failed and will need to be 313 * rolled back. 314 */ 315int ref_transaction_delete(struct ref_transaction *transaction, 316 const char *refname, 317 const unsigned char *old_sha1, 318 int flags, int have_old, const char *msg, 319 struct strbuf *err); 320 321/* 322 * Commit all of the changes that have been queued in transaction, as 323 * atomically as possible. 324 * 325 * Returns 0 for success, or one of the below error codes for errors. 326 */ 327/* Naming conflict (for example, the ref names A and A/B conflict). */ 328#define TRANSACTION_NAME_CONFLICT -1 329/* All other errors. */ 330#define TRANSACTION_GENERIC_ERROR -2 331int ref_transaction_commit(struct ref_transaction *transaction, 332 struct strbuf *err); 333 334/* 335 * Free an existing transaction and all associated data. 336 */ 337void ref_transaction_free(struct ref_transaction *transaction); 338 339/** Lock a ref and then write its file */ 340int update_ref(const char *action, const char *refname, 341 const unsigned char *sha1, const unsigned char *oldval, 342 int flags, enum action_on_err onerr); 343 344extern int parse_hide_refs_config(const char *var, const char *value, const char *); 345extern int ref_is_hidden(const char *); 346 347enum expire_reflog_flags { 348 EXPIRE_REFLOGS_DRY_RUN = 1 << 0, 349 EXPIRE_REFLOGS_UPDATE_REF = 1 << 1, 350 EXPIRE_REFLOGS_VERBOSE = 1 << 2, 351 EXPIRE_REFLOGS_REWRITE = 1 << 3 352}; 353 354/* 355 * The following interface is used for reflog expiration. The caller 356 * calls reflog_expire(), supplying it with three callback functions, 357 * of the following types. The callback functions define the 358 * expiration policy that is desired. 359 * 360 * reflog_expiry_prepare_fn -- Called once after the reference is 361 * locked. 362 * 363 * reflog_expiry_should_prune_fn -- Called once for each entry in the 364 * existing reflog. It should return true iff that entry should be 365 * pruned. 366 * 367 * reflog_expiry_cleanup_fn -- Called once before the reference is 368 * unlocked again. 369 */ 370typedef void reflog_expiry_prepare_fn(const char *refname, 371 const unsigned char *sha1, 372 void *cb_data); 373typedef int reflog_expiry_should_prune_fn(unsigned char *osha1, 374 unsigned char *nsha1, 375 const char *email, 376 unsigned long timestamp, int tz, 377 const char *message, void *cb_data); 378typedef void reflog_expiry_cleanup_fn(void *cb_data); 379 380/* 381 * Expire reflog entries for the specified reference. sha1 is the old 382 * value of the reference. flags is a combination of the constants in 383 * enum expire_reflog_flags. The three function pointers are described 384 * above. On success, return zero. 385 */ 386extern int reflog_expire(const char *refname, const unsigned char *sha1, 387 unsigned int flags, 388 reflog_expiry_prepare_fn prepare_fn, 389 reflog_expiry_should_prune_fn should_prune_fn, 390 reflog_expiry_cleanup_fn cleanup_fn, 391 void *policy_cb_data); 392 393#endif /* REFS_H */