Subversion Repositories HelenOS

Rev

Rev 4137 | Rev 4267 | 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
1264 jermar 35
 * @brief   Kernel symbol resolver.
36
 */
268 palkovsky 37
 
38
#include <symtab.h>
2797 jermar 39
#include <byteorder.h>
4011 svoboda 40
#include <string.h>
582 palkovsky 41
#include <print.h>
3059 decky 42
#include <arch/types.h>
43
#include <typedefs.h>
4137 svoboda 44
#include <errno.h>
268 palkovsky 45
 
4137 svoboda 46
/** Get name of symbol that seems most likely to correspond to address.
268 palkovsky 47
 *
4137 svoboda 48
 * @param addr  Address.
49
 * @param name  Place to store pointer to the symbol name.
404 jermar 50
 *
4137 svoboda 51
 * @return  Zero on success or negative error code, ENOENT if not found,
52
 *      ENOTSUP if symbol table not available.
268 palkovsky 53
 */
4137 svoboda 54
int symtab_name_lookup(unative_t addr, char **name)
268 palkovsky 55
{
4137 svoboda 56
#ifdef CONFIG_SYMTAB
268 palkovsky 57
    count_t i;
58
 
2797 jermar 59
    for (i = 1; symbol_table[i].address_le; ++i) {
1780 jermar 60
        if (addr < uint64_t_le2host(symbol_table[i].address_le))
268 palkovsky 61
            break;
62
    }
4137 svoboda 63
    if (addr >= uint64_t_le2host(symbol_table[i - 1].address_le)) {
64
        *name = symbol_table[i - 1].symbol_name;
65
        return EOK;
66
    }
67
 
68
    *name = NULL;
69
    return ENOENT;
70
#else
71
    *name = NULL;
72
    return ENOTSUP;
73
#endif
268 palkovsky 74
}
582 palkovsky 75
 
4137 svoboda 76
/** Lookup symbol by address and format for display.
77
 *
78
 * Returns name of closest corresponding symbol, "Not found" if none exists
79
 * or "N/A" if no symbol information is available.
80
 *
81
 * @param addr  Address.
82
 * @param name  Place to store pointer to the symbol name.
83
 *
84
 * @return  Pointer to a human-readable string.
85
 */
86
char *symtab_fmt_name_lookup(unative_t addr)
87
{
88
    int rc;
89
    char *name;
90
 
91
    rc = symtab_name_lookup(addr, &name);
92
    switch (rc) {
93
    case EOK: return name;
94
    case ENOENT: return "Not found";
95
    default: return "N/A";
96
    }
97
}
98
 
99
#ifdef CONFIG_SYMTAB
100
 
1264 jermar 101
/** Find symbols that match the parameter forward and print them.
601 palkovsky 102
 *
103
 * @param name - search string
104
 * @param startpos - starting position, changes to found position
105
 * @return Pointer to the part of string that should be completed or NULL
106
 */
107
static char * symtab_search_one(const char *name, int *startpos)
108
{
4207 svoboda 109
    unsigned int namelen = str_size(name);
601 palkovsky 110
    char *curname;
2797 jermar 111
    int i, j;
601 palkovsky 112
    int colonoffset = -1;
113
 
2797 jermar 114
    for (i = 0; name[i]; i++)
601 palkovsky 115
        if (name[i] == ':') {
116
            colonoffset = i;
117
            break;
118
        }
119
 
2797 jermar 120
    for (i = *startpos; symbol_table[i].address_le; ++i) {
601 palkovsky 121
        /* Find a ':' in name */
122
        curname = symbol_table[i].symbol_name;
2797 jermar 123
        for (j = 0; curname[j] && curname[j] != ':'; j++)
601 palkovsky 124
            ;
125
        if (!curname[j])
126
            continue;
127
        j -= colonoffset;
128
        curname += j;
4207 svoboda 129
        if (str_size(curname) < namelen)
601 palkovsky 130
            continue;
131
        if (strncmp(curname, name, namelen) == 0) {
132
            *startpos = i;
2797 jermar 133
            return curname + namelen;
601 palkovsky 134
        }
135
    }
136
    return NULL;
137
}
138
 
4137 svoboda 139
#endif
140
 
582 palkovsky 141
/** Return address that corresponds to the entry
142
 *
601 palkovsky 143
 * Search symbol table, and if there is one match, return it
582 palkovsky 144
 *
4137 svoboda 145
 * @param name  Name of the symbol
146
 * @param addr  Place to store symbol address
147
 *
148
 * @return  Zero on success, ENOENT - not found, EOVERFLOW - duplicate
149
 *      symbol, ENOTSUP - no symbol information available.
582 palkovsky 150
 */
