xref: /freebsd/sbin/hastd/activemap.h (revision f81cdf24ba5436367377f7c8e8f51f6df2a75ca7)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause
3  *
4  * Copyright (c) 2009-2010 The FreeBSD Foundation
5  * All rights reserved.
6  *
7  * This software was developed by Pawel Jakub Dawidek under sponsorship from
8  * the FreeBSD Foundation.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND
20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE
23  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29  * SUCH DAMAGE.
30  */
31 
32 #ifndef	_ACTIVEMAP_H_
33 #define	_ACTIVEMAP_H_
34 
35 #include <stdbool.h>
36 #include <stdint.h>
37 
38 struct activemap;
39 
40 int activemap_init(struct activemap **ampp, uint64_t mediasize,
41     uint32_t extentsize, uint32_t sectorsize, uint32_t keepdirty);
42 void activemap_free(struct activemap *amp);
43 
44 bool activemap_write_start(struct activemap *amp, off_t offset, off_t length);
45 bool activemap_write_complete(struct activemap *amp, off_t offset,
46     off_t length);
47 bool activemap_extent_complete(struct activemap *amp, int extent);
48 uint64_t activemap_ndirty(const struct activemap *amp);
49 
50 bool activemap_differ(const struct activemap *amp);
51 size_t activemap_size(const struct activemap *amp);
52 size_t activemap_ondisk_size(const struct activemap *amp);
53 void activemap_copyin(struct activemap *amp, const unsigned char *buf,
54     size_t size);
55 void activemap_merge(struct activemap *amp, const unsigned char *buf,
56     size_t size);
57 const unsigned char *activemap_bitmap(struct activemap *amp, size_t *sizep);
58 
59 size_t activemap_calc_ondisk_size(uint64_t mediasize, uint32_t extentsize,
60     uint32_t sectorsize);
61 
62 void activemap_sync_rewind(struct activemap *amp);
63 off_t activemap_sync_offset(struct activemap *amp, off_t *lengthp,
64     int *syncextp);
65 bool activemap_need_sync(struct activemap *amp, off_t offset, off_t length);
66 
67 void activemap_dump(const struct activemap *amp);
68 
69 #endif	/* !_ACTIVEMAP_H_ */
70