Subversion Repositories HelenOS

Rev

Rev 4327 | Go to most recent revision | Details | Compare with Previous | Last modification | View Log | RSS feed

Rev Author Line No. Line
268 palkovsky 1
/*
2071 jermar 2
 * Copyright (c) 2005 Ondrej Palkovsky
268 palkovsky 3
 * All rights reserved.
4
 *
5
 * Redistribution and use in source and binary forms, with or without
6
 * modification, are permitted provided that the following conditions
7
 * are met:
8
 *
9
 * - Redistributions of source code must retain the above copyright
10
 *   notice, this list of conditions and the following disclaimer.
11
 * - Redistributions in binary form must reproduce the above copyright
12
 *   notice, this list of conditions and the following disclaimer in the
13
 *   documentation and/or other materials provided with the distribution.
14
 * - The name of the author may not be used to endorse or promote products
15
 *   derived from this software without specific prior written permission.
16
 *
17
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27
 */
28
 
1888 jermar 29
/** @addtogroup genericdebug
1702 cejka 30
 * @{
31
 */
32
 
1264 jermar 33
/**
1702 cejka 34
 * @file
4263 mejdrech 35
 * @brief Kernel symbol resolver.
1264 jermar 36
 */
268 palkovsky 37
 
38
#include <symtab.h>
2797 jermar 39
#include <byteorder.h>
4153 mejdrech 40
#include <string.h>
582 palkovsky 41
#include <print.h>
3059 decky 42
#include <arch/types.h>
43
#include <typedefs.h>
4153 mejdrech 44
#include <errno.h>
268 palkovsky 45
 
4263 mejdrech 46
/** Get name of a symbol that seems most likely to correspond to address.
268 palkovsky 47
 *
4263 mejdrech 48
 * @param addr Address.
49
 * @param name Place to store pointer to the symbol name.
404 jermar 50
 *
4263 mejdrech 51
 * @return Zero on success or negative error code, ENOENT if not found,
52
 *         ENOTSUP if symbol table not available.
53
 *
268 palkovsky 54
 */
4153 mejdrech 55
int symtab_name_lookup(unative_t addr, char **name)
268 palkovsky 56
{
4153 mejdrech 57
#ifdef CONFIG_SYMTAB
4581 mejdrech 58
    size_t i;
4263 mejdrech 59
 
60
    for (i = 1; symbol_table[i].address_le; i++) {
1780 jermar 61
        if (addr < uint64_t_le2host(symbol_table[i].address_le))
268 palkovsky 62
            break;
63
    }
4263 mejdrech 64
 
4153 mejdrech 65
    if (addr >= uint64_t_le2host(symbol_table[i - 1].address_le)) {
66
        *name = symbol_table[i - 1].symbol_name;
67
        return EOK;
68
    }
4263 mejdrech 69
 
4153 mejdrech 70
    *name = NULL;
71
    return ENOENT;
4263 mejdrech 72
 
4153 mejdrech 73
#else
74
    *name = NULL;
75
    return ENOTSUP;
76
#endif
268 palkovsky 77
}
582 palkovsky 78
 
4153 mejdrech 79
/** Lookup symbol by address and format for display.
80
 *
81
 * Returns name of closest corresponding symbol, "Not found" if none exists
82
 * or "N/A" if no symbol information is available.
83
 *
4263 mejdrech 84
 * @param addr Address.
85
 * @param name Place to store pointer to the symbol name.
4153 mejdrech 86
 *
4263 mejdrech 87
 * @return Pointer to a human-readable string.
88
 *
4153 mejdrech 89
 */
90
char *symtab_fmt_name_lookup(unative_t addr)
91
{
92
    char *name;
4263 mejdrech 93
    int rc = symtab_name_lookup(addr, &name);
94
 
4153 mejdrech 95
    switch (rc) {
4263 mejdrech 96
    case EOK:
97
        return name;
98
    case ENOENT:
99
        return "Not found";
100
    default:
101
        return "N/A";
4153 mejdrech 102
    }
103
}
104
 
105
#ifdef CONFIG_SYMTAB
106
 
1264 jermar 107
/** Find symbols that match the parameter forward and print them.
601 palkovsky 108
 *
4263 mejdrech 109
 * @param name     Search string
110
 * @param startpos Starting position, changes to found position
111
 *
112
 * @return Pointer to the part of string that should be completed or NULL.
113
 *
601 palkovsky 114
 */
4581 mejdrech 115
static const char *symtab_search_one(const char *name, size_t *startpos)
601 palkovsky 116
{
4581 mejdrech 117
    size_t namelen = str_length(name);
4263 mejdrech 118
 
4581 mejdrech 119
    size_t pos;
4263 mejdrech 120
    for (pos = *startpos; symbol_table[pos].address_le; pos++) {
121
        const char *curname = symbol_table[pos].symbol_name;
122
 
4327 mejdrech 123
        /* Find a ':' in curname */
4263 mejdrech 124
        const char *colon = str_chr(curname, ':');
125
        if (colon == NULL)
601 palkovsky 126
            continue;
4263 mejdrech 127
 
128
        if (str_length(curname) < namelen)
601 palkovsky 129
            continue;
4263 mejdrech 130
 
131
        if (str_lcmp(name, curname, namelen) == 0) {
132
            *startpos = pos;
133
            return (curname + str_lsize(curname, namelen));
601 palkovsky 134
        }
135
    }
4263 mejdrech 136
 
601 palkovsky 137
    return NULL;
138
}
139
 
