Blame doc/man/pt_pkt_get_offset.3.md

Packit b1f7ae
% PT_PKT_GET_OFFSET(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_get_offset, pt_pkt_get_sync_offset - get an Intel(R) Processor Trace
Packit b1f7ae
packet decoder's current/synchronization trace buffer offset
Packit b1f7ae
Packit b1f7ae
Packit b1f7ae
# SYNOPSIS
Packit b1f7ae
Packit b1f7ae
| **\#include `<intel-pt.h>`**
Packit b1f7ae
|
Packit b1f7ae
| **int pt_pkt_get_offset(struct pt_packet_decoder \**decoder*,**
Packit b1f7ae
|                       **uint64_t \**offset*);**
Packit b1f7ae
| **int pt_pkt_get_sync_offset(struct pt_packet_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
**pt_pkt_get_offset**() provides *decoder*'s current position as offset in bytes
Packit b1f7ae
from the beginning of *decoder*'s trace buffer in the unsigned integer variable
Packit b1f7ae
pointed to by *offset*.
Packit b1f7ae
Packit b1f7ae
**pt_pkt_get_sync_offset**() provides *decoder*'s last synchronization point as
Packit b1f7ae
offset in bytes from the beginning of *decoder*'s trace buffer in the unsigned
Packit b1f7ae
integer variable pointed to by *offset*.
Packit b1f7ae
Packit b1f7ae
Packit b1f7ae
# RETURN VALUE
Packit b1f7ae
Packit b1f7ae
Both functions return zero on success or a negative *pt_error_code* enumeration
Packit b1f7ae
constant in case of an error.
Packit b1f7ae
Packit b1f7ae
Packit b1f7ae
# ERRORS
Packit b1f7ae
Packit b1f7ae
pte_invalid
Packit b1f7ae
:   The *decoder* or *offset* argument is NULL.
Packit b1f7ae
Packit b1f7ae
pte_nosync
Packit b1f7ae
:   *decoder* has not been synchronized onto the trace stream.  Use
Packit b1f7ae
    **pt_pkt_sync_forward**(3), **pt_pkt_sync_backward**(3), or
Packit b1f7ae
    **pt_pkt_sync_set**(3) to synchronize *decoder*.
Packit b1f7ae
Packit b1f7ae
Packit b1f7ae
# SEE ALSO
Packit b1f7ae
Packit b1f7ae
**pt_pkt_alloc_decoder**(3), **pt_pkt_free_decoder**(3),
Packit b1f7ae
**pt_pkt_sync_forward**(3), **pt_pkt_sync_backward**(3),
Packit b1f7ae
**pt_pkt_sync_set**(3), **pt_pkt_next**(3)