|
Packit |
b1f7ae |
% PT_BLK_SYNC_FORWARD(3)
|
|
Packit |
b1f7ae |
|
|
Packit |
b1f7ae |
|
|
Packit |
b1f7ae |
! Copyright (c) 2016-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_blk_sync_forward, pt_blk_sync_backward, pt_blk_sync_set - synchronize an
|
|
Packit |
b1f7ae |
Intel(R) Processor Trace block decoder
|
|
Packit |
b1f7ae |
|
|
Packit |
b1f7ae |
|
|
Packit |
b1f7ae |
# SYNOPSIS
|
|
Packit |
b1f7ae |
|
|
Packit |
b1f7ae |
| **\#include `<intel-pt.h>`**
|
|
Packit |
b1f7ae |
|
|
|
Packit |
b1f7ae |
| **int pt_blk_sync_forward(struct pt_block_decoder \**decoder*);**
|
|
Packit |
b1f7ae |
| **int pt_blk_sync_backward(struct pt_block_decoder \**decoder*);**
|
|
Packit |
b1f7ae |
| **int pt_blk_sync_set(struct pt_block_decoder \**decoder*,**
|
|
Packit |
b1f7ae |
| **uint64_t *offset*);**
|
|
Packit |
b1f7ae |
|
|
Packit |
b1f7ae |
Link with *-lipt*.
|
|
Packit |
b1f7ae |
|
|
Packit |
b1f7ae |
|
|
Packit |
b1f7ae |
# DESCRIPTION
|
|
Packit |
b1f7ae |
|
|
Packit |
b1f7ae |
These functions synchronize an Intel Processor Trace (Intel PT) block decoder
|
|
Packit |
b1f7ae |
pointed to by *decoder* onto the trace stream in *decoder*'s trace buffer.
|
|
Packit |
b1f7ae |
|
|
Packit |
b1f7ae |
They search for a Packet Stream Boundary (PSB) packet in the trace stream and,
|
|
Packit |
b1f7ae |
if successful, set *decoder*'s current position and synchronization position to
|
|
Packit |
b1f7ae |
that packet and start processing packets. For synchronization to be
|
|
Packit |
b1f7ae |
successfull, there must be a full PSB+ header in the trace stream.
|
|
Packit |
b1f7ae |
|
|
Packit |
b1f7ae |
**pt_blk_sync_forward**() searches in forward direction from *decoder*'s
|
|
Packit |
b1f7ae |
current position towards the end of the trace buffer. If *decoder* has been
|
|
Packit |
b1f7ae |
newly allocated and has not been synchronized yet, the search starts from the
|
|
Packit |
b1f7ae |
beginning of the trace.
|
|
Packit |
b1f7ae |
|
|
Packit |
b1f7ae |
**pt_blk_sync_backward**() searches in backward direction from *decoder*'s
|
|
Packit |
b1f7ae |
current position towards the beginning of the trace buffer. If *decoder* has
|
|
Packit |
b1f7ae |
been newly allocated and has not been synchronized yet, the search starts from
|
|
Packit |
b1f7ae |
the end of the trace.
|
|
Packit |
b1f7ae |
|
|
Packit |
b1f7ae |
**pt_blk_sync_set**() searches at *offset* bytes from the beginning of its
|
|
Packit |
b1f7ae |
trace buffer.
|
|
Packit |
b1f7ae |
|
|
Packit |
b1f7ae |
|
|
Packit |
b1f7ae |
# RETURN VALUE
|
|
Packit |
b1f7ae |
|
|
Packit |
b1f7ae |
All synchronization functions return zero or a positive value on success or a
|
|
Packit |
b1f7ae |
negative *pt_error_code* enumeration constant in case of an error.
|
|
Packit |
b1f7ae |
|
|
Packit |
b1f7ae |
On success, a bit-vector of *pt_status_flag* enumeration constants is returned.
|
|
Packit |
b1f7ae |
The *pt_status_flag* enumeration is declared as:
|
|
Packit |
b1f7ae |
|
|
Packit |
b1f7ae |
~~~{.c}
|
|
Packit |
b1f7ae |
/** Decoder status flags. */
|
|
Packit |
b1f7ae |
enum pt_status_flag {
|
|
Packit |
b1f7ae |
/** There is an event pending. */
|
|
Packit |
b1f7ae |
pts_event_pending = 1 << 0,
|
|
Packit |
b1f7ae |
|
|
Packit |
b1f7ae |
/** The address has been suppressed. */
|
|
Packit |
b1f7ae |
pts_ip_suppressed = 1 << 1,
|
|
Packit |
b1f7ae |
|
|
Packit |
b1f7ae |
/** There is no more trace data available. */
|
|
Packit |
b1f7ae |
pts_eos = 1 << 2
|
|
Packit |
b1f7ae |
};
|
|
Packit |
b1f7ae |
~~~
|
|
Packit |
b1f7ae |
|
|
Packit |
b1f7ae |
|
|
Packit |
b1f7ae |
# ERRORS
|
|
Packit |
b1f7ae |
|
|
Packit |
b1f7ae |
pte_invalid
|
|
Packit |
b1f7ae |
: The *decoder* argument is NULL.
|
|
Packit |
b1f7ae |
|
|
Packit |
b1f7ae |
pte_eos
|
|
Packit |
b1f7ae |
: There is no (further) PSB+ header in the trace stream
|
|
Packit |
b1f7ae |
(**pt_blk_sync_forward**() and **pt_blk_sync_backward**()) or at *offset*
|
|
Packit |
b1f7ae |
bytes into the trace buffer (**pt_blk_sync_set**()).
|
|
Packit |
b1f7ae |
|
|
Packit |
b1f7ae |
pte_nosync
|
|
Packit |
b1f7ae |
: There is no PSB packet at *offset* bytes from the beginning of the trace
|
|
Packit |
b1f7ae |
(**pt_blk_sync_set**() only).
|
|
Packit |
b1f7ae |
|
|
Packit |
b1f7ae |
pte_bad_opc
|
|
Packit |
b1f7ae |
: The decoder encountered an unsupported Intel PT packet opcode.
|
|
Packit |
b1f7ae |
|
|
Packit |
b1f7ae |
pte_bad_packet
|
|
Packit |
b1f7ae |
: The decoder encountered an unsupported Intel PT packet payload.
|
|
Packit |
b1f7ae |
|
|
Packit |
b1f7ae |
|
|
Packit |
b1f7ae |
# EXAMPLE
|
|
Packit |
b1f7ae |
|
|
Packit |
b1f7ae |
The following example re-synchronizes an Intel PT block decoder after decode
|
|
Packit |
b1f7ae |
errors:
|
|
Packit |
b1f7ae |
|
|
Packit |
b1f7ae |
~~~{.c}
|
|
Packit |
b1f7ae |
int foo(struct pt_block_decoder *decoder) {
|
|
Packit |
b1f7ae |
for (;;) {
|
|
Packit |
b1f7ae |
int errcode;
|
|
Packit |
b1f7ae |
|
|
Packit |
b1f7ae |
errcode = pt_blk_sync_forward(decoder);
|
|
Packit |
b1f7ae |
if (errcode < 0)
|
|
Packit |
b1f7ae |
return errcode;
|
|
Packit |
b1f7ae |
|
|
Packit |
b1f7ae |
do {
|
|
Packit |
b1f7ae |
errcode = decode(decoder);
|
|
Packit |
b1f7ae |
} while (errcode >= 0);
|
|
Packit |
b1f7ae |
}
|
|
Packit |
b1f7ae |
}
|
|
Packit |
b1f7ae |
~~~
|
|
Packit |
b1f7ae |
|
|
Packit |
b1f7ae |
|
|
Packit |
b1f7ae |
# SEE ALSO
|
|
Packit |
b1f7ae |
|
|
Packit |
b1f7ae |
**pt_blk_alloc_decoder**(3), **pt_blk_free_decoder**(3),
|
|
Packit |
b1f7ae |
**pt_blk_get_offset**(3), **pt_blk_get_sync_offset**(3),
|
|
Packit |
b1f7ae |
**pt_blk_get_config**(3), **pt_blk_time**(3), **pt_blk_core_bus_ratio**(3),
|
|
Packit |
b1f7ae |
**pt_blk_next**(3)
|