xref: /freebsd/stand/common/tslog.c (revision 3c4ba5f55438f7afd4f4b0b56f88f2bb505fd6a6)
1 /*-
2  * Copyright (c) 2021 Colin Percival
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24  * SUCH DAMAGE.
25  */
26 
27 #include <sys/cdefs.h>
28 __FBSDID("$FreeBSD$");
29 
30 #include <sys/types.h>
31 
32 #include <stand.h>
33 
34 #include "bootstrap.h"
35 
36 /* Buffer for holding tslog data in string format. */
37 #ifndef LOADER_TSLOGSIZE
38 #define LOADER_TSLOGSIZE (2 * 1024 * 1024)
39 #endif
40 
41 int
42 tslog_init(void)
43 {
44 	void * tslog_buf;
45 
46 	/* Allocate buffer and pass to libsa tslog code. */
47 	if ((tslog_buf = malloc(LOADER_TSLOGSIZE)) == NULL)
48 		return (-1);
49 	tslog_setbuf(tslog_buf, LOADER_TSLOGSIZE);
50 
51 	/* Record this as when we entered the loader. */
52 	TSRAW("ENTER", "loader", NULL);
53 
54 	return (0);
55 }
56 
57 /*
58  * Pass our tslog buffer as a preloaded "module" to the kernel.  This should
59  * be called as late as possible prior to the kernel being executed, since
60  * any timestamps logged after this is called will not be visible to the
61  * kernel.
62  */
63 int
64 tslog_publish(void)
65 {
66 	void * tslog_buf;
67 	size_t tslog_bufpos;
68 
69 	/* Record a log entry for ending logging. */
70 	TSRAW("EXIT", "loader", NULL);
71 
72 	/* Get the buffer and its current length. */
73 	tslog_getbuf(&tslog_buf, &tslog_bufpos);
74 
75 	/* If we never allocated a buffer, return an error. */
76 	if (tslog_buf == NULL)
77 		return (-1);
78 
79 	/* Store the buffer where the kernel can read it. */
80 	return (file_addbuf("TSLOG", "TSLOG data", tslog_bufpos, tslog_buf));
81 }
82