/* fs_fs.h : interface to the native filesystem layer * * ==================================================================== * Copyright (c) 2000-2006 CollabNet. All rights reserved. * * This software is licensed as described in the file COPYING, which * you should have received as part of this distribution. The terms * are also available at http://subversion.tigris.org/license-1.html. * If newer versions of this license are posted there, you may use a * newer version instead, at your option. * * This software consists of voluntary contributions made by many * individuals. For exact contribution history, see the revision * history and logs, available at http://subversion.tigris.org/. * ==================================================================== */ #ifndef SVN_LIBSVN_FS__FS_FS_H #define SVN_LIBSVN_FS__FS_FS_H #include "fs.h" /* Open the fsfs filesystem pointed to by PATH and associate it with filesystem object FS. Use POOL for temporary allocations. */ svn_error_t *svn_fs_fs__open(svn_fs_t *fs, const char *path, apr_pool_t *pool); /* Copy the fsfs filesystem at SRC_PATH into a new copy at DST_PATH. Use POOL for temporary allocations. */ svn_error_t *svn_fs_fs__hotcopy(const char *src_path, const char *dst_path, apr_pool_t *pool); /* Set *NODEREV_P to the node-revision for the node ID in FS. Do any allocations in POOL. */ svn_error_t *svn_fs_fs__get_node_revision(node_revision_t **noderev_p, svn_fs_t *fs, const svn_fs_id_t *id, apr_pool_t *pool); /* Store NODEREV as the node-revision for the node whose id is ID in FS. Do any necessary temporary allocation in POOL. */ svn_error_t *svn_fs_fs__put_node_revision(svn_fs_t *fs, const svn_fs_id_t *id, node_revision_t *noderev, apr_pool_t *pool); /* Set *YOUNGEST to the youngest revision in filesystem FS. Do any temporary allocation in POOL. */ svn_error_t *svn_fs_fs__youngest_rev(svn_revnum_t *youngest, svn_fs_t *fs, apr_pool_t *pool); /* Set *ROOT_ID to the node-id for the root of revision REV in filesystem FS. Do any allocations in POOL. */ svn_error_t *svn_fs_fs__rev_get_root(svn_fs_id_t **root_id, svn_fs_t *fs, svn_revnum_t rev, apr_pool_t *pool); /* Set *ENTRIES to an apr_hash_t of dirent structs that contain the directory entries of node-revision NODEREV in filesystem FS. Use POOL for temporary allocations. The returned hash does *not* live in POOL, and becomes invalid on the next call to this function. If you need it to live longer, copy it with svn_fs_fs__copy_dir_entries. */ svn_error_t *svn_fs_fs__rep_contents_dir(apr_hash_t **entries, svn_fs_t *fs, node_revision_t *noderev, apr_pool_t *pool); /* Return a copy of the directory hash ENTRIES in POOL. Use this to copy the result of svn_fs_fs__rep_contents_dir into a predictable place so that doesn't become invalid before it's no longer needed. */ apr_hash_t *svn_fs_fs__copy_dir_entries(apr_hash_t *entries, apr_pool_t *pool); /* Set *CONTENTS to be a readable svn_stream_t that receives the text representation of node-revision NODEREV as seen in filesystem FS. Use POOL for temporary allocations. */ svn_error_t *svn_fs_fs__get_contents(svn_stream_t **contents, svn_fs_t *fs, node_revision_t *noderev, apr_pool_t *pool); /* Set *STREAM_P to a delta stream turning the contents of the file SOURCE into the contents of the file TARGET, allocated in POOL. If SOURCE is null, the empty string will be used. */ svn_error_t *svn_fs_fs__get_file_delta_stream(svn_txdelta_stream_t **stream_p, svn_fs_t *fs, node_revision_t *source, node_revision_t *target, apr_pool_t *pool); /* Set *PROPLIST to be an apr_hash_t containing the property list of node-revision NODEREV as seen in filesystem FS. Use POOL for temporary allocations. */ svn_error_t *svn_fs_fs__get_proplist(apr_hash_t **proplist, svn_fs_t *fs, node_revision_t *noderev, apr_pool_t *pool); /* Set the revision property list of revision REV in filesystem FS to PROPLIST. Use POOL for temporary allocations. */ svn_error_t *svn_fs_fs__set_revision_proplist(svn_fs_t *fs, svn_revnum_t rev, apr_hash_t *proplist, apr_pool_t *pool); /* Set *PROPLIST to be an apr_hash_t containing the property list of revision REV as seen in filesystem FS. Use POOL for temporary allocations. */ svn_error_t *svn_fs_fs__revision_proplist(apr_hash_t **proplist, svn_fs_t *fs, svn_revnum_t rev, apr_pool_t *pool); /* Set *LENGTH to the be fulltext length of the node revision specified by NODEREV. Use POOL for temporary allocations. */ svn_error_t *svn_fs_fs__file_length(svn_filesize_t *length, node_revision_t *noderev, apr_pool_t *pool); /* Return TRUE if the representation keys in A and B both point to the same representation, else return FALSE. */ svn_boolean_t svn_fs_fs__noderev_same_rep_key(representation_t *a, representation_t *b); /* Return a copy of the representation REP allocated from POOL. */ representation_t *svn_fs_fs__rep_copy(representation_t *rep, apr_pool_t *pool); /* Return the record MD5 checksum of the text representation of NODREV into DIGEST, allocating from POOL. If no stored checksum is available, put all 0's into DIGEST. */ svn_error_t *svn_fs_fs__file_checksum(unsigned char digest[], node_revision_t *noderev, apr_pool_t *pool); /* Find the paths which were changed in revision REV of filesystem FS and store them in *CHANGED_PATHS_P. Cached copyfrom information will be stored in *COPYFROM_CACHE. Get any temporary allocations from POOL. */ svn_error_t *svn_fs_fs__paths_changed(apr_hash_t **changed_paths_p, svn_fs_t *fs, svn_revnum_t rev, apr_hash_t *copyfrom_cache, apr_pool_t *pool); /* Create a new transaction in filesystem FS, based on revision REV, and store it in *TXN_P. Allocate all necessary variables from POOL. */ svn_error_t *svn_fs_fs__create_txn (svn_fs_txn_t **txn_p, svn_fs_t *fs, svn_revnum_t rev, apr_pool_t *pool); /* Set the transaction property NAME to the value VALUE in transaction TXN. Perform temporary allocations from POOL. */ svn_error_t *svn_fs_fs__change_txn_prop(svn_fs_txn_t *txn, const char *name, const svn_string_t *value, apr_pool_t *pool); /* Store a transaction record in *TXN_P for the transaction identified by TXN_ID in filesystem FS. Allocate everything from POOL. */ svn_error_t *svn_fs_fs__get_txn(transaction_t **txn_p, svn_fs_t *fs, const char *txn_id, apr_pool_t *pool); /* Create an entirely new mutable node in the filesystem FS, whose node-revision is NODEREV. Set *ID_P to the new node revision's ID. Use POOL for any temporary allocation. COPY_ID is the copy_id to use in the node revision ID. TXN_ID is the Subversion transaction under which this occurs. */ svn_error_t *svn_fs_fs__create_node(const svn_fs_id_t **id_p, svn_fs_t *fs, node_revision_t *noderev, const char *copy_id, const char *txn_id, apr_pool_t *pool); /* Remove all references to the transaction TXN_ID from filesystem FS. Temporary allocations are from POOL. */ svn_error_t *svn_fs_fs__purge_txn(svn_fs_t *fs, const char *txn_id, apr_pool_t *pool); /* Add or set in filesystem FS, transaction TXN_ID, in directory PARENT_NODEREV a directory entry for NAME pointing to ID of type KIND. Allocations are done in POOL. */ svn_error_t *svn_fs_fs__set_entry(svn_fs_t *fs, const char *txn_id, node_revision_t *parent_noderev, const char *name, const svn_fs_id_t *id, svn_node_kind_t kind, apr_pool_t *pool); /* Add a change to the changes record for filesystem FS in transaction TXN_ID. Mark path PATH, having node-id ID, as changed according to the type in CHANGE_KIND. If the text representation was changed set TEXT_MOD to TRUE, and likewise for PROP_MOD. If this change was the result of a copy, set COPYFROM_REV and COPYFROM_PATH to the revision and path of the copy source, otherwise they should be set to SVN_INVALID_REVNUM and NULL. Perform any temporary allocations from POOL. */ svn_error_t *svn_fs_fs__add_change(svn_fs_t *fs, const char *txn_id, const char *path, const svn_fs_id_t *id, svn_fs_path_change_kind_t change_kind, svn_boolean_t text_mod, svn_boolean_t prop_mod, svn_revnum_t copyfrom_rev, const char *copyfrom_path, apr_pool_t *pool); /* Return a writable stream in *STREAM that allows storing the text representation of node-revision NODEREV in filesystem FS. Allocations are from POOL. */ svn_error_t *svn_fs_fs__set_contents(svn_stream_t **stream, svn_fs_t *fs, node_revision_t *noderev, apr_pool_t *pool); /* Create a node revision in FS which is an immediate successor of OLD_ID, whose contents are NEW_NR. Set *NEW_ID_P to the new node revision's ID. Use POOL for any temporary allocation. COPY_ID, if non-NULL, is a key into the `copies' table, and indicates that this new node is being created as the result of a copy operation, and specifically which operation that was. If COPY_ID is NULL, then re-use the copy ID from the predecessor node. TXN_ID is the Subversion transaction under which this occurs. After this call, the deltification code assumes that the new node's contents will change frequently, and will avoid representing other nodes as deltas against this node's contents. */ svn_error_t *svn_fs_fs__create_successor(const svn_fs_id_t **new_id_p, svn_fs_t *fs, const svn_fs_id_t *old_idp, node_revision_t *new_noderev, const char *copy_id, const char *txn_id, apr_pool_t *pool); /* Write a new property list PROPLIST for node-revision NODEREV in filesystem FS. Perform any temporary allocations in POOL. */ svn_error_t *svn_fs_fs__set_proplist(svn_fs_t *fs, node_revision_t *noderev, apr_hash_t *proplist, apr_pool_t *pool); /* Commit the transaction TXN in filesystem FS and return its new revision number in *REV. If the transaction is out of date, return the error SVN_ERR_FS_TXN_OUT_OF_DATE. Use POOL for temporary allocations. */ svn_error_t *svn_fs_fs__commit(svn_revnum_t *new_rev_p, svn_fs_t *fs, svn_fs_txn_t *txn, apr_pool_t *pool); /* Return the next available copy_id in *COPY_ID for the transaction TXN_ID in filesystem FS. Allocate space in POOL. */ svn_error_t *svn_fs_fs__reserve_copy_id(const char **copy_id, svn_fs_t *fs, const char *txn_id, apr_pool_t *pool); /* Create a fs_fs fileysystem referenced by FS at path PATH. Get any temporary allocations from POOL. */ svn_error_t *svn_fs_fs__create(svn_fs_t *fs, const char *path, apr_pool_t *pool); /* Store the uuid of the repository FS in *UUID. Allocate space in POOL. */ svn_error_t *svn_fs_fs__get_uuid(svn_fs_t *fs, const char **uuid, apr_pool_t *pool); /* Set the uuid of repository FS to UUID. Perform temporary allocations in POOL. */ svn_error_t *svn_fs_fs__set_uuid(svn_fs_t *fs, const char *uuid, apr_pool_t *pool); /* Set *NAMES_P to an array of names which are all the active transactions in filesystem FS. Allocate the array from POOL. */ svn_error_t *svn_fs_fs__list_transactions(apr_array_header_t **names_p, svn_fs_t *fs, apr_pool_t *pool); /* Open the transaction named NAME in filesystem FS. Set *TXN_P to * the transaction. If there is no such transaction, return ` * SVN_ERR_FS_NO_SUCH_TRANSACTION. Allocate the new transaction in * POOL. */ svn_error_t *svn_fs_fs__open_txn(svn_fs_txn_t **txn_p, svn_fs_t *fs, const char *name, apr_pool_t *pool); /* Return the property list from transaction TXN and store it in *PROPLIST. Allocate the property list from POOL. */ svn_error_t *svn_fs_fs__txn_proplist(apr_hash_t **proplist, svn_fs_txn_t *txn, apr_pool_t *pool); /* Delete the mutable node-revision referenced by ID, along with any mutable props or directory contents associated with it. Perform temporary allocations in POOL. */ svn_error_t *svn_fs_fs__delete_node_revision(svn_fs_t *fs, const svn_fs_id_t *id, apr_pool_t *pool); /* Find the paths which were changed in transaction TXN_ID of filesystem FS and store them in *CHANGED_PATHS_P. Cached copyfrom information will be stored in COPYFROM_CACHE if it is non-NULL. Get any temporary allocations from POOL. */ svn_error_t *svn_fs_fs__txn_changes_fetch(apr_hash_t **changes, svn_fs_t *fs, const char *txn_id, apr_hash_t *copyfrom_cache, apr_pool_t *pool); /* Move a file into place from OLD_FILENAME in the transactions directory to its final location NEW_FILENAME in the repository. On Unix, match the permissions of the new file to the permissions of PERMS_REFERENCE. Temporary allocations are from POOL. */ svn_error_t *svn_fs_fs__move_into_place(const char *old_filename, const char *new_filename, const char *perms_reference, apr_pool_t *pool); /* Match the perms on FILENAME to the PERMS_REFERENCE file if we're not on a win32 system. On win32, this is a no-op. */ svn_error_t *svn_fs_fs__dup_perms(const char *filename, const char *perms_reference, apr_pool_t *pool); /* Return the path to the file containing revision REV in FS. Allocate the new char * from POOL. */ const char *svn_fs_fs__path_rev(svn_fs_t *fs, svn_revnum_t rev, apr_pool_t *pool); /* Obtain a write lock on the filesystem FS in a subpool of POOL, call BODY with BATON and that subpool, destroy the subpool (releasing the write lock) and return what BODY returned. */ svn_error_t * svn_fs_fs__with_write_lock(svn_fs_t *fs, svn_error_t *(*body)(void *baton, apr_pool_t *pool), void *baton, apr_pool_t *pool); /* Find the value of the property named PROPNAME in transaction TXN. Return the contents in *VALUE_P. The contents will be allocated from POOL. */ svn_error_t *svn_fs_fs__revision_prop(svn_string_t **value_p, svn_fs_t *fs, svn_revnum_t rev, const char *propname, apr_pool_t *pool); /* Change, add, or delete a property on a revision REV in filesystem FS. NAME gives the name of the property, and value, if non-NULL, gives the new contents of the property. If value is NULL, then the property will be deleted. Do any temporary allocation in POOL. */ svn_error_t *svn_fs_fs__change_rev_prop(svn_fs_t *fs, svn_revnum_t rev, const char *name, const svn_string_t *value, apr_pool_t *pool); /* Retrieve information about the Subversion transaction SVN_TXN from the `transactions' table of FS, allocating from POOL. Set *ROOT_ID_P to the ID of the transaction's root directory. Set *BASE_ROOT_ID_P to the ID of the root directory of the transaction's base revision. If there is no such transaction, SVN_ERR_FS_NO_SUCH_TRANSACTION is the error returned. Returns SVN_ERR_FS_TRANSACTION_NOT_MUTABLE if TXN_NAME refers to a transaction that has already been committed. Allocate *ROOT_ID_P and *BASE_ROOT_ID_P in POOL. */ svn_error_t *svn_fs_fs__get_txn_ids(const svn_fs_id_t **root_id_p, const svn_fs_id_t **base_root_id_p, svn_fs_t *fs, const char *txn_name, apr_pool_t *pool); /* Begin a new transaction in filesystem FS, based on existing revision REV. The new transaction is returned in *TXN_P. Allocate the new transaction structure from POOL. */ svn_error_t *svn_fs_fs__begin_txn(svn_fs_txn_t **txn_p, svn_fs_t *fs, svn_revnum_t rev, apr_uint32_t flags, apr_pool_t *pool); /* Abort the existing transaction TXN, performing any temporary allocations in POOL. */ svn_error_t *svn_fs_fs__abort_txn(svn_fs_txn_t *txn, apr_pool_t *pool); /* Find the value of the property named PROPNAME in transaction TXN. Return the contents in *VALUE_P. The contents will be allocated from POOL. */ svn_error_t *svn_fs_fs__txn_prop(svn_string_t **value_p, svn_fs_txn_t *txn, const char *propname, apr_pool_t *pool); #endif