contrib/subversion/subversion/libsvn_fs_fs/pack.h

   1 /* pack.h : interface FSFS pack functionality
   2  *
   3  * ====================================================================
   4  *    Licensed to the Apache Software Foundation (ASF) under one
   5  *    or more contributor license agreements.  See the NOTICE file
   6  *    distributed with this work for additional information
   7  *    regarding copyright ownership.  The ASF licenses this file
   8  *    to you under the Apache License, Version 2.0 (the
   9  *    "License"); you may not use this file except in compliance
  10  *    with the License.  You may obtain a copy of the License at
  11  *
  12  *      http://www.apache.org/licenses/LICENSE-2.0
  13  *
  14  *    Unless required by applicable law or agreed to in writing,
  15  *    software distributed under the License is distributed on an
  16  *    "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
  17  *    KIND, either express or implied.  See the License for the
  18  *    specific language governing permissions and limitations
  19  *    under the License.
  20  * ====================================================================
  21  */
  22
  23 #ifndef SVN_LIBSVN_FS__PACK_H
  24 #define SVN_LIBSVN_FS__PACK_H
  25
  26 #include "fs.h"
  27
  28 /* Possibly pack the repository at PATH.  This just take full shards, and
  29    combines all the revision files into a single one, with a manifest header.
  30    If given, NOTIFY_FUNC will be called with NOTIFY_BATON to report progress.
  31    Use optional CANCEL_FUNC/CANCEL_BATON for cancellation support.
  32
  33    Existing filesystem references need not change.  */
  34 svn_error_t *
  35 svn_fs_fs__pack(svn_fs_t *fs,
  36                 svn_fs_pack_notify_t notify_func,
  37                 void *notify_baton,
  38                 svn_cancel_func_t cancel_func,
  39                 void *cancel_baton,
  40                 apr_pool_t *pool);
  41
  42 /**
  43  * For the packed revision @a rev in @a fs,  determine the offset within
  44  * the revision pack file and return it in @a rev_offset.  Use @a pool for
  45  * allocations.
  46  */
  47 svn_error_t *
  48 svn_fs_fs__get_packed_offset(apr_off_t *rev_offset,
  49                              svn_fs_t *fs,
  50                              svn_revnum_t rev,
  51                              apr_pool_t *pool);
  52
  53 /* Return the svn_dir_entry_t* objects of DIRECTORY in an APR array
  54  * allocated in RESULT_POOL with entries added in storage (on-disk) order.
  55  * FS' format will be used to pick the optimal ordering strategy.  Use
  56  * SCRATCH_POOL for temporary allocations.
  57  */
  58 apr_array_header_t *
  59 svn_fs_fs__order_dir_entries(svn_fs_t *fs,
  60                              apr_hash_t *directory,
  61                              apr_pool_t *result_pool,
  62                              apr_pool_t *scratch_pool);
  63
  64 #endif