xref: /freebsd/usr.sbin/fifolog/lib/fifolog_write.h (revision 43a5ec4eb41567cc92586503212743d89686d78f)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3  *
4  * Copyright (c) 2005-2008 Poul-Henning Kamp
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26  * SUCH DAMAGE.
27  *
28  * $FreeBSD$
29  */
30 
31 #define FIFOLOG_PT_BYTES_PRE		0
32 #define FIFOLOG_PT_BYTES_POST		1
33 #define FIFOLOG_PT_WRITES		2
34 #define FIFOLOG_PT_FLUSH		3
35 #define FIFOLOG_PT_SYNC			4
36 #define FIFOLOG_PT_RUNTIME		5
37 #define FIFOLOG_NPOINT			6
38 
39 struct fifolog_writer {
40 	unsigned			magic;
41 #define FIFOLOG_WRITER_MAGIC		0xf1f0706
42 
43 	struct fifolog_file		*ff;
44 
45 	unsigned			writerate;
46 	unsigned			syncrate;
47 	unsigned			compression;
48 
49 	int				cleanup;
50 
51 	intmax_t			cnt[FIFOLOG_NPOINT];
52 
53 	uint32_t			seq;
54 	off_t				recno;
55 	uint8_t				flag;
56 	time_t				last;
57 
58 	ssize_t				obufsize;
59 	u_char				*obuf;
60 
61 	ssize_t				ibufsize;
62 	ssize_t				ibufptr;
63 	u_char				*ibuf;
64 
65 	time_t				starttime;
66 	time_t				lastwrite;
67 	time_t				lastsync;
68 };
69 
70 struct fifolog_writer *fifolog_write_new(void);
71 const char *fifolog_write_open(struct fifolog_writer *f, const char *fn, unsigned writerate, unsigned syncrate, unsigned compression);
72 int fifolog_write_record(struct fifolog_writer *f, uint32_t id, time_t now, const void *ptr, ssize_t len);
73 int fifolog_write_poll(struct fifolog_writer *f, time_t now);
74 int fifolog_write_record_poll(struct fifolog_writer *f, uint32_t id, time_t now, const void *ptr, ssize_t len);
75 void fifolog_write_close(struct fifolog_writer *f);
76 void fifolog_write_destroy(struct fifolog_writer *f);
77 extern const char *fifolog_write_statnames[];
78