Blame doc/man/pt_enc_get_config.3.md

Packit b1f7ae
% PT_ENC_GET_CONFIG(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_enc_get_config, pt_pkt_get_config, pt_qry_get_config, pt_insn_get_config,
Packit b1f7ae
pt_blk_get_config - get an Intel(R) Processor Trace encoder/decoder's
Packit b1f7ae
configuration
Packit b1f7ae
Packit b1f7ae
Packit b1f7ae
# SYNOPSIS
Packit b1f7ae
Packit b1f7ae
| **\#include `<intel-pt.h>`**
Packit b1f7ae
|
Packit b1f7ae
| **const struct pt_config \***
Packit b1f7ae
| **pt_enc_get_config(const struct pt_encoder \**encoder*);**
Packit b1f7ae
|
Packit b1f7ae
| **const struct pt_config \***
Packit b1f7ae
| **pt_pkt_get_config(const struct pt_packet_decoder \**decoder*);**
Packit b1f7ae
|
Packit b1f7ae
| **const struct pt_config \***
Packit b1f7ae
| **pt_qry_get_config(const struct pt_query_decoder \**decoder*);**
Packit b1f7ae
|
Packit b1f7ae
| **const struct pt_config \***
Packit b1f7ae
| **pt_insn_get_config(const struct pt_insn_decoder \**decoder*);**
Packit b1f7ae
|
Packit b1f7ae
| **const struct pt_config \***
Packit b1f7ae
| **pt_blk_get_config(const struct pt_block_decoder \**decoder*);**
Packit b1f7ae
Packit b1f7ae
Link with *-lipt*.
Packit b1f7ae
Packit b1f7ae
Packit b1f7ae
# DESCRIPTION
Packit b1f7ae
Packit b1f7ae
These functions return a pointer to their argument's configuration.  The
Packit b1f7ae
returned configuration object must not be freed.  It is valid as long as their
Packit b1f7ae
argument is not freed.
Packit b1f7ae
Packit b1f7ae
Packit b1f7ae
# RETURN VALUE
Packit b1f7ae
Packit b1f7ae
These functions returns a pointer to a *pt_config* object.  The returned pointer
Packit b1f7ae
is NULL if their argument is NULL.
Packit b1f7ae
Packit b1f7ae
Packit b1f7ae
# SEE ALSO
Packit b1f7ae
Packit b1f7ae
**pt_config**(3), **pt_alloc_encoder**(3), **pt_pkt_alloc_decoder**(3),
Packit b1f7ae
**pt_qry_alloc_decoder**(3), **pt_insn_alloc_decoder**(3),
Packit b1f7ae
**pt_blk_alloc_decoder**(3)