xref: /freebsd/contrib/processor-trace/libipt/internal/include/pt_cpu.h (revision 85f87cf491bec6f90948a85b10f5523ea24db9e3)
1 /*
2  * Copyright (c) 2013-2019, Intel Corporation
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are met:
6  *
7  *  * Redistributions of source code must retain the above copyright notice,
8  *    this list of conditions and the following disclaimer.
9  *  * Redistributions in binary form must reproduce the above copyright notice,
10  *    this list of conditions and the following disclaimer in the documentation
11  *    and/or other materials provided with the distribution.
12  *  * Neither the name of Intel Corporation nor the names of its contributors
13  *    may be used to endorse or promote products derived from this software
14  *    without specific prior written permission.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
17  * AND 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 COPYRIGHT OWNER OR CONTRIBUTORS BE
20  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
21  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
22  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
23  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
24  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
25  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26  * POSSIBILITY OF SUCH DAMAGE.
27  */
28 
29 #ifndef PT_CPU_H
30 #define PT_CPU_H
31 
32 struct pt_cpu;
33 
34 /* Parses @s which should be of format family/model[/stepping] and
35  * stores the value in @cpu on success.
36  * The optional stepping defaults to 0 if omitted.
37  *
38  * Returns 0 on success.
39  * Returns -pte_invalid if @cpu or @s is NULL.
40  * Returns -pte_invalid if @s could not be parsed.
41  */
42 extern int pt_cpu_parse(struct pt_cpu *cpu, const char *s);
43 
44 /* Get the cpu we're running on.
45  *
46  * Reads the family/model/stepping of the processor on which this function
47  * is executed and stores the value in @cpu.
48  *
49  * Returns zero on success, a negative error code otherwise.
50  * Returns -pte_invalid if @cpu is NULL.
51  */
52 extern int pt_cpu_read(struct pt_cpu *cpu);
53 
54 #endif /* PT_CPU_H */
55