programs/taskmgr/dbgchnl.c

   1 /*
   2  *  ReactOS Task Manager
   3  *
   4  *  dbgchnl.c
   5  *
   6  *  Copyright (C) 2003 - 2004 Eric Pouech
   7  *
   8  * This library is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU Lesser General Public
  10  * License as published by the Free Software Foundation; either
  11  * version 2.1 of the License, or (at your option) any later version.
  12  *
  13  * This library is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * Lesser General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU Lesser General Public
  19  * License along with this library; if not, write to the Free Software
  20  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  21  */
  22
  23 #define WIN32_LEAN_AND_MEAN    /* Exclude rarely-used stuff from Windows headers */
  24 #include <windows.h>
  25 #include <commctrl.h>
  26 #include <stdlib.h>
  27 #include <malloc.h>
  28 #include <memory.h>
  29 #include <tchar.h>
  30 #include <stdio.h>
  31 #include <winnt.h>
  32 #include <dbghelp.h>
  33
  34 #include "taskmgr.h"
  35 #include "perfdata.h"
  36 #include "column.h"
  37 #include <ctype.h>
  38
  39 /* TODO:
  40  *      - the dialog box could be non modal
  41  *      - in that case,
  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
  51  */
  52
  53 static DWORD (WINAPI *pSymSetOptions)(DWORD);
  54 static BOOL  (WINAPI *pSymInitialize)(HANDLE, PSTR, BOOL);
  55 static DWORD (WINAPI *pSymLoadModule)(HANDLE, HANDLE, PSTR, PSTR, DWORD, DWORD);
  56 static BOOL  (WINAPI *pSymCleanup)(HANDLE);
  57 static BOOL  (WINAPI *pSymFromName)(HANDLE, LPSTR, PSYMBOL_INFO);
  58
  59 BOOL AreDebugChannelsSupported(void)
  60 {
  61     static HANDLE   hDbgHelp /* = NULL */;
  62
  63     if (hDbgHelp) return TRUE;
  64
  65     if (!(hDbgHelp = LoadLibrary("dbghelp.dll"))) return FALSE;
  66     pSymSetOptions = (void*)GetProcAddress(hDbgHelp, "SymSetOptions");
  67     pSymInitialize = (void*)GetProcAddress(hDbgHelp, "SymInitialize");
  68     pSymLoadModule = (void*)GetProcAddress(hDbgHelp, "SymLoadModule");
  69     pSymFromName   = (void*)GetProcAddress(hDbgHelp, "SymFromName");
  70     pSymCleanup    = (void*)GetProcAddress(hDbgHelp, "SymCleanup");
  71     if (!pSymSetOptions || !pSymInitialize || !pSymLoadModule || !pSymCleanup || !pSymFromName)
  72     {
  73         FreeLibrary(hDbgHelp);
  74         hDbgHelp = NULL;
  75         return FALSE;
  76     }
  77     return TRUE;
  78 }
  79
  80 static DWORD    get_selected_pid(void)
  81 {
  82     LVITEM      lvitem;
  83     ULONG       Index;
  84     DWORD       dwProcessId;
  85
  86     for (Index = 0; Index < (ULONG)ListView_GetItemCount(hProcessPageListCtrl); Index++)
  87     {
  88         memset(&lvitem, 0, sizeof(LVITEM));
  89
  90         lvitem.mask = LVIF_STATE;
  91         lvitem.stateMask = LVIS_SELECTED;
  92         lvitem.iItem = Index;
  93
  94         ListView_GetItem(hProcessPageListCtrl, &lvitem);
  95
  96         if (lvitem.state & LVIS_SELECTED)
  97             break;
  98     }
  99
 100     dwProcessId = PerfDataGetProcessId(Index);
 101
 102     if ((ListView_GetSelectedCount(hProcessPageListCtrl) != 1) || (dwProcessId == 0))
 103         return 0;
 104     return dwProcessId;
 105 }
 106
 107 static int     list_channel_CB(HANDLE hProcess, void* addr, char* buffer, void* user)
 108 {
 109     int         j;
 110     char        val[2];
 111     LVITEMA     lvi;
 112     int         index;
 113     HWND        hChannelLV = (HWND)user;
 114
 115     memset(&lvi, 0, sizeof(lvi));
 116
 117     lvi.mask = LVIF_TEXT;
 118     lvi.pszText = buffer + 1;
 119
 120     index = ListView_InsertItem(hChannelLV, &lvi);
 121     if (index == -1) return 0;
 122
 123     val[1] = '\0';
 124     for (j = 0; j < 4; j++)
 125     {
 126         val[0] = (buffer[0] & (1 << j)) ? 'x' : ' ';
 127         ListView_SetItemText(hChannelLV, index, j + 1, val);
 128     }
 129     return 1;
 130 }
 131
 132 struct cce_user
 133 {
 134     const char* name;           /* channel to look for */
 135     unsigned    value, mask;    /* how to change channel */
 136     unsigned    done;           /* number of successful changes */
 137     unsigned    notdone;        /* number of unsuccessful changes */
 138 };
 139
 140 /******************************************************************
 141  *              change_channel_CB
 142  *
 143  * Callback used for changing a given channel attributes
 144  */
 145 static int change_channel_CB(HANDLE hProcess, void* addr, char* buffer, void* pmt)
 146 {
 147     struct cce_user* user = (struct cce_user*)pmt;
 148
 149     if (!user->name || !strcmp(buffer + 1, user->name))
 150     {
 151         buffer[0] = (buffer[0] & ~user->mask) | (user->value & user->mask);
 152         if (WriteProcessMemory(hProcess, addr, buffer, 1, NULL))
 153             user->done++;
 154         else
 155             user->notdone++;
 156     }
 157     return 1;
 158 }
 159
 160 void* get_symbol(HANDLE hProcess, char* name, char* lib)
 161 {
 162     char                buffer[sizeof(IMAGEHLP_SYMBOL) + 256];
 163     SYMBOL_INFO*        si = (SYMBOL_INFO*)buffer;
 164     void*               ret = NULL;
 165
 166     pSymSetOptions(SYMOPT_DEFERRED_LOADS | SYMOPT_PUBLICS_ONLY);
 167     /* FIXME: the TRUE option is due to the face that dbghelp requires it
 168      * when loading an ELF module
 169      */
 170     if (pSymInitialize(hProcess, NULL, TRUE))
 171     {
 172         si->SizeOfStruct = sizeof(*si);
 173         si->MaxNameLen = sizeof(buffer) - sizeof(IMAGEHLP_SYMBOL);
 174         if (pSymLoadModule(hProcess, NULL, lib, NULL, 0, 0) &&
 175             pSymFromName(hProcess, name, si))
 176             ret = (void*)(ULONG_PTR)si->Address;
 177         pSymCleanup(hProcess);
 178     }
 179     return ret;
 180 }
 181
 182 struct dll_option_layout
 183 {
 184     void*               next;
 185     void*               prev;
 186     char* const*        channels;
 187     int                 nb_channels;
 188 };
 189
 190 typedef int (*EnumChannelCB)(HANDLE, void*, char*, void*);
 191
 192 /******************************************************************
 193  *              enum_channel
 194  *
 195  * Enumerates all known channels on process hProcess through callback
 196  * ce.
 197  */
 198 static int enum_channel(HANDLE hProcess, EnumChannelCB ce, void* user, unsigned unique)
 199 {
 200     struct dll_option_layout    dol;
 201     int                         i, ret = 1;
 202     unsigned int                j;
 203     void*                       buf_addr;
 204     unsigned char               buffer[32];
 205     void*                       addr;
 206     const char**                cache = NULL;
 207     unsigned                    num_cache, used_cache;
 208
 209     if (!(addr = get_symbol(hProcess, "first_dll", "libwine.so"))) return -1;
 210     if (unique)
 211         cache = HeapAlloc(GetProcessHeap(), 0, (num_cache = 32) * sizeof(char*));
 212     else
 213         num_cache = 0;
 214     used_cache = 0;
 215
 216     for (;
 217          ret && addr && ReadProcessMemory(hProcess, addr, &dol, sizeof(dol), NULL);
 218          addr = dol.next)
 219     {
 220         for (i = 0; i < dol.nb_channels; i++)
 221         {
 222             if (ReadProcessMemory(hProcess, (void*)(dol.channels + i), &buf_addr, sizeof(buf_addr), NULL) &&
 223                 ReadProcessMemory(hProcess, buf_addr, buffer, sizeof(buffer), NULL))
 224             {
 225                 if (unique)
 226                 {
 227                     /* since some channels are defined in multiple compilation units,
 228                      * they will appear several times...
 229                      * so cache the channel's names we already reported and don't report
 230                      * them again
 231                      */
 232                     for (j = 0; j < used_cache; j++)
 233                         if (!strcmp(cache[j], buffer + 1)) break;
 234                     if (j != used_cache) continue;
 235                     if (used_cache == num_cache)
 236                         cache = HeapReAlloc(GetProcessHeap(), 0, cache, (num_cache *= 2) * sizeof(char*));
 237                     cache[used_cache++] = strcpy(HeapAlloc(GetProcessHeap(), 0, strlen(buffer + 1) + 1),
 238                                                  buffer + 1);
 239                 }
 240                 ret = ce(hProcess, buf_addr, buffer, user);
 241             }
 242         }
 243     }
 244     if (unique)
 245     {
 246         for (j = 0; j < used_cache; j++) HeapFree(GetProcessHeap(), 0, (char*)cache[j]);
 247         HeapFree(GetProcessHeap(), 0, cache);
 248     }
 249     return 0;
 250 }
 251
 252 static void DebugChannels_FillList(HWND hChannelLV)
 253 {
 254     HANDLE      hProcess;
 255
 256     ListView_DeleteAllItems(hChannelLV);
 257
 258     hProcess = OpenProcess(PROCESS_VM_OPERATION | PROCESS_VM_READ, FALSE, get_selected_pid());
 259     if (!hProcess) return; /* FIXME messagebox */
 260     SendMessage(hChannelLV, WM_SETREDRAW, FALSE, 0);
 261     enum_channel(hProcess, list_channel_CB, (void*)hChannelLV, TRUE);
 262     SendMessage(hChannelLV, WM_SETREDRAW, TRUE, 0);
 263     CloseHandle(hProcess);
 264 }
 265
 266 static void DebugChannels_OnCreate(HWND hwndDlg)
 267 {
 268     HWND        hLV = GetDlgItem(hwndDlg, IDC_DEBUG_CHANNELS_LIST);
 269     LVCOLUMN    lvc;
 270
 271     lvc.mask = LVCF_FMT | LVCF_TEXT | LVCF_WIDTH;
 272     lvc.fmt = LVCFMT_LEFT;
 273     lvc.pszText = _T("Debug Channel");
 274     lvc.cx = 100;
 275     ListView_InsertColumn(hLV, 0, &lvc);
 276
 277     lvc.mask = LVCF_FMT | LVCF_TEXT | LVCF_WIDTH;
 278     lvc.fmt = LVCFMT_CENTER;
 279     lvc.pszText = _T("Fixme");
 280     lvc.cx = 55;
 281     ListView_InsertColumn(hLV, 1, &lvc);
 282
 283     lvc.mask = LVCF_FMT | LVCF_TEXT | LVCF_WIDTH;
 284     lvc.fmt = LVCFMT_CENTER;
 285     lvc.pszText = _T("Err");
 286     lvc.cx = 55;
 287     ListView_InsertColumn(hLV, 2, &lvc);
 288
 289     lvc.mask = LVCF_FMT | LVCF_TEXT | LVCF_WIDTH;
 290     lvc.fmt = LVCFMT_CENTER;
 291     lvc.pszText = _T("Warn");
 292     lvc.cx = 55;
 293     ListView_InsertColumn(hLV, 3, &lvc);
 294
 295     lvc.mask = LVCF_FMT | LVCF_TEXT | LVCF_WIDTH;
 296     lvc.fmt = LVCFMT_CENTER;
 297     lvc.pszText = _T("Trace");
 298     lvc.cx = 55;
 299     ListView_InsertColumn(hLV, 4, &lvc);
 300
 301     DebugChannels_FillList(hLV);
 302 }
 303
 304 static void DebugChannels_OnNotify(HWND hDlg, LPARAM lParam)
 305 {
 306     NMHDR*      nmh = (NMHDR*)lParam;
 307
 308     switch (nmh->code)
 309     {
 310     case NM_CLICK:
 311         if (nmh->idFrom == IDC_DEBUG_CHANNELS_LIST)
 312         {
 313             LVHITTESTINFO       lhti;
 314             HWND                hChannelLV;
 315             HANDLE              hProcess;
 316             NMITEMACTIVATE*     nmia = (NMITEMACTIVATE*)lParam;
 317
 318             hProcess = OpenProcess(PROCESS_VM_OPERATION | PROCESS_VM_READ | PROCESS_VM_WRITE, FALSE, get_selected_pid());
 319             if (!hProcess) return; /* FIXME message box */
 320             lhti.pt = nmia->ptAction;
 321             hChannelLV = GetDlgItem(hDlg, IDC_DEBUG_CHANNELS_LIST);
 322             SendMessage(hChannelLV, LVM_SUBITEMHITTEST, 0, (LPARAM)&lhti);
 323             if (nmia->iSubItem >= 1 && nmia->iSubItem <= 4)
 324             {
 325                 TCHAR           val[2];
 326                 TCHAR           name[32];
 327                 unsigned        bitmask = 1 << (lhti.iSubItem - 1);
 328                 struct cce_user user;
 329
 330                 ListView_GetItemText(hChannelLV, lhti.iItem, 0, name, sizeof(name) / sizeof(name[0]));
 331                 ListView_GetItemText(hChannelLV, lhti.iItem, lhti.iSubItem, val, sizeof(val) / sizeof(val[0]));
 332                 user.name = name;
 333                 user.value = (val[0] == 'x') ? 0 : bitmask;
 334                 user.mask = bitmask;
 335                 user.done = user.notdone = 0;
 336                 enum_channel(hProcess, change_channel_CB, &user, FALSE);
 337                 if (user.done)
 338                 {
 339                     val[0] ^= ('x' ^ ' ');
 340                     ListView_SetItemText(hChannelLV, lhti.iItem, lhti.iSubItem, val);
 341                 }
 342                 if (user.notdone)
 343                     printf("Some channel instance weren't correctly set\n");
 344             }
 345             CloseHandle(hProcess);
 346         }
 347         break;
 348     }
 349 }
 350
 351 static LRESULT CALLBACK DebugChannelsDlgProc(HWND hDlg, UINT message, WPARAM wParam, LPARAM lParam)
 352 {
 353     switch (message)
 354     {
 355     case WM_INITDIALOG:
 356         DebugChannels_OnCreate(hDlg);
 357         return TRUE;
 358     case WM_COMMAND:
 359         if (LOWORD(wParam) == IDOK || LOWORD(wParam) == IDCANCEL)
 360         {
 361             EndDialog(hDlg, LOWORD(wParam));
 362             return TRUE;
 363         }
 364         break;
 365     case WM_NOTIFY:
 366         DebugChannels_OnNotify(hDlg, lParam);
 367         break;
 368     }
 369     return FALSE;
 370 }
 371
 372 void ProcessPage_OnDebugChannels(void)
 373 {
 374     DialogBox(hInst, (LPCTSTR)IDD_DEBUG_CHANNELS_DIALOG, hMainWnd, (DLGPROC)DebugChannelsDlgProc);
 375 }