2 * File types.c - management of types (hierarchical tree)
4 * Copyright (C) 1997, Eric Youngdale.
7 * This library is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
10 * version 2.1 of the License, or (at your option) any later version.
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with this library; if not, write to the Free Software
19 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
21 * Note: This really doesn't do much at the moment, but it forms the framework
22 * upon which full support for datatype handling will eventually be built.
33 #include "wine/debug.h"
34 #include "dbghelp_private.h"
36 WINE_DEFAULT_DEBUG_CHANNEL(dbghelp);
37 WINE_DECLARE_DEBUG_CHANNEL(dbghelp_symtype);
39 static const char* symt_get_tag_str(DWORD tag)
43 case SymTagNull: return "SymTagNull";
44 case SymTagExe: return "SymTagExe";
45 case SymTagCompiland: return "SymTagCompiland";
46 case SymTagCompilandDetails: return "SymTagCompilandDetails";
47 case SymTagCompilandEnv: return "SymTagCompilandEnv";
48 case SymTagFunction: return "SymTagFunction";
49 case SymTagBlock: return "SymTagBlock";
50 case SymTagData: return "SymTagData";
51 case SymTagAnnotation: return "SymTagAnnotation";
52 case SymTagLabel: return "SymTagLabel";
53 case SymTagPublicSymbol: return "SymTagPublicSymbol";
54 case SymTagUDT: return "SymTagUDT";
55 case SymTagEnum: return "SymTagEnum";
56 case SymTagFunctionType: return "SymTagFunctionType";
57 case SymTagPointerType: return "SymTagPointerType";
58 case SymTagArrayType: return "SymTagArrayType";
59 case SymTagBaseType: return "SymTagBaseType";
60 case SymTagTypedef: return "SymTagTypedef,";
61 case SymTagBaseClass: return "SymTagBaseClass";
62 case SymTagFriend: return "SymTagFriend";
63 case SymTagFunctionArgType: return "SymTagFunctionArgType,";
64 case SymTagFuncDebugStart: return "SymTagFuncDebugStart,";
65 case SymTagFuncDebugEnd: return "SymTagFuncDebugEnd";
66 case SymTagUsingNamespace: return "SymTagUsingNamespace,";
67 case SymTagVTableShape: return "SymTagVTableShape";
68 case SymTagVTable: return "SymTagVTable";
69 case SymTagCustom: return "SymTagCustom";
70 case SymTagThunk: return "SymTagThunk";
71 case SymTagCustomType: return "SymTagCustomType";
72 case SymTagManagedType: return "SymTagManagedType";
73 case SymTagDimension: return "SymTagDimension";
74 default: return "---";
78 const char* symt_get_name(const struct symt* sym)
83 case SymTagData: return ((struct symt_data*)sym)->hash_elt.name;
84 case SymTagFunction: return ((struct symt_function*)sym)->hash_elt.name;
85 case SymTagPublicSymbol: return ((struct symt_public*)sym)->hash_elt.name;
86 case SymTagBaseType: return ((struct symt_basic*)sym)->hash_elt.name;
88 case SymTagEnum: return ((struct symt_enum*)sym)->name;
89 case SymTagTypedef: return ((struct symt_typedef*)sym)->hash_elt.name;
90 case SymTagUDT: return ((struct symt_udt*)sym)->hash_elt.name;
92 FIXME("Unsupported sym-tag %s\n", symt_get_tag_str(sym->tag));
95 case SymTagPointerType:
96 case SymTagFunctionType:
101 static struct symt* symt_find_type_by_name(struct module* module,
102 enum SymTagEnum sym_tag,
103 const char* typename)
106 struct symt_ht* type;
107 struct hash_table_iter hti;
112 hash_table_iter_init(&module->ht_types, &hti, typename);
113 while ((ptr = hash_table_iter_up(&hti)))
115 type = GET_ENTRY(ptr, struct symt_ht, hash_elt);
117 if ((sym_tag == SymTagNull || type->symt.tag == sym_tag) &&
118 type->hash_elt.name && !strcmp(type->hash_elt.name, typename))
121 SetLastError(ERROR_INVALID_NAME); /* FIXME ?? */
125 struct symt_basic* symt_new_basic(struct module* module, enum BasicType bt,
126 const char* typename, unsigned size)
128 struct symt_basic* sym;
132 sym = (struct symt_basic*)symt_find_type_by_name(module, SymTagBaseType,
134 if (sym && sym->bt == bt && sym->size == size)
137 if ((sym = pool_alloc(&module->pool, sizeof(*sym))))
139 sym->symt.tag = SymTagBaseType;
142 sym->hash_elt.name = pool_strdup(&module->pool, typename);
143 hash_table_add(&module->ht_types, &sym->hash_elt);
144 } else sym->hash_elt.name = NULL;
151 struct symt_udt* symt_new_udt(struct module* module, const char* typename,
152 unsigned size, enum UdtKind kind)
154 struct symt_udt* sym;
156 TRACE_(dbghelp_symtype)("Adding udt %s:%s\n", module->module.ModuleName, typename);
157 if ((sym = pool_alloc(&module->pool, sizeof(*sym))))
159 sym->symt.tag = SymTagUDT;
164 sym->hash_elt.name = pool_strdup(&module->pool, typename);
165 hash_table_add(&module->ht_types, &sym->hash_elt);
166 } else sym->hash_elt.name = NULL;
167 vector_init(&sym->vchildren, sizeof(struct symt*), 8);
172 BOOL symt_set_udt_size(struct module* module, struct symt_udt* udt, unsigned size)
174 assert(udt->symt.tag == SymTagUDT);
175 if (vector_length(&udt->vchildren) != 0)
177 if (udt->size != size)
178 FIXME_(dbghelp_symtype)("Changing size for %s from %u to %u\n",
179 udt->hash_elt.name, udt->size, size);
186 /******************************************************************
187 * symt_add_udt_element
189 * add an element to a udt (struct, class, union)
190 * the size & offset parameters are expressed in bits (not bytes) so that
191 * we can mix in the single call bytes aligned elements (regular fields) and
192 * the others (bit fields)
194 BOOL symt_add_udt_element(struct module* module, struct symt_udt* udt_type,
195 const char* name, struct symt* elt_type,
196 unsigned offset, unsigned size)
201 assert(udt_type->symt.tag == SymTagUDT);
203 TRACE_(dbghelp_symtype)("Adding %s to UDT %s\n", name, udt_type->hash_elt.name);
205 while ((p = vector_iter_up(&udt_type->vchildren, p)))
207 m = (struct symt_data*)*p;
209 assert(m->symt.tag == SymTagData);
210 if (m->hash_elt.name[0] == name[0] && strcmp(m->hash_elt.name, name) == 0)
214 if ((m = pool_alloc(&module->pool, sizeof(*m))) == NULL) return FALSE;
215 memset(m, 0, sizeof(*m));
216 m->symt.tag = SymTagData;
217 m->hash_elt.name = pool_strdup(&module->pool, name);
218 m->hash_elt.next = NULL;
220 m->kind = DataIsMember;
221 m->container = &udt_type->symt;
223 if (!(offset & 7) && !(size & 7))
225 m->location = LocIsThisRel;
226 m->u.offset = offset >> 3;
227 /* we could check that elt_type's size is actually size */
231 m->location = LocIsBitField;
232 m->u.bitfield.position = offset;
233 m->u.bitfield.length = size;
235 p = vector_add(&udt_type->vchildren, &module->pool);
241 struct symt_enum* symt_new_enum(struct module* module, const char* typename)
243 struct symt_enum* sym;
245 if ((sym = pool_alloc(&module->pool, sizeof(*sym))))
247 sym->symt.tag = SymTagEnum;
248 sym->name = pool_strdup(&module->pool, typename);
249 vector_init(&sym->vchildren, sizeof(struct symt*), 8);
254 BOOL symt_add_enum_element(struct module* module, struct symt_enum* enum_type,
255 const char* name, unsigned value)
260 assert(enum_type->symt.tag == SymTagEnum);
261 e = pool_alloc(&module->pool, sizeof(*e));
262 if (e == NULL) return FALSE;
264 e->symt.tag = SymTagData;
265 e->hash_elt.name = pool_strdup(&module->pool, name);
266 e->hash_elt.next = NULL;
267 e->kind = DataIsConstant;
268 e->container = &enum_type->symt;
269 /* CV defines the underlying type for the enumeration */
270 e->type = &symt_new_basic(module, btInt, "int", 4)->symt;
271 e->location = LocIsConstant;
272 e->u.value = value; /* FIXME: use variant */
274 p = vector_add(&enum_type->vchildren, &module->pool);
275 if (!p) return FALSE; /* FIXME we leak e */
281 struct symt_array* symt_new_array(struct module* module, int min, int max,
284 struct symt_array* sym;
286 if ((sym = pool_alloc(&module->pool, sizeof(*sym))))
288 sym->symt.tag = SymTagArrayType;
291 sym->basetype = base;
296 struct symt_function_signature* symt_new_function_signature(struct module* module,
297 struct symt* ret_type)
299 struct symt_function_signature* sym;
301 if ((sym = pool_alloc(&module->pool, sizeof(*sym))))
303 sym->symt.tag = SymTagFunctionType;
304 sym->rettype = ret_type;
309 struct symt_pointer* symt_new_pointer(struct module* module, struct symt* ref_type)
311 struct symt_pointer* sym;
313 if ((sym = pool_alloc(&module->pool, sizeof(*sym))))
315 sym->symt.tag = SymTagPointerType;
316 sym->pointsto = ref_type;
321 /******************************************************************
322 * SymEnumTypes (DBGHELP.@)
325 BOOL WINAPI SymEnumTypes(HANDLE hProcess, unsigned long BaseOfDll,
326 PSYM_ENUMERATESYMBOLS_CALLBACK EnumSymbolsCallback,
330 struct module* module;
331 struct symt_ht* type;
333 char buffer[sizeof(SYMBOL_INFO) + 256];
334 SYMBOL_INFO* sym_info = (SYMBOL_INFO*)buffer;
335 struct hash_table_iter hti;
338 TRACE("(%p %08lx %p %p)\n",
339 hProcess, BaseOfDll, EnumSymbolsCallback, UserContext);
341 pcs = process_find_by_handle(hProcess);
342 if (!pcs) return FALSE;
343 module = module_find_by_addr(pcs, BaseOfDll, DMT_UNKNOWN);
344 if (!(module = module_get_debug(pcs, module))) return FALSE;
346 sym_info->SizeOfStruct = sizeof(SYMBOL_INFO);
347 sym_info->MaxNameLen = sizeof(buffer) - sizeof(SYMBOL_INFO);
349 hash_table_iter_init(&module->ht_types, &hti, NULL);
350 while ((ptr = hash_table_iter_up(&hti)))
352 type = GET_ENTRY(ptr, struct symt_ht, hash_elt);
353 sym_info->TypeIndex = (DWORD)type;
354 sym_info->info = 0; /* FIXME */
355 symt_get_info(&type->symt, TI_GET_LENGTH, &sym_info->Size);
356 sym_info->ModBase = module->module.BaseOfImage;
357 sym_info->Flags = 0; /* FIXME */
358 sym_info->Value = 0; /* FIXME */
359 sym_info->Address = 0; /* FIXME */
360 sym_info->Register = 0; /* FIXME */
361 sym_info->Scope = 0; /* FIXME */
362 sym_info->Tag = type->symt.tag;
363 tmp = symt_get_name(&type->symt);
364 sym_info->NameLen = strlen(tmp) + 1;
365 strncpy(sym_info->Name, tmp, min(sym_info->NameLen, sym_info->MaxNameLen));
366 sym_info->Name[sym_info->MaxNameLen - 1] = '\0';
367 if (!EnumSymbolsCallback(sym_info, sym_info->Size, UserContext)) break;
372 /******************************************************************
375 * Retrieves inforamtion about a symt (either symbol or type)
377 BOOL symt_get_info(const struct symt* type, IMAGEHLP_SYMBOL_TYPE_INFO req,
382 if (!type) return FALSE;
384 /* helper to typecast pInfo to its expected type (_t) */
385 #define X(_t) (*((_t*)pInfo))
389 case TI_FINDCHILDREN:
391 const struct vector* v;
394 TI_FINDCHILDREN_PARAMS* tifp = pInfo;
398 case SymTagUDT: v = &((struct symt_udt*)type)->vchildren; break;
399 case SymTagEnum: v = &((struct symt_enum*)type)->vchildren; break;
401 FIXME("Unsupported sym-tag %s for find-children\n", symt_get_tag_str(type->tag));
404 for (i = 0; i < tifp->Count; i++)
406 if (!(pt = vector_at(v, tifp->Start + i))) return FALSE;
407 tifp->ChildId[i] = (DWORD)*pt;
416 switch (((struct symt_data*)type)->kind)
419 case DataIsFileStatic:
420 X(DWORD) = ((struct symt_data*)type)->u.address;
422 default: return FALSE;
426 X(DWORD) = ((struct symt_function*)type)->addr;
428 case SymTagPublicSymbol:
429 X(DWORD) = ((struct symt_public*)type)->address;
432 FIXME("Unsupported sym-tag %s for get-address\n", symt_get_tag_str(type->tag));
438 /* this is wrong, we should return the type of the index, not the
439 * type of the array[0]
441 case TI_GET_ARRAYINDEXTYPEID:
442 if (type->tag != SymTagArrayType) return FALSE;
443 X(DWORD) = (DWORD)((struct symt_array*)type)->basetype;
447 case TI_GET_BASETYPE:
448 if (type->tag != SymTagBaseType) return FALSE;
449 X(DWORD) = ((struct symt_basic*)type)->bt;
452 case TI_GET_BITPOSITION:
453 if (type->tag != SymTagData || ((struct symt_data*)type)->location != LocIsBitField)
455 X(DWORD) = ((struct symt_data*)type)->u.bitfield.position;
458 case TI_GET_CHILDRENCOUNT:
462 X(DWORD) = vector_length(&((struct symt_udt*)type)->vchildren);
465 X(DWORD) = vector_length(&((struct symt_enum*)type)->vchildren);
468 FIXME("Unsupported sym-tag %s for get-children-count\n", symt_get_tag_str(type->tag));
470 case SymTagPublicSymbol:
471 case SymTagPointerType:
478 if (type->tag != SymTagArrayType) return FALSE;
479 X(DWORD) = ((struct symt_array*)type)->end -
480 ((struct symt_array*)type)->start;
483 case TI_GET_DATAKIND:
484 if (type->tag != SymTagData) return FALSE;
485 X(DWORD) = ((struct symt_data*)type)->kind;
492 X(DWORD) = ((struct symt_basic*)type)->size;
495 X(DWORD) = ((struct symt_function*)type)->size;
497 case SymTagPointerType:
498 X(DWORD) = sizeof(void*);
501 X(DWORD) = ((struct symt_udt*)type)->size;
504 X(DWORD) = sizeof(int);
507 if (((struct symt_data*)type)->location == LocIsBitField)
508 X(DWORD) = ((struct symt_data*)type)->u.bitfield.length;
510 return symt_get_info(((struct symt_data*)type)->type,
511 TI_GET_LENGTH, pInfo);
513 case SymTagArrayType:
514 if (!symt_get_info(((struct symt_array*)type)->basetype,
515 TI_GET_LENGTH, pInfo))
517 X(DWORD) *= ((struct symt_array*)type)->end -
518 ((struct symt_array*)type)->start;
520 case SymTagPublicSymbol:
521 X(DWORD) = ((struct symt_public*)type)->size;
524 FIXME("Unsupported sym-tag %s for get-size\n", symt_get_tag_str(type->tag));
529 case TI_GET_LEXICALPARENT:
533 X(DWORD) = (DWORD)((struct symt_block*)type)->container;
536 X(DWORD) = (DWORD)((struct symt_data*)type)->container;
539 FIXME("Unsupported sym-tag %s for get-lexical-parent\n", symt_get_tag_str(type->tag));
548 switch (((struct symt_data*)type)->location)
552 X(ULONG) = ((struct symt_data*)type)->u.offset;
555 X(ULONG) = 0; /* FIXME ???? */
558 FIXME("Unknown location (%u) for get-offset\n",
559 ((struct symt_data*)type)->location);
564 FIXME("Unsupported sym-tag %s for get-offset\n", symt_get_tag_str(type->tag));
571 const char* name = symt_get_name(type);
572 if (!name) return FALSE;
573 len = MultiByteToWideChar(CP_ACP, 0, name, -1, NULL, 0);
574 X(WCHAR*) = HeapAlloc(GetProcessHeap(), 0, len * sizeof(WCHAR));
575 if (!X(WCHAR*)) return FALSE;
576 MultiByteToWideChar(CP_ACP, 0, name, -1, X(WCHAR*), len);
581 X(DWORD) = type->tag;
587 case SymTagArrayType:
588 X(DWORD) = (DWORD)((struct symt_array*)type)->basetype;
590 case SymTagPointerType:
591 X(DWORD) = (DWORD)((struct symt_pointer*)type)->pointsto;
593 case SymTagFunctionType:
594 X(DWORD) = (DWORD)((struct symt_function_signature*)type)->rettype;
597 X(DWORD) = (DWORD)((struct symt_data*)type)->type;
600 FIXME("Unsupported sym-tag %s for get-type\n", symt_get_tag_str(type->tag));
606 X(DWORD) = (DWORD)type;
610 if (type->tag != SymTagUDT) return FALSE;
611 X(DWORD) = ((struct symt_udt*)type)->kind;
616 case TI_GET_ADDRESSOFFSET:
617 case TI_GET_ARRAYINDEXTYPEID:
618 case TI_GET_CALLING_CONVENTION:
619 case TI_GET_CLASSPARENTID:
621 case TI_GET_SYMINDEX:
622 case TI_GET_THISADJUST:
624 case TI_GET_VIRTUALBASECLASS:
625 case TI_GET_VIRTUALBASEPOINTEROFFSET:
626 case TI_GET_VIRTUALTABLESHAPEID:
628 FIXME("Unsupported GetInfo request (%u)\n", req);
635 /******************************************************************
636 * SymGetTypeInfo (DBGHELP.@)
639 BOOL WINAPI SymGetTypeInfo(HANDLE hProcess, unsigned long ModBase,
640 ULONG TypeId, IMAGEHLP_SYMBOL_TYPE_INFO GetType,
643 struct process* pcs = process_find_by_handle(hProcess);
645 if (!pcs) return FALSE;
647 struct module* module;
648 module = module_find_by_addr(pcs, ModBase, DMT_UNKNOWN);
649 if (!(module = module_get_debug(pcs, module))) return FALSE;
652 return symt_get_info((struct symt*)TypeId, GetType, pInfo);
655 /******************************************************************
656 * SymGetTypeFromName (DBGHELP.@)
659 BOOL WINAPI SymGetTypeFromName(HANDLE hProcess, unsigned long BaseOfDll,
660 LPSTR Name, PSYMBOL_INFO Symbol)
662 struct process* pcs = process_find_by_handle(hProcess);
663 struct module* module;
666 if (!pcs) return FALSE;
667 module = module_find_by_addr(pcs, BaseOfDll, DMT_UNKNOWN);
668 if (!module) return FALSE;
669 type = symt_find_type_by_name(module, SymTagNull, Name);
670 if (!type) return FALSE;
671 Symbol->TypeIndex = (DWORD)type;