xref: /freebsd/contrib/openbsm/bin/auditdistd/trail.h (revision 5ca8e32633c4ffbbcd6762e5888b6a4ba0708c6c)
1 /*-
2  * Copyright (c) 2012 The FreeBSD Foundation
3  * All rights reserved.
4  *
5  * This software was developed by Pawel Jakub Dawidek under sponsorship from
6  * the FreeBSD Foundation.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND
18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE
21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27  * SUCH DAMAGE.
28  */
29 
30 #ifndef	_AUDITDISTD_TRAIL_H_
31 #define	_AUDITDISTD_TRAIL_H_
32 
33 #include <stdbool.h>
34 #include <unistd.h>	/* off_t */
35 
36 #define	TRAIL_IDENTICAL	0
37 #define	TRAIL_RENAMED	1
38 #define	TRAIL_OLDER	2
39 #define	TRAIL_NEWER	3
40 
41 struct trail;
42 
43 struct trail *trail_new(const char *dirname, bool create);
44 void trail_free(struct trail *trail);
45 bool trail_is_not_terminated(const char *filename);
46 bool trail_is_crash_recovery(const char *filename);
47 void trail_start(struct trail *trail, const char *filename, off_t offset);
48 void trail_next(struct trail *trail);
49 void trail_close(struct trail *trail);
50 void trail_reset(struct trail *trail);
51 void trail_unlink(struct trail *trail, const char *filename);
52 bool trail_switch(struct trail *trail);
53 const char *trail_filename(const struct trail *trail);
54 int trail_filefd(const struct trail *trail);
55 int trail_dirfd(const struct trail *trail);
56 void trail_last(DIR *dirfp, char *filename, size_t filenamesize);
57 bool trail_validate_name(const char *srcname, const char *dstname);
58 int trail_name_compare(const char *name0, const char *name1);
59 
60 #endif	/* !_AUDITDISTD_TRAIL_H_ */
61