4153 mejdrech 140
#endif
141
 
4263 mejdrech 142
/** Return address that corresponds to the entry.
582 palkovsky 143
 *
601 palkovsky 144
 * Search symbol table, and if there is one match, return it
582 palkovsky 145
 *
4263 mejdrech 146
 * @param name Name of the symbol
147
 * @param addr Place to store symbol address
4153 mejdrech 148
 *
4263 mejdrech 149
 * @return Zero on success, ENOENT - not found, EOVERFLOW - duplicate
150
 *         symbol, ENOTSUP - no symbol information available.
151
 *
582 palkovsky 152
 */
4153 mejdrech 153
int symtab_addr_lookup(const char *name, uintptr_t *addr)
582 palkovsky 154
{
4153 mejdrech 155
#ifdef CONFIG_SYMTAB
4581 mejdrech 156
    size_t found = 0;
157
    size_t pos = 0;
4263 mejdrech 158
    const char *hint;
159
 
160
    while ((hint = symtab_search_one(name, &pos))) {
161
        if (str_length(hint) == 0) {
162
            *addr = uint64_t_le2host(symbol_table[pos].address_le);
582 palkovsky 163
            found++;
164
        }
4263 mejdrech 165
        pos++;
582 palkovsky 166
    }
4263 mejdrech 167
 
601 palkovsky 168
    if (found > 1)
4153 mejdrech 169
        return EOVERFLOW;
4263 mejdrech 170
 
4153 mejdrech 171
    if (found < 1)
172
        return ENOENT;
4263 mejdrech 173
 
4153 mejdrech 174
    return EOK;
4263 mejdrech 175
 
4153 mejdrech 176
#else
177
    return ENOTSUP;
178
#endif
582 palkovsky 179
}
180
 
4263 mejdrech 181
/** Find symbols that match parameter and print them */
582 palkovsky 182
void symtab_print_search(const char *name)
183
{
4153 mejdrech 184
#ifdef CONFIG_SYMTAB
4581 mejdrech 185
    size_t pos = 0;
4263 mejdrech 186
    while (symtab_search_one(name, &pos)) {
187
        uintptr_t addr = uint64_t_le2host(symbol_table[pos].address_le);
188
        char *realname = symbol_table[pos].symbol_name;
3059 decky 189
        printf("%p: %s\n", addr, realname);
4263 mejdrech 190
        pos++;
601 palkovsky 191
    }
4263 mejdrech 192
 
4153 mejdrech 193
#else
194
    printf("No symbol information available.\n");
195
#endif
601 palkovsky 196
}
197
 
198
/** Symtab completion
199
 *
4263 mejdrech 200
 * @param input Search string, completes to symbol name
201
 * @param size  Input buffer size
202
 *
203
 * @return 0 - nothing found, 1 - success, >1 print duplicates
204
 *
601 palkovsky 205
 */
4581 mejdrech 206
int symtab_compl(char *input, size_t size)
601 palkovsky 207
{
4153 mejdrech 208
#ifdef CONFIG_SYMTAB
4263 mejdrech 209
    const char *name = input;
210
 
211
    /* Allow completion of pointers */
212
    if ((name[0] == '*') || (name[0] == '&'))
616 palkovsky 213
        name++;
4263 mejdrech 214
 
215
    /* Do not print all symbols */
216
    if (str_length(name) == 0)
601 palkovsky 217
        return 0;
616 palkovsky 218
 
4581 mejdrech 219
    size_t found = 0;
220
    size_t pos = 0;
4263 mejdrech 221
    const char *hint;
222
    char output[MAX_SYMBOL_NAME];
223
 
224
    output[0] = 0;
225
 
226
    while ((hint = symtab_search_one(name, &pos))) {
227
        if ((found == 0) || (str_length(output) > str_length(hint)))
4327 mejdrech 228
            str_cpy(output, MAX_SYMBOL_NAME, hint);
4263 mejdrech 229
 
230
        pos++;
601 palkovsky 231
        found++;
582 palkovsky 232
    }
4263 mejdrech 233
 
234
    if ((found > 1) && (str_length(output) != 0)) {
601 palkovsky 235
        printf("\n");
4263 mejdrech 236
        pos = 0;
237
        while ((hint = symtab_search_one(name, &pos))) {
238
            printf("%s\n", symbol_table[pos].symbol_name);
239
            pos++;
601 palkovsky 240
        }
241
    }
4263 mejdrech 242
 
243
    if (found > 0)
4327 mejdrech 244
        str_cpy(input, size, output);
4263 mejdrech 245
 
601 palkovsky 246
    return found;
4263 mejdrech 247
 
4153 mejdrech 248
#else
249
    return 0;
250
#endif
582 palkovsky 251
}
1702 cejka 252
 
1888 jermar 253
/** @}
1702 cejka 254
 */