pack.h revision 309512 
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   when required by the repository format.
31
32   MAX_MEM limits the size of in-memory data structures needed for reordering
33   items in format 7 repositories.  0 means use the built-in default.
34
35   If given, NOTIFY_FUNC will be called with NOTIFY_BATON to report progress.
36   Use optional CANCEL_FUNC/CANCEL_BATON for cancellation support.
37
38   Existing filesystem references need not change.  */
39svn_error_t *
40svn_fs_fs__pack(svn_fs_t *fs,
41                apr_size_t max_mem,
42                svn_fs_pack_notify_t notify_func,
43                void *notify_baton,
44                svn_cancel_func_t cancel_func,
45                void *cancel_baton,
46                apr_pool_t *pool);
47
48/**
49 * For the packed revision @a rev in @a fs,  determine the offset within
50 * the revision pack file and return it in @a rev_offset.  Use @a pool for
51 * allocations.
52 */
53svn_error_t *
54svn_fs_fs__get_packed_offset(apr_off_t *rev_offset,
55                             svn_fs_t *fs,
56                             svn_revnum_t rev,
57                             apr_pool_t *pool);
58
59/* Return the svn_dir_entry_t* objects of DIRECTORY in an APR array
60 * allocated in RESULT_POOL with entries added in storage (on-disk) order.
61 * FS' format will be used to pick the optimal ordering strategy.  Use
62 * SCRATCH_POOL for temporary allocations.
63 */
64apr_array_header_t *
65svn_fs_fs__order_dir_entries(svn_fs_t *fs,
66                             apr_hash_t *directory,
67                             apr_pool_t *result_pool,
68                             apr_pool_t *scratch_pool);
69
70#endif
71