doc/man/pt_enc_get_offset.3.md

   1 % PT_ENC_GET_OFFSET(3)
   2
   3 <!---
   4  ! Copyright (c) 2015-2018, Intel Corporation
   5  !
   6  ! Redistribution and use in source and binary forms, with or without
   7  ! modification, are permitted provided that the following conditions are met:
   8  !
   9  !  * Redistributions of source code must retain the above copyright notice,
  10  !    this list of conditions and the following disclaimer.
  11  !  * Redistributions in binary form must reproduce the above copyright notice,
  12  !    this list of conditions and the following disclaimer in the documentation
  13  !    and/or other materials provided with the distribution.
  14  !  * Neither the name of Intel Corporation nor the names of its contributors
  15  !    may be used to endorse or promote products derived from this software
  16  !    without specific prior written permission.
  17  !
  18  ! THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  19  ! AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  20  ! IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  21  ! ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  22  ! LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  23  ! CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  24  ! SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  25  ! INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  26  ! CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  27  ! ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  28  ! POSSIBILITY OF SUCH DAMAGE.
  29  !-->
  30
  31 # NAME
  32
  33 pt_enc_get_offset, pt_enc_sync_set - get/set an Intel(R) Processor Trace packet
  34 encoder's current trace buffer offset
  35
  36
  37 # SYNOPSIS
  38
  39 | **\#include `<intel-pt.h>`**
  40 |
  41 | **int pt_enc_get_offset(const struct pt_packet_encoder \**encoder*,**
  42 |                       **uint64_t \**offset*);**
  43 | **int pt_enc_sync_set(const struct pt_packet_encoder \**encoder*,**
  44 |                     **uint64_t *offset*);**
  45
  46 Link with *-lipt*.
  47
  48
  49 # DESCRIPTION
  50
  51 **pt_enc_get_offset**() provides *encoder*'s current position as offset in bytes
  52 from the beginning of *encoder*'s trace buffer in the unsigned integer variable
  53 pointed to by *offset*.
  54
  55 **pt_enc_sync_set**() sets *encoder*'s current position to *offset* bytes from
  56 the beginning of its trace buffer.
  57
  58
  59 # RETURN VALUE
  60
  61 Both functions return zero on success or a negative *pt_error_code* enumeration
  62 constant in case of an error.
  63
  64
  65 # ERRORS
  66
  67 pte_invalid
  68 :   The *encoder* or *offset* (for **pt_enc_sync_set**()) argument is NULL.
  69
  70 pte_eos
  71 :   The *offset* argument is too big and the resulting position would be outside
  72     of *encoder*'s trace buffer (**pt_enc_sync_set**() only).
  73
  74
  75 # SEE ALSO
  76
  77 **pt_enc_alloc_encoder**(3), **pt_enc_free_encoder**(3), **pt_enc_next**(3)