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