1 /* Copyright (c) 2008, XenSource Inc.
2  * All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are met:
6  *     * Redistributions of source code must retain the above copyright
7  *       notice, this list of conditions and the following disclaimer.
8  *     * Redistributions in binary form must reproduce the above copyright
9  *       notice, this list of conditions and the following disclaimer in the
10  *       documentation and/or other materials provided with the distribution.
11  *     * Neither the name of XenSource Inc. nor the names of its contributors
12  *       may be used to endorse or promote products derived from this software
13  *       without specific prior written permission.
14  *
15  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
16  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
17  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
18  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
19  * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
20  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
21  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
22  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
23  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
24  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
25  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 */
27 #ifndef _VHD_JOURNAL_H_
28 #define _VHD_JOURNAL_H_
29 
30 #include <inttypes.h>
31 
32 #include "libvhd.h"
33 
34 #define VHD_JOURNAL_METADATA       0x01
35 #define VHD_JOURNAL_DATA           0x02
36 
37 #define VHD_JOURNAL_HEADER_COOKIE  "vjournal"
38 #define VHD_JOURNAL_ENTRY_COOKIE   0xaaaa12344321aaaa
39 
40 typedef struct vhd_journal_header {
41 	char                       cookie[8];
42 	vhd_uuid_t                 uuid;
43 	uint64_t                   vhd_footer_offset;
44 	uint32_t                   journal_data_entries;
45 	uint32_t                   journal_metadata_entries;
46 	uint64_t                   journal_data_offset;
47 	uint64_t                   journal_metadata_offset;
48 	uint64_t                   journal_eof;
49 	char                       pad[448];
50 } vhd_journal_header_t;
51 
52 typedef struct vhd_journal {
53 	char                      *jname;
54 	int                        jfd;
55 	int                        is_block; /* is jfd a block device */
56 	vhd_journal_header_t       header;
57 	vhd_context_t              vhd;
58 } vhd_journal_t;
59 
60 int vhd_journal_create(vhd_journal_t *, const char *file, const char *jfile);
61 int vhd_journal_open(vhd_journal_t *, const char *file, const char *jfile);
62 int vhd_journal_add_block(vhd_journal_t *, uint32_t block, char mode);
63 int vhd_journal_commit(vhd_journal_t *);
64 int vhd_journal_revert(vhd_journal_t *);
65 int vhd_journal_close(vhd_journal_t *);
66 int vhd_journal_remove(vhd_journal_t *);
67 
68 #endif
69