4137 svoboda 151
int symtab_addr_lookup(const char *name, uintptr_t *addr)
582 palkovsky 152
{
4137 svoboda 153
#ifdef CONFIG_SYMTAB
582 palkovsky 154
    count_t found = 0;
601 palkovsky 155
    char *hint;
156
    int i;
582 palkovsky 157
 
601 palkovsky 158
    i = 0;
2797 jermar 159
    while ((hint = symtab_search_one(name, &i))) {
4207 svoboda 160
        if (!str_size(hint)) {
4137 svoboda 161
            *addr =  uint64_t_le2host(symbol_table[i].address_le);
582 palkovsky 162
            found++;
163
        }
601 palkovsky 164
        i++;
582 palkovsky 165
    }
601 palkovsky 166
    if (found > 1)
4137 svoboda 167
        return EOVERFLOW;
168
    if (found < 1)
169
        return ENOENT;
170
    return EOK;
171
#else
172
    return ENOTSUP;
173
#endif
582 palkovsky 174
}
175
 
601 palkovsky 176
/** Find symbols that match parameter and prints them */
582 palkovsky 177
void symtab_print_search(const char *name)
178
{
4137 svoboda 179
#ifdef CONFIG_SYMTAB
582 palkovsky 180
    int i;
1780 jermar 181
    uintptr_t addr;
582 palkovsky 182
    char *realname;
183
 
601 palkovsky 184
 
185
    i = 0;
186
    while (symtab_search_one(name, &i)) {
1780 jermar 187
        addr =  uint64_t_le2host(symbol_table[i].address_le);
601 palkovsky 188
        realname = symbol_table[i].symbol_name;
3059 decky 189
        printf("%p: %s\n", addr, realname);
601 palkovsky 190
        i++;
191
    }
4137 svoboda 192
#else
193
    printf("No symbol information available.\n");
194
#endif
601 palkovsky 195
}
196
 
197
/** Symtab completion
198
 *
1248 jermar 199
 * @param input - Search string, completes to symbol name
601 palkovsky 200
 * @returns - 0 - nothing found, 1 - success, >1 print duplicates
201
 */
616 palkovsky 202
int symtab_compl(char *input)
601 palkovsky 203
{
4137 svoboda 204
#ifdef CONFIG_SYMTAB
2797 jermar 205
    char output[MAX_SYMBOL_NAME + 1];
601 palkovsky 206
    int startpos = 0;
207
    char *foundtxt;
208
    int found = 0;
209
    int i;
616 palkovsky 210
    char *name = input;
601 palkovsky 211
 
616 palkovsky 212
    /* Allow completion of pointers  */
213
    if (name[0] == '*' || name[0] == '&')
214
        name++;
215
 
601 palkovsky 216
    /* Do not print everything */
4207 svoboda 217
    if (!str_size(name))
601 palkovsky 218
        return 0;
616 palkovsky 219
 
601 palkovsky 220
 
221
    output[0] = '\0';
222
 
223
    while ((foundtxt = symtab_search_one(name, &startpos))) {
224
        startpos++;
225
        if (!found)
4207 svoboda 226
            strncpy(output, foundtxt, str_size(foundtxt) + 1);
601 palkovsky 227
        else {
2797 jermar 228
            for (i = 0; output[i] && foundtxt[i] &&
229
                 output[i] == foundtxt[i]; i++)
601 palkovsky 230
                ;
231
            output[i] = '\0';
582 palkovsky 232
        }
601 palkovsky 233
        found++;
582 palkovsky 234
    }
601 palkovsky 235
    if (!found)
236
        return 0;
237
 
4207 svoboda 238
    if (found > 1 && !str_size(output)) {
601 palkovsky 239
        printf("\n");
240
        startpos = 0;
241
        while ((foundtxt = symtab_search_one(name, &startpos))) {
242
            printf("%s\n", symbol_table[startpos].symbol_name);
243
            startpos++;
244
        }
245
    }
616 palkovsky 246
    strncpy(input, output, MAX_SYMBOL_NAME);
601 palkovsky 247
    return found;
4137 svoboda 248
#else
249
    return 0;
250
#endif
582 palkovsky 251
}
1702 cejka 252
 
1888 jermar 253
/** @}
1702 cejka 254
 */