6 * Copyright (C) 2003 - 2004 Eric Pouech
7 * Copyright (C) 2008 Vladimir Pankratov
9 * This library is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU Lesser General Public
11 * License as published by the Free Software Foundation; either
12 * version 2.1 of the License, or (at your option) any later version.
14 * This library is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 * Lesser General Public License for more details.
19 * You should have received a copy of the GNU Lesser General Public
20 * License along with this library; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
24 #define WIN32_LEAN_AND_MEAN /* Exclude rarely-used stuff from Windows headers */
37 #include "wine/debug.h"
40 * - the dialog box could be non modal
42 * + could refresh channels from time to time
43 * + set the name of exec (and perhaps its pid) in dialog title
44 * - get a better UI (replace the 'x' by real tick boxes in list view)
45 * - enhance visual feedback: the list is large, and it's hard to get the
46 * right line when clicking on rightmost column (trace for example)
47 * - get rid of printfs (error reporting) and use real message boxes
48 * - include the column width settings in the full column management scheme
49 * - use more global settings (like having a temporary on/off
50 * setting for a fixme:s or err:s
53 static DWORD (WINAPI
*pSymSetOptions
)(DWORD
);
54 static BOOL (WINAPI
*pSymInitialize
)(HANDLE
, PSTR
, BOOL
);
55 static DWORD (WINAPI
*pSymLoadModule
)(HANDLE
, HANDLE
, PCSTR
, PCSTR
, DWORD
, DWORD
);
56 static BOOL (WINAPI
*pSymCleanup
)(HANDLE
);
57 static BOOL (WINAPI
*pSymFromName
)(HANDLE
, PCSTR
, PSYMBOL_INFO
);
59 BOOL
AreDebugChannelsSupported(void)
61 static HANDLE hDbgHelp
/* = NULL */;
63 static const WCHAR wszDbgHelp
[] = {'D','B','G','H','E','L','P','.','D','L','L',0};
65 if (hDbgHelp
) return TRUE
;
67 if (!(hDbgHelp
= LoadLibraryW(wszDbgHelp
))) return FALSE
;
68 pSymSetOptions
= (void*)GetProcAddress(hDbgHelp
, "SymSetOptions");
69 pSymInitialize
= (void*)GetProcAddress(hDbgHelp
, "SymInitialize");
70 pSymLoadModule
= (void*)GetProcAddress(hDbgHelp
, "SymLoadModule");
71 pSymFromName
= (void*)GetProcAddress(hDbgHelp
, "SymFromName");
72 pSymCleanup
= (void*)GetProcAddress(hDbgHelp
, "SymCleanup");
73 if (!pSymSetOptions
|| !pSymInitialize
|| !pSymLoadModule
|| !pSymCleanup
|| !pSymFromName
)
75 FreeLibrary(hDbgHelp
);
82 static DWORD
get_selected_pid(void)
88 for (Index
= 0; Index
< (ULONG
)ListView_GetItemCount(hProcessPageListCtrl
); Index
++)
90 lvitem
.mask
= LVIF_STATE
;
91 lvitem
.stateMask
= LVIS_SELECTED
;
95 SendMessage(hProcessPageListCtrl
, LVM_GETITEM
, 0, (LPARAM
) &lvitem
);
97 if (lvitem
.state
& LVIS_SELECTED
)
101 dwProcessId
= PerfDataGetProcessId(Index
);
103 if ((ListView_GetSelectedCount(hProcessPageListCtrl
) != 1) || (dwProcessId
== 0))
108 static int list_channel_CB(HANDLE hProcess
, void* addr
, struct __wine_debug_channel
* channel
, void* user
)
114 HWND hChannelLV
= user
;
116 lvitem
.mask
= LVIF_TEXT
;
117 lvitem
.pszText
= channel
->name
;
121 index
= ListView_InsertItem(hChannelLV
, &lvitem
);
122 if (index
== -1) return 0;
125 for (j
= 0; j
< 4; j
++)
127 val
[0] = (channel
->flags
& (1 << j
)) ? 'x' : ' ';
128 ListView_SetItemTextW(hChannelLV
, index
, j
+ 1, val
);
135 const char* name
; /* channel to look for */
136 unsigned value
, mask
; /* how to change channel */
137 unsigned done
; /* number of successful changes */
138 unsigned notdone
; /* number of unsuccessful changes */
141 /******************************************************************
144 * Callback used for changing a given channel attributes
146 static int change_channel_CB(HANDLE hProcess
, void* addr
, struct __wine_debug_channel
*channel
, void* pmt
)
148 struct cce_user
* user
= (struct cce_user
*)pmt
;
150 if (!user
->name
|| !strcmp(channel
->name
, user
->name
))
152 channel
->flags
= (channel
->flags
& ~user
->mask
) | (user
->value
& user
->mask
);
153 if (WriteProcessMemory(hProcess
, addr
, channel
, sizeof(*channel
), NULL
))
161 static void* get_symbol(HANDLE hProcess
, const char* name
)
163 char buffer
[sizeof(IMAGEHLP_SYMBOL
) + 256];
164 SYMBOL_INFO
* si
= (SYMBOL_INFO
*)buffer
;
167 /* also ask for wine extensions (loading symbols from ELF files) */
168 pSymSetOptions(SYMOPT_DEFERRED_LOADS
| SYMOPT_PUBLICS_ONLY
| 0x40000000);
169 /* FIXME: the TRUE option is due to the fact that dbghelp requires it
170 * when loading an ELF module
172 if (pSymInitialize(hProcess
, NULL
, TRUE
))
174 si
->SizeOfStruct
= sizeof(*si
);
175 si
->MaxNameLen
= sizeof(buffer
) - sizeof(IMAGEHLP_SYMBOL
);
176 if (pSymFromName(hProcess
, name
, si
))
177 ret
= (void*)(ULONG_PTR
)si
->Address
;
178 pSymCleanup(hProcess
);
183 typedef int (*EnumChannelCB
)(HANDLE
, void*, struct __wine_debug_channel
*, void*);
185 /******************************************************************
188 * Enumerates all known channels on process hProcess through callback
191 static int enum_channel(HANDLE hProcess
, EnumChannelCB ce
, void* user
)
193 struct __wine_debug_channel channel
;
197 if (!(addr
= get_symbol(hProcess
, "libwine.so.1!debug_options"))) return -1;
199 while (ret
&& addr
&& ReadProcessMemory(hProcess
, addr
, &channel
, sizeof(channel
), NULL
))
201 if (!channel
.name
[0]) break;
202 ret
= ce(hProcess
, addr
, &channel
, user
);
203 addr
= (struct __wine_debug_channel
*)addr
+ 1;
208 static void DebugChannels_FillList(HWND hChannelLV
)
212 SendMessage(hChannelLV
, LVM_DELETEALLITEMS
, 0, 0);
214 hProcess
= OpenProcess(PROCESS_QUERY_INFORMATION
| PROCESS_VM_OPERATION
| PROCESS_VM_READ
, FALSE
, get_selected_pid());
215 if (!hProcess
) return; /* FIXME messagebox */
216 SendMessage(hChannelLV
, WM_SETREDRAW
, FALSE
, 0);
217 enum_channel(hProcess
, list_channel_CB
, (void*)hChannelLV
);
218 SendMessage(hChannelLV
, WM_SETREDRAW
, TRUE
, 0);
219 CloseHandle(hProcess
);
222 static void DebugChannels_OnCreate(HWND hwndDlg
)
224 HWND hLV
= GetDlgItem(hwndDlg
, IDC_DEBUG_CHANNELS_LIST
);
227 WCHAR debug_channelW
[255];
233 LoadStringW(hInst
, IDS_DEBUG_CHANNEL
, debug_channelW
, sizeof(debug_channelW
)/sizeof(WCHAR
));
234 LoadStringW(hInst
, IDS_DEBUG_CHANNEL_FIXME
, fixmeW
, sizeof(fixmeW
)/sizeof(WCHAR
));
235 LoadStringW(hInst
, IDS_DEBUG_CHANNEL_ERR
, errW
, sizeof(errW
)/sizeof(WCHAR
));
236 LoadStringW(hInst
, IDS_DEBUG_CHANNEL_WARN
, warnW
, sizeof(warnW
)/sizeof(WCHAR
));
237 LoadStringW(hInst
, IDS_DEBUG_CHANNEL_TRACE
, traceW
, sizeof(traceW
)/sizeof(WCHAR
));
239 lvc
.mask
= LVCF_FMT
| LVCF_TEXT
| LVCF_WIDTH
;
240 lvc
.fmt
= LVCFMT_LEFT
;
241 lvc
.pszText
= debug_channelW
;
243 SendMessageW(hLV
, LVM_INSERTCOLUMNW
, 0, (LPARAM
) &lvc
);
245 lvc
.mask
= LVCF_FMT
| LVCF_TEXT
| LVCF_WIDTH
;
246 lvc
.fmt
= LVCFMT_CENTER
;
247 lvc
.pszText
= fixmeW
;
249 SendMessageW(hLV
, LVM_INSERTCOLUMNW
, 1, (LPARAM
) &lvc
);
251 lvc
.mask
= LVCF_FMT
| LVCF_TEXT
| LVCF_WIDTH
;
252 lvc
.fmt
= LVCFMT_CENTER
;
255 SendMessageW(hLV
, LVM_INSERTCOLUMNW
, 2, (LPARAM
) &lvc
);
257 lvc
.mask
= LVCF_FMT
| LVCF_TEXT
| LVCF_WIDTH
;
258 lvc
.fmt
= LVCFMT_CENTER
;
261 SendMessageW(hLV
, LVM_INSERTCOLUMNW
, 3, (LPARAM
) &lvc
);
263 lvc
.mask
= LVCF_FMT
| LVCF_TEXT
| LVCF_WIDTH
;
264 lvc
.fmt
= LVCFMT_CENTER
;
265 lvc
.pszText
= traceW
;
267 SendMessageW(hLV
, LVM_INSERTCOLUMNW
, 4, (LPARAM
) &lvc
);
269 DebugChannels_FillList(hLV
);
272 static void DebugChannels_OnNotify(HWND hDlg
, LPARAM lParam
)
274 NMHDR
* nmh
= (NMHDR
*)lParam
;
279 if (nmh
->idFrom
== IDC_DEBUG_CHANNELS_LIST
)
284 NMITEMACTIVATE
* nmia
= (NMITEMACTIVATE
*)lParam
;
286 hProcess
= OpenProcess(PROCESS_VM_OPERATION
| PROCESS_VM_READ
| PROCESS_VM_WRITE
, FALSE
, get_selected_pid());
287 if (!hProcess
) return; /* FIXME message box */
288 lhti
.pt
= nmia
->ptAction
;
289 hChannelLV
= GetDlgItem(hDlg
, IDC_DEBUG_CHANNELS_LIST
);
290 SendMessage(hChannelLV
, LVM_SUBITEMHITTEST
, 0, (LPARAM
)&lhti
);
291 if (nmia
->iSubItem
>= 1 && nmia
->iSubItem
<= 4)
295 unsigned bitmask
= 1 << (lhti
.iSubItem
- 1);
296 struct cce_user user
;
298 ListView_GetItemTextA(hChannelLV
, lhti
.iItem
, 0, name
, sizeof(name
) / sizeof(name
[0]));
299 ListView_GetItemTextW(hChannelLV
, lhti
.iItem
, lhti
.iSubItem
, val
, sizeof(val
) / sizeof(val
[0]));
301 user
.value
= (val
[0] == 'x') ? 0 : bitmask
;
303 user
.done
= user
.notdone
= 0;
304 enum_channel(hProcess
, change_channel_CB
, &user
);
307 val
[0] ^= ('x' ^ ' ');
308 ListView_SetItemTextW(hChannelLV
, lhti
.iItem
, lhti
.iSubItem
, val
);
311 printf("Some channel instances weren't correctly set\n");
313 CloseHandle(hProcess
);
319 static INT_PTR CALLBACK
DebugChannelsDlgProc(HWND hDlg
, UINT message
, WPARAM wParam
, LPARAM lParam
)
324 DebugChannels_OnCreate(hDlg
);
327 if (LOWORD(wParam
) == IDOK
|| LOWORD(wParam
) == IDCANCEL
)
329 EndDialog(hDlg
, LOWORD(wParam
));
334 DebugChannels_OnNotify(hDlg
, lParam
);
340 void ProcessPage_OnDebugChannels(void)
342 DialogBoxW(hInst
, (LPCWSTR
)IDD_DEBUG_CHANNELS_DIALOG
, hMainWnd
, DebugChannelsDlgProc
);