2 * File types.c - datatype handling stuff for internal debugger.
4 * Copyright (C) 1997, Eric Youngdale.
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with this library; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20 * Note: This really doesn't do much at the moment, but it forms the framework
21 * upon which full support for datatype handling will eventually be built.
28 #include "wine/debug.h"
30 WINE_DEFAULT_DEBUG_CHANNEL(winedbg
);
32 /******************************************************************
33 * types_extract_as_integer
35 * Given a lvalue, try to get an integral (or pointer/address) value
38 long int types_extract_as_integer(const struct dbg_lvalue
* lvalue
)
42 DWORD linear
= (DWORD
)memory_to_linear_addr(&lvalue
->addr
);
44 assert(lvalue
->cookie
== DLV_TARGET
|| lvalue
->cookie
== DLV_HOST
);
46 if (lvalue
->typeid == dbg_itype_none
||
47 !types_get_info(linear
, lvalue
->typeid, TI_GET_SYMTAG
, &tag
))
53 if (!types_get_info(linear
, lvalue
->typeid, TI_GET_LENGTH
, &size
) ||
54 !types_get_info(linear
, lvalue
->typeid, TI_GET_BASETYPE
, &bt
))
56 WINE_ERR("Couldn't get information\n");
57 RaiseException(DEBUG_STATUS_INTERNAL_ERROR
, 0, 0, NULL
);
59 if (size
> sizeof(rtn
))
61 WINE_ERR("Size too large (%lu)\n", size
);
64 /* FIXME: we have an ugly & non portable thing here !!! */
65 if (!memory_read_value(lvalue
, size
, &rtn
)) return 0;
67 /* now let's do some promotions !! */
71 /* propagate sign information */
72 if (((size
& 3) != 0) && (rtn
>> (size
* 8 - 1)) != 0)
73 rtn
|= (-1) << (size
* 8);
79 RaiseException(DEBUG_STATUS_NOT_AN_INTEGER
, 0, 0, NULL
);
82 case SymTagPointerType
:
83 if (!memory_read_value(lvalue
, sizeof(void*), &rtn
)) return 0;
87 assert(lvalue
->cookie
== DLV_TARGET
);
88 if (!memory_read_value(lvalue
, sizeof(rtn
), &rtn
)) return 0;
91 assert(lvalue
->cookie
== DLV_TARGET
);
92 if (!memory_read_value(lvalue
, sizeof(rtn
), &rtn
)) return 0;
95 WINE_FIXME("Unsupported tag %lu\n", tag
);
103 /******************************************************************
107 BOOL
types_deref(const struct dbg_lvalue
* lvalue
, struct dbg_lvalue
* result
)
110 DWORD linear
= (DWORD
)memory_to_linear_addr(&lvalue
->addr
);
112 assert(lvalue
->cookie
== DLV_TARGET
|| lvalue
->cookie
== DLV_HOST
);
114 memset(result
, 0, sizeof(*result
));
115 result
->typeid = dbg_itype_none
;
118 * Make sure that this really makes sense.
120 if (!types_get_info(linear
, lvalue
->typeid, TI_GET_SYMTAG
, &tag
) ||
121 tag
!= SymTagPointerType
||
122 memory_read_value(lvalue
, sizeof(result
->addr
.Offset
), &result
->addr
.Offset
) ||
123 !types_get_info(linear
, lvalue
->typeid, TI_GET_TYPE
, &result
->typeid))
126 result
->cookie
= DLV_TARGET
; /* see comment on DEREF below */
127 result
->addr
.Mode
= AddrModeFlat
;
131 /******************************************************************
132 * types_get_udt_element_lvalue
134 * Implement a structure derefencement
136 static BOOL
types_get_udt_element_lvalue(struct dbg_lvalue
* lvalue
, DWORD linear
,
137 DWORD
typeid, long int* tmpbuf
)
139 DWORD offset
, length
, bitoffset
;
143 types_get_info(linear
, typeid, TI_GET_TYPE
, &lvalue
->typeid);
144 types_get_info(linear
, typeid, TI_GET_OFFSET
, &offset
);
146 if (types_get_info(linear
, typeid, TI_GET_BITPOSITION
, &bitoffset
))
148 types_get_info(linear
, typeid, TI_GET_LENGTH
, &length
);
149 if (length
> sizeof(*tmpbuf
)) return FALSE
;
151 * Bitfield operation. We have to extract the field and store
152 * it in a temporary buffer so that we get it all right.
154 lvalue
->addr
.Offset
+= offset
;
155 if (!memory_read_value(lvalue
, sizeof(*tmpbuf
), tmpbuf
)) return FALSE
;
156 mask
= 0xffffffff << length
;
157 *tmpbuf
>>= bitoffset
& 7;
160 lvalue
->cookie
= DLV_HOST
;
161 lvalue
->addr
.Mode
= AddrModeFlat
;
162 lvalue
->addr
.Offset
= (DWORD
)tmpbuf
;
165 * OK, now we have the correct part of the number.
166 * Check to see whether the basic type is signed or not, and if so,
167 * we need to sign extend the number.
169 if (types_get_info(linear
, lvalue
->typeid, TI_GET_BASETYPE
, &bt
) &&
170 bt
== btInt
&& (*tmpbuf
& (1 << (length
- 1))))
176 if (types_get_info(linear
, typeid, TI_GET_OFFSET
, &offset
))
178 lvalue
->addr
.Offset
+= offset
;
184 /******************************************************************
185 * types_udt_find_element
188 BOOL
types_udt_find_element(struct dbg_lvalue
* lvalue
, const char* name
, long int* tmpbuf
)
190 DWORD linear
= (DWORD
)memory_to_linear_addr(&lvalue
->addr
);
192 char buffer
[sizeof(TI_FINDCHILDREN_PARAMS
) + 256 * sizeof(DWORD
)];
193 TI_FINDCHILDREN_PARAMS
* fcp
= (TI_FINDCHILDREN_PARAMS
*)buffer
;
198 assert(lvalue
->cookie
== DLV_TARGET
|| lvalue
->cookie
== DLV_HOST
);
200 if (!types_get_info(linear
, lvalue
->typeid, TI_GET_SYMTAG
, &tag
) ||
204 if (types_get_info(linear
, lvalue
->typeid, TI_GET_CHILDRENCOUNT
, &count
))
209 fcp
->Count
= min(count
, 256);
210 if (types_get_info(linear
, lvalue
->typeid, TI_FINDCHILDREN
, fcp
))
212 for (i
= 0; i
< min(fcp
->Count
, count
); i
++)
215 types_get_info(linear
, fcp
->ChildId
[i
], TI_GET_SYMNAME
, &ptr
);
217 WideCharToMultiByte(CP_ACP
, 0, ptr
, -1, tmp
, sizeof(tmp
), NULL
, NULL
);
218 HeapFree(GetProcessHeap(), 0, ptr
);
219 if (strcmp(tmp
, name
)) continue;
221 return types_get_udt_element_lvalue(lvalue
, linear
,
222 fcp
->ChildId
[i
], tmpbuf
);
225 count
-= min(count
, 256);
232 /******************************************************************
235 * Grab an element from an array
237 BOOL
types_array_index(const struct dbg_lvalue
* lvalue
, int index
,
238 struct dbg_lvalue
* result
)
240 DWORD tag
, length
, count
;
241 DWORD linear
= (DWORD
)memory_to_linear_addr(&lvalue
->addr
);
243 assert(lvalue
->cookie
== DLV_TARGET
|| lvalue
->cookie
== DLV_HOST
);
245 if (!types_get_info(0, lvalue
->typeid, TI_GET_SYMTAG
, &tag
))
249 case SymTagArrayType
:
250 types_get_info(linear
, lvalue
->typeid, TI_GET_COUNT
, &count
);
251 if (index
< 0 || index
>= count
) return FALSE
;
253 case SymTagPointerType
:
255 * Get the base type, so we know how much to index by.
257 types_get_info(linear
, lvalue
->typeid, TI_GET_TYPE
, &result
->typeid);
258 types_get_info(linear
, result
->typeid, TI_GET_LENGTH
, &length
);
259 /* Contents of array must be on same target */
260 result
->cookie
= lvalue
->cookie
;
261 result
->addr
.Mode
= lvalue
->addr
.Mode
;
262 memory_read_value(lvalue
, sizeof(result
->addr
.Offset
), &result
->addr
.Offset
);
263 result
->addr
.Offset
+= index
* length
;
273 unsigned long result
; /* out: the found type */
274 enum SymTagEnum tag
; /* in: the tag to look for */
277 unsigned long typeid;
282 static BOOL CALLBACK
types_cb(PSYMBOL_INFO sym
, ULONG size
, void* _user
)
284 struct type_find_t
* user
= (struct type_find_t
*)_user
;
288 if (sym
->Tag
== user
->tag
)
293 if (!strcmp(user
->u
.name
, sym
->Name
))
295 user
->result
= sym
->TypeIndex
;
299 case SymTagPointerType
:
300 types_get_info(sym
->ModBase
, sym
->TypeIndex
, TI_GET_TYPE
, &typeid);
301 if (types_get_info(sym
->ModBase
, sym
->TypeIndex
, TI_GET_TYPE
, &typeid) &&
302 typeid == user
->u
.typeid)
304 user
->result
= sym
->TypeIndex
;
313 /******************************************************************
316 * Should look up in module based at linear whether (typeid*) exists
317 * Otherwise, we could create it locally
319 unsigned long types_find_pointer(unsigned long linear
, unsigned long typeid)
321 struct type_find_t f
;
322 f
.result
= dbg_itype_none
;
323 f
.tag
= SymTagPointerType
;
325 SymEnumTypes(dbg_curr_process
->handle
, linear
, types_cb
, &f
);
329 /******************************************************************
332 * Should look up in the module based at linear address whether a type
333 * named 'name' and with the correct tag exists
335 unsigned long types_find_type(unsigned long linear
, const char* name
, enum SymTagEnum tag
)
338 struct type_find_t f
;
339 f
.result
= dbg_itype_none
;
342 SymEnumTypes(dbg_curr_process
->handle
, linear
, types_cb
, &f
);
346 /***********************************************************************
349 * Implementation of the 'print' command.
351 void print_value(const struct dbg_lvalue
* lvalue
, char format
, int level
)
353 struct dbg_lvalue lvalue_field
;
355 unsigned long linear
;
360 assert(lvalue
->cookie
== DLV_TARGET
|| lvalue
->cookie
== DLV_HOST
);
361 linear
= (unsigned long)memory_to_linear_addr(&lvalue
->addr
);
363 if (lvalue
->typeid == dbg_itype_none
)
365 /* No type, just print the addr value */
366 print_bare_address(&lvalue
->addr
);
370 if (format
== 'i' || format
== 's' || format
== 'w' || format
== 'b' || format
== 'g')
372 dbg_printf("Format specifier '%c' is meaningless in 'print' command\n", format
);
376 if (!types_get_info(linear
, lvalue
->typeid, TI_GET_SYMTAG
, &tag
))
378 WINE_FIXME("---error\n");
385 case SymTagPointerType
:
386 print_basic(lvalue
, 1, format
);
389 if (types_get_info(linear
, lvalue
->typeid, TI_GET_CHILDRENCOUNT
, &count
))
391 char buffer
[sizeof(TI_FINDCHILDREN_PARAMS
) + 256 * sizeof(DWORD
)];
392 TI_FINDCHILDREN_PARAMS
* fcp
= (TI_FINDCHILDREN_PARAMS
*)buffer
;
401 fcp
->Count
= min(count
, 256);
402 if (types_get_info(linear
, lvalue
->typeid, TI_FINDCHILDREN
, fcp
))
404 for (i
= 0; i
< min(fcp
->Count
, count
); i
++)
407 types_get_info(linear
, fcp
->ChildId
[i
], TI_GET_SYMNAME
, &ptr
);
409 WideCharToMultiByte(CP_ACP
, 0, ptr
, -1, tmp
, sizeof(tmp
), NULL
, NULL
);
410 dbg_printf("%s=", tmp
);
411 HeapFree(GetProcessHeap(), 0, ptr
);
412 lvalue_field
= *lvalue
;
413 if (types_get_udt_element_lvalue(&lvalue_field
, linear
,
414 fcp
->ChildId
[i
], &tmpbuf
))
416 print_value(&lvalue_field
, format
, level
+ 1);
418 if (i
< min(fcp
->Count
, count
) - 1 || count
> 256) dbg_printf(", ");
421 count
-= min(count
, 256);
427 case SymTagArrayType
:
429 * Loop over all of the entries, printing stuff as we go.
432 types_get_info(linear
, lvalue
->typeid, TI_GET_COUNT
, &count
);
433 types_get_info(linear
, lvalue
->typeid, TI_GET_LENGTH
, &size
);
440 * Special handling for character arrays.
442 /* FIXME should check basic type here (should be a char!!!!)... */
443 len
= min(count
, sizeof(buffer
));
444 memory_get_string(dbg_curr_thread
->handle
,
445 memory_to_linear_addr(&lvalue
->addr
),
446 lvalue
->cookie
, TRUE
, buffer
, len
);
447 dbg_printf("\"%s%s\"", buffer
, (len
< count
) ? "..." : "");
450 lvalue_field
= *lvalue
;
451 types_get_info(linear
, lvalue
->typeid, TI_GET_TYPE
, &lvalue_field
.typeid);
453 for (i
= 0; i
< count
; i
++)
455 print_value(&lvalue_field
, format
, level
+ 1);
456 lvalue_field
.addr
.Offset
+= size
/ count
;
457 dbg_printf((i
== count
- 1) ? "}" : ", ");
460 case SymTagFunctionType
:
461 dbg_printf("Function ");
462 print_bare_address(&lvalue
->addr
);
464 types_print_type(linear
, lvalue
->typeid, FALSE
);
467 WINE_FIXME("Unknown tag (%lu)\n", tag
);
468 RaiseException(DEBUG_STATUS_INTERNAL_ERROR
, 0, 0, NULL
);
474 if (level
== 0) dbg_printf("\n");
477 static BOOL CALLBACK
print_types_cb(PSYMBOL_INFO sym
, ULONG size
, void* ctx
)
479 types_print_type(sym
->ModBase
, sym
->TypeIndex
, TRUE
);
484 static BOOL CALLBACK
print_types_mod_cb(PSTR mod_name
, DWORD base
, void* ctx
)
486 return SymEnumTypes(dbg_curr_process
->handle
, base
, print_types_cb
, ctx
);
489 int print_types(void)
491 SymEnumerateModules(dbg_curr_process
->handle
, print_types_mod_cb
, NULL
);
495 int types_print_type(DWORD linear
, DWORD
typeid, BOOL details
)
500 DWORD tag
, subtype
, count
;
502 if (typeid == dbg_itype_none
|| !types_get_info(linear
, typeid, TI_GET_SYMTAG
, &tag
))
504 dbg_printf("--invalid--<%lxh>--", typeid);
508 if (types_get_info(linear
, typeid, TI_GET_SYMNAME
, &ptr
) && ptr
)
510 WideCharToMultiByte(CP_ACP
, 0, ptr
, -1, tmp
, sizeof(tmp
), NULL
, NULL
);
512 HeapFree(GetProcessHeap(), 0, ptr
);
514 else name
= "--none--";
519 if (details
) dbg_printf("Basic<%s>", name
); else dbg_printf("%s", name
);
521 case SymTagPointerType
:
522 types_get_info(linear
, typeid, TI_GET_TYPE
, &subtype
);
523 types_print_type(linear
, subtype
, details
);
527 types_get_info(linear
, typeid, TI_GET_UDTKIND
, &subtype
);
530 case UdtStruct
: dbg_printf("struct %s", name
); break;
531 case UdtUnion
: dbg_printf("union %s", name
); break;
532 case UdtClass
: dbg_printf("class %s", name
); break;
535 types_get_info(linear
, typeid, TI_GET_CHILDRENCOUNT
, &count
))
537 char buffer
[sizeof(TI_FINDCHILDREN_PARAMS
) + 256 * sizeof(DWORD
)];
538 TI_FINDCHILDREN_PARAMS
* fcp
= (TI_FINDCHILDREN_PARAMS
*)buffer
;
548 fcp
->Count
= min(count
, 256);
549 if (types_get_info(linear
, typeid, TI_FINDCHILDREN
, fcp
))
551 for (i
= 0; i
< min(fcp
->Count
, count
); i
++)
554 types_get_info(linear
, fcp
->ChildId
[i
], TI_GET_SYMNAME
, &ptr
);
556 WideCharToMultiByte(CP_ACP
, 0, ptr
, -1, tmp
, sizeof(tmp
), NULL
, NULL
);
557 HeapFree(GetProcessHeap(), 0, ptr
);
558 dbg_printf("%s", tmp
);
559 if (types_get_info(linear
, fcp
->ChildId
[i
], TI_GET_TYPE
, &subtype
))
562 types_print_type(linear
, subtype
, details
);
564 if (i
< min(fcp
->Count
, count
) - 1 || count
> 256) dbg_printf(", ");
567 count
-= min(count
, 256);
573 case SymTagArrayType
:
574 types_get_info(linear
, typeid, TI_GET_TYPE
, &subtype
);
575 types_print_type(linear
, subtype
, details
);
576 dbg_printf(" %s[]", name
);
579 dbg_printf("enum %s", name
);
581 case SymTagFunctionType
:
582 types_get_info(linear
, typeid, TI_GET_TYPE
, &subtype
);
583 types_print_type(linear
, subtype
, FALSE
);
584 dbg_printf(" (*%s)(", name
);
585 if (types_get_info(linear
, typeid, TI_GET_CHILDRENCOUNT
, &count
))
587 char buffer
[sizeof(TI_FINDCHILDREN_PARAMS
) + 256 * sizeof(DWORD
)];
588 TI_FINDCHILDREN_PARAMS
* fcp
= (TI_FINDCHILDREN_PARAMS
*)buffer
;
594 fcp
->Count
= min(count
, 256);
595 if (types_get_info(linear
, typeid, TI_FINDCHILDREN
, fcp
))
597 for (i
= 0; i
< min(fcp
->Count
, count
); i
++)
599 types_print_type(linear
, fcp
->ChildId
[i
], FALSE
);
600 if (i
< min(fcp
->Count
, count
) - 1 || count
> 256) dbg_printf(", ");
603 count
-= min(count
, 256);
610 WINE_ERR("Unknown type %lu for %s\n", tag
, name
);
617 BOOL
types_get_info(unsigned long modbase
, unsigned long typeid,
618 IMAGEHLP_SYMBOL_TYPE_INFO ti
, void* pInfo
)
620 if (typeid == dbg_itype_none
) return FALSE
;
621 if (typeid < dbg_itype_first
)
626 ret
= SymGetTypeInfo(dbg_curr_process
->handle
, modbase
, typeid, ti
, pInfo
);
627 if (!ret
&& ti
== TI_GET_LENGTH
&&
628 (!SymGetTypeInfo(dbg_curr_process
->handle
, modbase
, typeid,
629 TI_GET_SYMTAG
, &tag
) || tag
== SymTagData
))
631 WINE_FIXME("get length on symtag data is no longer supported\n");
638 /* helper to typecast pInfo to its expected type (_t) */
639 #define X(_t) (*((_t*)pInfo))
643 case dbg_itype_unsigned_int
:
646 case TI_GET_SYMTAG
: X(DWORD
) = SymTagBaseType
; break;
647 case TI_GET_LENGTH
: X(DWORD
) = 4; break;
648 case TI_GET_BASETYPE
: X(DWORD
) = btUInt
; break;
649 default: WINE_FIXME("unsupported %u for u-int\n", ti
); return FALSE
;
652 case dbg_itype_signed_int
:
655 case TI_GET_SYMTAG
: X(DWORD
) = SymTagBaseType
; break;
656 case TI_GET_LENGTH
: X(DWORD
) = 4; break;
657 case TI_GET_BASETYPE
: X(DWORD
) = btInt
; break;
658 default: WINE_FIXME("unsupported %u for s-int\n", ti
); return FALSE
;
661 case dbg_itype_unsigned_short_int
:
664 case TI_GET_SYMTAG
: X(DWORD
) = SymTagBaseType
; break;
665 case TI_GET_LENGTH
: X(DWORD
) = 2; break;
666 case TI_GET_BASETYPE
: X(DWORD
) = btUInt
; break;
667 default: WINE_FIXME("unsupported %u for u-short int\n", ti
); return FALSE
;
670 case dbg_itype_signed_short_int
:
673 case TI_GET_SYMTAG
: X(DWORD
) = SymTagBaseType
; break;
674 case TI_GET_LENGTH
: X(DWORD
) = 2; break;
675 case TI_GET_BASETYPE
: X(DWORD
) = btInt
; break;
676 default: WINE_FIXME("unsupported %u for s-short int\n", ti
); return FALSE
;
679 case dbg_itype_unsigned_char_int
:
682 case TI_GET_SYMTAG
: X(DWORD
) = SymTagBaseType
; break;
683 case TI_GET_LENGTH
: X(DWORD
) = 1; break;
684 case TI_GET_BASETYPE
: X(DWORD
) = btUInt
; break;
685 default: WINE_FIXME("unsupported %u for u-char int\n", ti
); return FALSE
;
688 case dbg_itype_signed_char_int
:
691 case TI_GET_SYMTAG
: X(DWORD
) = SymTagBaseType
; break;
692 case TI_GET_LENGTH
: X(DWORD
) = 1; break;
693 case TI_GET_BASETYPE
: X(DWORD
) = btInt
; break;
694 default: WINE_FIXME("unsupported %u for s-char int\n", ti
); return FALSE
;
700 case TI_GET_SYMTAG
: X(DWORD
) = SymTagBaseType
; break;
701 case TI_GET_LENGTH
: X(DWORD
) = 1; break;
702 case TI_GET_BASETYPE
: X(DWORD
) = btChar
; break;
703 default: WINE_FIXME("unsupported %u for char int\n", ti
); return FALSE
;
706 case dbg_itype_astring
:
709 case TI_GET_SYMTAG
: X(DWORD
) = SymTagPointerType
; break;
710 case TI_GET_LENGTH
: X(DWORD
) = 4; break;
711 case TI_GET_TYPE
: X(DWORD
) = dbg_itype_char
; break;
712 default: WINE_FIXME("unsupported %u for a string\n", ti
); return FALSE
;
715 default: WINE_FIXME("unsupported typeid 0x%lx\n", typeid);