1 /*
2  * Copyright (c) 2020 Google Inc. All rights reserved
3  *
4  * Permission is hereby granted, free of charge, to any person obtaining
5  * a copy of this software and associated documentation files
6  * (the "Software"), to deal in the Software without restriction,
7  * including without limitation the rights to use, copy, modify, merge,
8  * publish, distribute, sublicense, and/or sell copies of the Software,
9  * and to permit persons to whom the Software is furnished to do so,
10  * subject to the following conditions:
11  *
12  * The above copyright notice and this permission notice shall be
13  * included in all copies or substantial portions of the Software.
14  *
15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
16  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
17  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
18  * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
19  * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
20  * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
21  * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
22  */
23 
24 #pragma once
25 
26 #include <lib/trusty/trusty_app.h>
27 #include <uapi/err.h>
28 
29 /**
30  * struct pc_symbol_info - symbol information about an instruction address
31  * @symbol: name of the function
32  * @offset: offset of the instruction within @symbol
33  * @size: size of the @symbol
34  */
35 struct pc_symbol_info {
36     const char* symbol;
37     uintptr_t offset;
38     uintptr_t size;
39 };
40 
41 /**
42  * trusty_app_symbolize() - find symbol closest to a given instruction address
43  * @app: app containing the instruction
44  * @pc: instruction address being symbolized
45  * @info: pointer to a struct pc_symbol_info to be filled out
46  *
47  * Return: NO_ERROR on success, ERR_NOT_FOUND otherwise
48  */
49 int trusty_app_symbolize(struct trusty_app* app,
50                          uintptr_t pc,
51                          struct pc_symbol_info* info);
52