xref: /freebsd/stand/common/tslog.c (revision 06c3fb2749bda94cb5201f81ffdb8fa6c3161b2e)
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/types.h>
28 
29 #include <stand.h>
30 
31 #include "bootstrap.h"
32 
33 /* Buffer for holding tslog data in string format. */
34 #ifndef LOADER_TSLOGSIZE
35 #define LOADER_TSLOGSIZE (2 * 1024 * 1024)
36 #endif
37 
38 int
39 tslog_init(void)
40 {
41 	void * tslog_buf;
42 
43 	/* Allocate buffer and pass to libsa tslog code. */
44 	if ((tslog_buf = malloc(LOADER_TSLOGSIZE)) == NULL)
45 		return (-1);
46 	tslog_setbuf(tslog_buf, LOADER_TSLOGSIZE);
47 
48 	/* Record this as when we entered the loader. */
49 	TSRAW("ENTER", "loader", NULL);
50 
51 	return (0);
52 }
53 
54 /*
55  * Pass our tslog buffer as a preloaded "module" to the kernel.  This should
56  * be called as late as possible prior to the kernel being executed, since
57  * any timestamps logged after this is called will not be visible to the
58  * kernel.
59  */
60 int
61 tslog_publish(void)
62 {
63 	void * tslog_buf;
64 	size_t tslog_bufpos;
65 
66 	/* Record a log entry for ending logging. */
67 	TSRAW("EXIT", "loader", NULL);
68 
69 	/* Get the buffer and its current length. */
70 	tslog_getbuf(&tslog_buf, &tslog_bufpos);
71 
72 	/* If we never allocated a buffer, return an error. */
73 	if (tslog_buf == NULL)
74 		return (-1);
75 
76 	/* Store the buffer where the kernel can read it. */
77 	return (file_addbuf("TSLOG", "TSLOG data", tslog_bufpos, tslog_buf));
78 }
79