| 1 | /* $Id: kDbgSymbol.cpp 29 2009-07-01 20:30:29Z bird $ */
|
|---|
| 2 | /** @file
|
|---|
| 3 | * kDbg - The Debug Info Reader, Symbols.
|
|---|
| 4 | */
|
|---|
| 5 |
|
|---|
| 6 | /*
|
|---|
| 7 | * Copyright (c) 2006-2007 Knut St. Osmundsen <bird-kStuff-spamix@anduin.net>
|
|---|
| 8 | *
|
|---|
| 9 | * Permission is hereby granted, free of charge, to any person
|
|---|
| 10 | * obtaining a copy of this software and associated documentation
|
|---|
| 11 | * files (the "Software"), to deal in the Software without
|
|---|
| 12 | * restriction, including without limitation the rights to use,
|
|---|
| 13 | * copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|---|
| 14 | * copies of the Software, and to permit persons to whom the
|
|---|
| 15 | * Software is furnished to do so, subject to the following
|
|---|
| 16 | * conditions:
|
|---|
| 17 | *
|
|---|
| 18 | * The above copyright notice and this permission notice shall be
|
|---|
| 19 | * included in all copies or substantial portions of the Software.
|
|---|
| 20 | *
|
|---|
| 21 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
|---|
| 22 | * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
|
|---|
| 23 | * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
|---|
| 24 | * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
|
|---|
| 25 | * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
|
|---|
| 26 | * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
|
|---|
| 27 | * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
|
|---|
| 28 | * OTHER DEALINGS IN THE SOFTWARE.
|
|---|
| 29 | */
|
|---|
| 30 |
|
|---|
| 31 | /*******************************************************************************
|
|---|
| 32 | * Header Files *
|
|---|
| 33 | *******************************************************************************/
|
|---|
| 34 | #include "kDbgInternal.h"
|
|---|
| 35 | #include <k/kHlpAlloc.h>
|
|---|
| 36 |
|
|---|
| 37 |
|
|---|
| 38 | /**
|
|---|
| 39 | * Duplicates a symbol.
|
|---|
| 40 | *
|
|---|
| 41 | * To save heap space, the returned symbol will not own more heap space than
|
|---|
| 42 | * it strictly need to. So, it's not possible to append stuff to the symbol
|
|---|
| 43 | * or anything of that kind.
|
|---|
| 44 | *
|
|---|
| 45 | * @returns Pointer to the duplicate.
|
|---|
| 46 | * This must be freed using kDbgSymbolFree().
|
|---|
| 47 | * @param pSymbol The symbol to be duplicated.
|
|---|
| 48 | */
|
|---|
| 49 | KDBG_DECL(PKDBGSYMBOL) kDbgSymbolDup(PCKDBGSYMBOL pSymbol)
|
|---|
| 50 | {
|
|---|
| 51 | kDbgAssertPtrReturn(pSymbol, NULL);
|
|---|
| 52 | KSIZE cb = K_OFFSETOF(KDBGSYMBOL, szName[pSymbol->cchName + 1]);
|
|---|
| 53 | PKDBGSYMBOL pNewSymbol = (PKDBGSYMBOL)kHlpDup(pSymbol, cb);
|
|---|
| 54 | if (pNewSymbol)
|
|---|
| 55 | pNewSymbol->cbSelf = cb;
|
|---|
| 56 | return pNewSymbol;
|
|---|
| 57 | }
|
|---|
| 58 |
|
|---|
| 59 |
|
|---|
| 60 | /**
|
|---|
| 61 | * Frees a symbol obtained from the kDbg API.
|
|---|
| 62 | *
|
|---|
| 63 | * @returns 0 on success.
|
|---|
| 64 | * @returns KERR_INVALID_POINTER if pSymbol isn't a valid pointer.
|
|---|
| 65 | *
|
|---|
| 66 | * @param pSymbol The symbol to be freed. The null pointer is ignored.
|
|---|
| 67 | */
|
|---|
| 68 | KDBG_DECL(int) kDbgSymbolFree(PKDBGSYMBOL pSymbol)
|
|---|
| 69 | {
|
|---|
| 70 | if (!pSymbol)
|
|---|
| 71 | {
|
|---|
| 72 | kDbgAssertPtrReturn(pSymbol, KERR_INVALID_POINTER);
|
|---|
| 73 | pSymbol->cbSelf = 0;
|
|---|
| 74 | kHlpFree(pSymbol);
|
|---|
| 75 | }
|
|---|
| 76 | return 0;
|
|---|
| 77 | }
|
|---|
| 78 |
|
|---|
