|
Packit |
b1f7ae |
% PT_PKT_ALLOC_DECODER(3)
|
|
Packit |
b1f7ae |
|
|
Packit |
b1f7ae |
|
|
Packit |
b1f7ae |
! Copyright (c) 2015-2017, Intel Corporation
|
|
Packit |
b1f7ae |
!
|
|
Packit |
b1f7ae |
! Redistribution and use in source and binary forms, with or without
|
|
Packit |
b1f7ae |
! modification, are permitted provided that the following conditions are met:
|
|
Packit |
b1f7ae |
!
|
|
Packit |
b1f7ae |
! * Redistributions of source code must retain the above copyright notice,
|
|
Packit |
b1f7ae |
! this list of conditions and the following disclaimer.
|
|
Packit |
b1f7ae |
! * Redistributions in binary form must reproduce the above copyright notice,
|
|
Packit |
b1f7ae |
! this list of conditions and the following disclaimer in the documentation
|
|
Packit |
b1f7ae |
! and/or other materials provided with the distribution.
|
|
Packit |
b1f7ae |
! * Neither the name of Intel Corporation nor the names of its contributors
|
|
Packit |
b1f7ae |
! may be used to endorse or promote products derived from this software
|
|
Packit |
b1f7ae |
! without specific prior written permission.
|
|
Packit |
b1f7ae |
!
|
|
Packit |
b1f7ae |
! THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
|
Packit |
b1f7ae |
! AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
Packit |
b1f7ae |
! IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
Packit |
b1f7ae |
! ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
|
|
Packit |
b1f7ae |
! LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
|
|
Packit |
b1f7ae |
! CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
|
|
Packit |
b1f7ae |
! SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
|
|
Packit |
b1f7ae |
! INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
|
|
Packit |
b1f7ae |
! CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
|
|
Packit |
b1f7ae |
! ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
|
Packit |
b1f7ae |
! POSSIBILITY OF SUCH DAMAGE.
|
|
Packit |
b1f7ae |
!-->
|
|
Packit |
b1f7ae |
|
|
Packit |
b1f7ae |
# NAME
|
|
Packit |
b1f7ae |
|
|
Packit |
b1f7ae |
pt_pkt_alloc_decoder, pt_pkt_free_decoder - allocate/free an Intel(R) Processor
|
|
Packit |
b1f7ae |
Trace packet decoder
|
|
Packit |
b1f7ae |
|
|
Packit |
b1f7ae |
|
|
Packit |
b1f7ae |
# SYNOPSIS
|
|
Packit |
b1f7ae |
|
|
Packit |
b1f7ae |
| **\#include `<intel-pt.h>`**
|
|
Packit |
b1f7ae |
|
|
|
Packit |
b1f7ae |
| **struct pt_packet_decoder \***
|
|
Packit |
b1f7ae |
| **pt_pkt_alloc_decoder(const struct pt_config \**config*);**
|
|
Packit |
b1f7ae |
|
|
|
Packit |
b1f7ae |
| **void pt_pkt_free_decoder(struct pt_packet_decoder \**decoder*);**
|
|
Packit |
b1f7ae |
|
|
Packit |
b1f7ae |
Link with *-lipt*.
|
|
Packit |
b1f7ae |
|
|
Packit |
b1f7ae |
|
|
Packit |
b1f7ae |
# DESCRIPTION
|
|
Packit |
b1f7ae |
|
|
Packit |
b1f7ae |
**pt_pkt_alloc_decoder**() allocates a new Intel Processor Trace (Intel PT)
|
|
Packit |
b1f7ae |
packet decoder and returns a pointer to it. The packet decoder decodes raw
|
|
Packit |
b1f7ae |
Intel PT trace into a stream of *pt_packet* objects. See **pt_pkt_next**(3).
|
|
Packit |
b1f7ae |
|
|
Packit |
b1f7ae |
The *config* argument points to a *pt_config* object. See **pt_config**(3).
|
|
Packit |
b1f7ae |
The *config* argument will not be referenced by the returned decoder but the
|
|
Packit |
b1f7ae |
trace buffer defined by the *config* argument's *begin* and *end* fields will.
|
|
Packit |
b1f7ae |
|
|
Packit |
b1f7ae |
The returned packet decoder needs to be synchronized onto the trace stream
|
|
Packit |
b1f7ae |
before it can be used. To synchronize the packet decoder, use
|
|
Packit |
b1f7ae |
**pt_pkt_sync_forward**(3), **pt_pkt_sync_backward**(3), or
|
|
Packit |
b1f7ae |
**pt_pkt_sync_set**(3).
|
|
Packit |
b1f7ae |
|
|
Packit |
b1f7ae |
**pt_pkt_free_decoder**() frees the Intel PT packet decoder pointed to by
|
|
Packit |
b1f7ae |
*decoder*. The *decoder* argument must be NULL or point to a decoder that has
|
|
Packit |
b1f7ae |
been allocated by a call to **pt_pkt_alloc_decoder**().
|
|
Packit |
b1f7ae |
|
|
Packit |
b1f7ae |
|
|
Packit |
b1f7ae |
# RETURN VALUE
|
|
Packit |
b1f7ae |
|
|
Packit |
b1f7ae |
**pt_pkt_alloc_decoder**() returns a pointer to a *pt_packet_decoder* object on
|
|
Packit |
b1f7ae |
success or NULL in case of an error.
|
|
Packit |
b1f7ae |
|
|
Packit |
b1f7ae |
|
|
Packit |
b1f7ae |
# EXAMPLE
|
|
Packit |
b1f7ae |
|
|
Packit |
b1f7ae |
~~~{.c}
|
|
Packit |
b1f7ae |
int foo(const struct pt_config *config) {
|
|
Packit |
b1f7ae |
struct pt_packet_decoder *decoder;
|
|
Packit |
b1f7ae |
errcode;
|
|
Packit |
b1f7ae |
|
|
Packit |
b1f7ae |
decoder = pt_pkt_alloc_decoder(config);
|
|
Packit |
b1f7ae |
if (!decoder)
|
|
Packit |
b1f7ae |
return pte_nomem;
|
|
Packit |
b1f7ae |
|
|
Packit |
b1f7ae |
errcode = bar(decoder);
|
|
Packit |
b1f7ae |
|
|
Packit |
b1f7ae |
pt_pkt_free_decoder(decoder);
|
|
Packit |
b1f7ae |
return errcode;
|
|
Packit |
b1f7ae |
}
|
|
Packit |
b1f7ae |
~~~
|
|
Packit |
b1f7ae |
|
|
Packit |
b1f7ae |
|
|
Packit |
b1f7ae |
# SEE ALSO
|
|
Packit |
b1f7ae |
|
|
Packit |
b1f7ae |
**pt_config**(3), **pt_pkt_sync_forward**(3), **pt_pkt_sync_backward**(3),
|
|
Packit |
b1f7ae |
**pt_pkt_sync_set**(3), **pt_pkt_get_offset**(3), **pt_pkt_get_sync_offset**(3),
|
|
Packit |
b1f7ae |
**pt_pkt_get_config**(3), **pt_pkt_next**(3)
|