1 /* revprops.h --- everything needed to handle revprops in FSFS
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
12 * http://www.apache.org/licenses/LICENSE-2.0
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
20 * ====================================================================
25 /* In the filesystem FS, pack all revprop shards up to min_unpacked_rev.
27 * NOTE: Keep the old non-packed shards around until after the format bump.
28 * Otherwise, re-running upgrade will drop the packed revprop shard but
29 * have no unpacked data anymore. Call upgrade_cleanup_pack_revprops after
32 * NOTIFY_FUNC and NOTIFY_BATON as well as CANCEL_FUNC and CANCEL_BATON are
33 * used in the usual way. Temporary allocations are done in SCRATCH_POOL.
36 svn_fs_fs__upgrade_pack_revprops(svn_fs_t *fs,
37 svn_fs_upgrade_notify_t notify_func,
39 svn_cancel_func_t cancel_func,
41 apr_pool_t *scratch_pool);
43 /* In the filesystem FS, remove all non-packed revprop shards up to
44 * min_unpacked_rev. Temporary allocations are done in SCRATCH_POOL.
46 * NOTIFY_FUNC and NOTIFY_BATON as well as CANCEL_FUNC and CANCEL_BATON are
47 * used in the usual way. Cancellation is supported in the sense that we
48 * will cleanly abort the operation. However, there will be remnant shards
49 * that must be removed manually.
51 * See upgrade_pack_revprops for more info.
54 svn_fs_fs__upgrade_cleanup_pack_revprops(svn_fs_t *fs,
55 svn_fs_upgrade_notify_t notify_func,
57 svn_cancel_func_t cancel_func,
59 apr_pool_t *scratch_pool);
61 /* Read the revprops for revision REV in FS and return them in *PROPERTIES_P.
63 * Allocations will be done in POOL.
66 svn_fs_fs__get_revision_proplist(apr_hash_t **proplist_p,
71 /* Set the revision property list of revision REV in filesystem FS to
72 PROPLIST. Use POOL for temporary allocations. */
74 svn_fs_fs__set_revision_proplist(svn_fs_t *fs,
80 /* Return TRUE, if for REVISION in FS, we can find the revprop pack file.
81 * Use POOL for temporary allocations.
82 * Set *MISSING, if the reason is a missing manifest or pack file.
85 svn_fs_fs__packed_revprop_available(svn_boolean_t *missing,
87 svn_revnum_t revision,
91 /****** Packing FSFS shards *********/
93 /* Copy revprop files for revisions [START_REV, END_REV) from SHARD_PATH
94 * to the pack file at PACK_FILE_NAME in PACK_FILE_DIR.
96 * The file sizes have already been determined and written to SIZES.
97 * Please note that this function will be executed while the filesystem
98 * has been locked and that revprops files will therefore not be modified
99 * while the pack is in progress.
101 * COMPRESSION_LEVEL defines how well the resulting pack file shall be
102 * compressed or whether is shall be compressed at all. TOTAL_SIZE is
103 * a hint on which initial buffer size we should use to hold the pack file
106 * CANCEL_FUNC and CANCEL_BATON are used as usual. Temporary allocations
107 * are done in SCRATCH_POOL.
110 svn_fs_fs__copy_revprops(const char *pack_file_dir,
111 const char *pack_filename,
112 const char *shard_path,
113 svn_revnum_t start_rev,
114 svn_revnum_t end_rev,
115 apr_array_header_t *sizes,
116 apr_size_t total_size,
117 int compression_level,
118 svn_cancel_func_t cancel_func,
120 apr_pool_t *scratch_pool);
122 /* In the filesystem FS, pack all revprop shards up to min_unpacked_rev.
124 * NOTE: Keep the old non-packed shards around until after the format bump.
125 * Otherwise, re-running upgrade will drop the packed revprop shard but
126 * have no unpacked data anymore. Call upgrade_cleanup_pack_revprops after
129 * NOTIFY_FUNC and NOTIFY_BATON as well as CANCEL_FUNC and CANCEL_BATON are
130 * used in the usual way. Temporary allocations are done in SCRATCH_POOL.
133 svn_fs_fs__pack_revprops_shard(const char *pack_file_dir,
134 const char *shard_path,
136 int max_files_per_dir,
137 apr_off_t max_pack_size,
138 int compression_level,
139 svn_cancel_func_t cancel_func,
141 apr_pool_t *scratch_pool);
143 /* In the filesystem FS, remove all non-packed revprop shards up to
144 * min_unpacked_rev. Temporary allocations are done in SCRATCH_POOL.
146 * NOTIFY_FUNC and NOTIFY_BATON as well as CANCEL_FUNC and CANCEL_BATON are
147 * used in the usual way. Cancellation is supported in the sense that we
148 * will cleanly abort the operation. However, there will be remnant shards
149 * that must be removed manually.
151 * See upgrade_pack_revprops for more info.
154 svn_fs_fs__delete_revprops_shard(const char *shard_path,
156 int max_files_per_dir,
157 svn_cancel_func_t cancel_func,
159 apr_pool_t *scratch_pool);