1 /* 2 * Copyright (c) 2015-2019, Intel Corporation 3 * 4 * Redistribution and use in source and binary forms, with or without 5 * modification, are permitted provided that the following conditions are met: 6 * 7 * * Redistributions of source code must retain the above copyright notice, 8 * this list of conditions and the following disclaimer. 9 * * Redistributions in binary form must reproduce the above copyright notice, 10 * this list of conditions and the following disclaimer in the documentation 11 * and/or other materials provided with the distribution. 12 * * Neither the name of Intel Corporation nor the names of its contributors 13 * may be used to endorse or promote products derived from this software 14 * without specific prior written permission. 15 * 16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 17 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 19 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE 20 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 21 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 22 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 23 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 24 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 25 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 26 * POSSIBILITY OF SUCH DAMAGE. 27 */ 28 29 #include "intel-pt.h" 30 31 32 /* Read the configuration provided by a library user and zero-initialize 33 * missing fields. 34 * 35 * We keep the user's size value if it is smaller than sizeof(*@config) to 36 * allow decoders to detect missing configuration bits. 37 * 38 * Returns zero on success, a negative error code otherwise. 39 * Returns -pte_internal if @config is NULL. 40 * Returns -pte_invalid if @uconfig is NULL. 41 * Returns -pte_bad_config if @config is too small to be useful. 42 */ 43 extern int pt_config_from_user(struct pt_config *config, 44 const struct pt_config *uconfig); 45 46 /* Get the configuration for the n'th address filter. 47 * 48 * Returns zero if @filter is NULL or @n is out of bounds. 49 * 50 * This corresponds to IA32_RTIT_CTL.ADDRn_CFG. 51 */ 52 extern uint32_t pt_filter_addr_cfg(const struct pt_conf_addr_filter *filter, 53 uint8_t n); 54 55 /* Get the lower bound (inclusive) of the n'th address filter. 56 * 57 * Returns zero if @filter is NULL or @n is out of bounds. 58 * 59 * This corresponds to IA32_RTIT_ADDRn_A. 60 */ 61 extern uint64_t pt_filter_addr_a(const struct pt_conf_addr_filter *filter, 62 uint8_t n); 63 64 /* Get the upper bound (inclusive) of the n'th address filter. 65 * 66 * Returns zero if @filter is NULL or @n is out of bounds. 67 * 68 * This corresponds to IA32_RTIT_ADDRn_B. 69 */ 70 extern uint64_t pt_filter_addr_b(const struct pt_conf_addr_filter *filter, 71 uint8_t n); 72 73 /* Check address filters. 74 * 75 * Checks @addr against @filter. 76 * 77 * Returns a positive number if @addr lies in a tracing-enabled region. 78 * Returns zero if @addr lies in a tracing-disabled region. 79 * Returns a negative pt_error_code otherwise. 80 */ 81 extern int pt_filter_addr_check(const struct pt_conf_addr_filter *filter, 82 uint64_t addr); 83