xref: /freebsd/contrib/processor-trace/libipt/internal/include/pt_cpu.h (revision 85f87cf491bec6f90948a85b10f5523ea24db9e3)
174fe6c29SRuslan Bukin /*
2*85f87cf4SRuslan Bukin  * Copyright (c) 2013-2019, Intel Corporation
374fe6c29SRuslan Bukin  *
474fe6c29SRuslan Bukin  * Redistribution and use in source and binary forms, with or without
574fe6c29SRuslan Bukin  * modification, are permitted provided that the following conditions are met:
674fe6c29SRuslan Bukin  *
774fe6c29SRuslan Bukin  *  * Redistributions of source code must retain the above copyright notice,
874fe6c29SRuslan Bukin  *    this list of conditions and the following disclaimer.
974fe6c29SRuslan Bukin  *  * Redistributions in binary form must reproduce the above copyright notice,
1074fe6c29SRuslan Bukin  *    this list of conditions and the following disclaimer in the documentation
1174fe6c29SRuslan Bukin  *    and/or other materials provided with the distribution.
1274fe6c29SRuslan Bukin  *  * Neither the name of Intel Corporation nor the names of its contributors
1374fe6c29SRuslan Bukin  *    may be used to endorse or promote products derived from this software
1474fe6c29SRuslan Bukin  *    without specific prior written permission.
1574fe6c29SRuslan Bukin  *
1674fe6c29SRuslan Bukin  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
1774fe6c29SRuslan Bukin  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
1874fe6c29SRuslan Bukin  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
1974fe6c29SRuslan Bukin  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
2074fe6c29SRuslan Bukin  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
2174fe6c29SRuslan Bukin  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
2274fe6c29SRuslan Bukin  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
2374fe6c29SRuslan Bukin  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
2474fe6c29SRuslan Bukin  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
2574fe6c29SRuslan Bukin  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
2674fe6c29SRuslan Bukin  * POSSIBILITY OF SUCH DAMAGE.
2774fe6c29SRuslan Bukin  */
2874fe6c29SRuslan Bukin 
2974fe6c29SRuslan Bukin #ifndef PT_CPU_H
3074fe6c29SRuslan Bukin #define PT_CPU_H
3174fe6c29SRuslan Bukin 
3274fe6c29SRuslan Bukin struct pt_cpu;
3374fe6c29SRuslan Bukin 
3474fe6c29SRuslan Bukin /* Parses @s which should be of format family/model[/stepping] and
3574fe6c29SRuslan Bukin  * stores the value in @cpu on success.
3674fe6c29SRuslan Bukin  * The optional stepping defaults to 0 if omitted.
3774fe6c29SRuslan Bukin  *
3874fe6c29SRuslan Bukin  * Returns 0 on success.
3974fe6c29SRuslan Bukin  * Returns -pte_invalid if @cpu or @s is NULL.
4074fe6c29SRuslan Bukin  * Returns -pte_invalid if @s could not be parsed.
4174fe6c29SRuslan Bukin  */
4274fe6c29SRuslan Bukin extern int pt_cpu_parse(struct pt_cpu *cpu, const char *s);
4374fe6c29SRuslan Bukin 
4474fe6c29SRuslan Bukin /* Get the cpu we're running on.
4574fe6c29SRuslan Bukin  *
4674fe6c29SRuslan Bukin  * Reads the family/model/stepping of the processor on which this function
4774fe6c29SRuslan Bukin  * is executed and stores the value in @cpu.
4874fe6c29SRuslan Bukin  *
4974fe6c29SRuslan Bukin  * Returns zero on success, a negative error code otherwise.
5074fe6c29SRuslan Bukin  * Returns -pte_invalid if @cpu is NULL.
5174fe6c29SRuslan Bukin  */
5274fe6c29SRuslan Bukin extern int pt_cpu_read(struct pt_cpu *cpu);
5374fe6c29SRuslan Bukin 
5474fe6c29SRuslan Bukin #endif /* PT_CPU_H */
55