programs/winedbg/source.c

   1 /*
   2  * File source.c - source file handling for internal debugger.
   3  *
   4  * Copyright (C) 1997, Eric Youngdale.
   5  *
   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.
  10  *
  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.
  15  *
  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., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  19  */
  20
  21 #include "config.h"
  22 #include <stdio.h>
  23 #include <stdlib.h>
  24
  25 #include "debugger.h"
  26
  27 struct open_file_list
  28 {
  29     char*                       path;
  30     char*                       real_path;
  31     struct open_file_list*      next;
  32     unsigned int                size;
  33     signed int                  nlines;
  34     unsigned int*               linelist;
  35 };
  36
  37 void source_show_path(void)
  38 {
  39     const char* ptr;
  40     const char* next;
  41
  42     dbg_printf("Search list:\n");
  43     for (ptr = dbg_curr_process->search_path; ptr; ptr = next)
  44     {
  45         next = strchr(ptr, ';');
  46         if (next)
  47             dbg_printf("\t%.*s\n", (int)(next++ - ptr), ptr);
  48         else
  49             dbg_printf("\t%s\n", ptr);
  50     }
  51     dbg_printf("\n");
  52 }
  53
  54 void source_add_path(const char* path)
  55 {
  56     char*       new;
  57     unsigned    size;
  58
  59     size = strlen(path) + 1;
  60     if (dbg_curr_process->search_path)
  61     {
  62         unsigned pos = strlen(dbg_curr_process->search_path) + 1;
  63         new = HeapReAlloc(GetProcessHeap(), 0, dbg_curr_process->search_path, pos + size);
  64         if (!new) return;
  65         new[pos - 1] = ';';
  66         strcpy(&new[pos], path);
  67     }
  68     else
  69     {
  70         new = HeapAlloc(GetProcessHeap(), 0, size);
  71         if (!new) return;
  72         strcpy(new, path);
  73     }
  74     dbg_curr_process->search_path = new;
  75 }
  76
  77 void source_nuke_path(struct dbg_process* p)
  78 {
  79     HeapFree(GetProcessHeap(), 0, p->search_path);
  80     p->search_path = NULL;
  81 }
  82
  83 static  void*   source_map_file(const char* name, HANDLE* hMap, unsigned* size)
  84 {
  85     HANDLE              hFile;
  86
  87     hFile = CreateFileA(name, GENERIC_READ, FILE_SHARE_READ, NULL,
  88                         OPEN_EXISTING, FILE_ATTRIBUTE_NORMAL, NULL);
  89     if (hFile == INVALID_HANDLE_VALUE) return (void*)-1;
  90     if (size != NULL && (*size = GetFileSize(hFile, NULL)) == INVALID_FILE_SIZE) {
  91         CloseHandle(hFile);
  92         return (void*)-1;
  93     }
  94     *hMap = CreateFileMappingW(hFile, NULL, PAGE_READONLY, 0, 0, NULL);
  95     CloseHandle(hFile);
  96     if (!*hMap) return (void*)-1;
  97     return MapViewOfFile(*hMap, FILE_MAP_READ, 0, 0, 0);
  98 }
  99
 100 static void     source_unmap_file(void* addr, HANDLE hMap)
 101 {
 102     UnmapViewOfFile(addr);
 103     CloseHandle(hMap);
 104 }
 105
 106 static struct open_file_list* source_search_open_file(const char* name)
 107 {
 108     struct open_file_list*      ol;
 109
 110     for (ol = dbg_curr_process->source_ofiles; ol; ol = ol->next)
 111     {
 112         if (strcmp(ol->path, name) == 0) break;
 113     }
 114     return ol;
 115 }
 116
 117 static BOOL     source_locate_file(const char* srcfile, char* path)
 118 {
 119     BOOL        found = FALSE;
 120
 121     if (GetFileAttributesA(srcfile) != INVALID_FILE_ATTRIBUTES)
 122     {
 123         strcpy(path, srcfile);
 124         found = TRUE;
 125     }
 126     else if (dbg_curr_process->search_path)
 127     {
 128         const char* spath;
 129
 130         spath = srcfile;
 131         while (!found)
 132         {
 133             while (*spath && *spath != '/' && *spath != '\\') spath++;
 134             if (!*spath) break;
 135             spath++;
 136             found = SearchPathA(dbg_curr_process->search_path, spath, NULL, MAX_PATH, path, NULL);
 137         }
 138     }
 139     return found;
 140 }
 141
 142 static struct open_file_list* source_add_file(const char* name, const char* realpath)
 143 {
 144     struct open_file_list*      ol;
 145     size_t                      sz, nlen;
 146
 147     sz = sizeof(*ol);
 148     nlen = strlen(name) + 1;
 149     if (realpath) sz += strlen(realpath) + 1;
 150     ol = HeapAlloc(GetProcessHeap(), 0, sz + nlen);
 151     if (!ol) return NULL;
 152     strcpy(ol->path = (char*)(ol + 1), name);
 153     if (realpath)
 154         strcpy(ol->real_path = ol->path + nlen, realpath);
 155     else
 156         ol->real_path = NULL;
 157     ol->next = dbg_curr_process->source_ofiles;
 158     ol->nlines = 0;
 159     ol->linelist = NULL;
 160     ol->size = 0;
 161     return dbg_curr_process->source_ofiles = ol;
 162 }
 163
 164 static int source_display(const char* sourcefile, int start, int end)
 165 {
 166     char*                       addr;
 167     int                         i;
 168     struct open_file_list*      ol;
 169     int                         nlines;
 170     const char*                 basename = NULL;
 171     char*                       pnt;
 172     int                         rtn;
 173     HANDLE                      hMap;
 174     char                        tmppath[MAX_PATH];
 175
 176     /*
 177      * First see whether we have the file open already.  If so, then
 178      * use that, otherwise we have to try and open it.
 179      */
 180     ol = source_search_open_file(sourcefile);
 181
 182     if (ol == NULL)
 183     {
 184         /*
 185          * Try again, stripping the path from the opened file.
 186          */
 187         basename = strrchr(sourcefile, '\\');
 188         if (!basename) basename = strrchr(sourcefile, '/');
 189         if (!basename) basename = sourcefile;
 190         else basename++;
 191
 192         ol = source_search_open_file(basename);
 193     }
 194
 195     if (ol == NULL)
 196     {
 197         /*
 198          * Crapola.  We need to try and open the file.
 199          */
 200         if (!source_locate_file(sourcefile, tmppath))
 201         {
 202             if (dbg_interactiveP)
 203             {
 204                 char zbuf[256];
 205
 206                 for (;;)
 207                 {
 208                     size_t      len;
 209                     /*
 210                      * Still couldn't find it.  Ask user for path to add.
 211                      */
 212                     snprintf(zbuf, sizeof(zbuf), "Enter path to file '%s' (<cr> to end search): ", sourcefile);
 213                     input_read_line(zbuf, tmppath, sizeof(tmppath));
 214                     if (!(len = strlen(tmppath))) break;
 215
 216                     /* append '/' if missing at the end */
 217                     if (tmppath[len - 1] != '/' && tmppath[len - 1] != '\\')
 218                         tmppath[len++] = '/';
 219                     strcpy(&tmppath[len], basename);
 220                     if (GetFileAttributesA(tmppath) != INVALID_FILE_ATTRIBUTES)
 221                         break;
 222                     dbg_printf("Unable to access file '%s'\n", tmppath);
 223                 }
 224             }
 225             else
 226             {
 227                 dbg_printf("Unable to access file '%s'\n", sourcefile);
 228                 tmppath[0] = '\0';
 229             }
 230
 231             if (!tmppath[0])
 232             {
 233                 /*
 234                  * OK, I guess the user doesn't really want to see it
 235                  * after all.
 236                  */
 237                 ol = source_add_file(sourcefile, NULL);
 238                 return FALSE;
 239             }
 240         }
 241         /*
 242          * Create header for file.
 243          */
 244         ol = source_add_file(sourcefile, tmppath);
 245
 246         addr = source_map_file(tmppath, &hMap, &ol->size);
 247         if (addr == (char*)-1) return FALSE;
 248         /*
 249          * Now build up the line number mapping table.
 250          */
 251         ol->nlines = 1;
 252         pnt = addr;
 253         while (pnt < addr + ol->size)
 254         {
 255             if (*pnt++ == '\n') ol->nlines++;
 256         }
 257
 258         ol->nlines++;
 259         ol->linelist = HeapAlloc(GetProcessHeap(), 0, ol->nlines * sizeof(unsigned int));
 260
 261         nlines = 0;
 262         pnt = addr;
 263         ol->linelist[nlines++] = 0;
 264         while (pnt < addr + ol->size)
 265         {
 266             if (*pnt++ == '\n') ol->linelist[nlines++] = pnt - addr;
 267         }
 268         ol->linelist[nlines++] = pnt - addr;
 269
 270     }
 271     else
 272     {
 273         addr = source_map_file(ol->real_path, &hMap, NULL);
 274         if (addr == (char*)-1) return FALSE;
 275     }
 276     /*
 277      * All we need to do is to display the source lines here.
 278      */
 279     rtn = FALSE;
 280     for (i = start - 1; i <= end - 1; i++)
 281     {
 282         char    buffer[1024];
 283
 284         if (i < 0 || i >= ol->nlines - 1) continue;
 285
 286         rtn = TRUE;
 287         memset(&buffer, 0, sizeof(buffer));
 288         if (ol->linelist[i+1] != ol->linelist[i])
 289         {
 290             memcpy(&buffer, addr + ol->linelist[i],
 291                    (ol->linelist[i+1] - ol->linelist[i]) - 1);
 292         }
 293         dbg_printf("%d\t%s\n", i + 1, buffer);
 294     }
 295
 296     source_unmap_file(addr, hMap);
 297     return rtn;
 298 }
 299
 300 void source_list(IMAGEHLP_LINE64* src1, IMAGEHLP_LINE64* src2, int delta)
 301 {
 302     int         end;
 303     int         start;
 304     const char* sourcefile;
 305
 306     /*
 307      * We need to see what source file we need.  Hopefully we only have
 308      * one specified, otherwise we might as well punt.
 309      */
 310     if (src1 && src2 && src1->FileName && src2->FileName &&
 311         strcmp(src1->FileName, src2->FileName) != 0)
 312     {
 313         dbg_printf("Ambiguous source file specification.\n");
 314         return;
 315     }
 316
 317     sourcefile = NULL;
 318     if (src1 && src1->FileName) sourcefile = src1->FileName;
 319     if (!sourcefile && src2 && src2->FileName) sourcefile = src2->FileName;
 320     if (!sourcefile) sourcefile = dbg_curr_process->source_current_file;
 321
 322     /*
 323      * Now figure out the line number range to be listed.
 324      */
 325     start = end = -1;
 326
 327     if (src1) start = src1->LineNumber;
 328     if (src2) end   = src2->LineNumber;
 329     if (start == -1 && end == -1)
 330     {
 331         if (delta < 0)
 332         {
 333             end = dbg_curr_process->source_start_line;
 334             start = end + delta;
 335         }
 336         else
 337         {
 338             start = dbg_curr_process->source_end_line;
 339             end = start + delta;
 340         }
 341     }
 342     else if (start == -1) start = end + delta;
 343     else if (end == -1)   end = start + delta;
 344
 345     /*
 346      * Now call this function to do the dirty work.
 347      */
 348     source_display(sourcefile, start, end);
 349
 350     if (sourcefile != dbg_curr_process->source_current_file)
 351         strcpy(dbg_curr_process->source_current_file, sourcefile);
 352     dbg_curr_process->source_start_line = start;
 353     dbg_curr_process->source_end_line = end;
 354 }
 355
 356 void source_list_from_addr(const ADDRESS64* addr, int nlines)
 357 {
 358     IMAGEHLP_LINE64     il;
 359     ADDRESS64           la;
 360     DWORD               disp;
 361
 362     if (!addr)
 363     {
 364         memory_get_current_pc(&la);
 365         addr = &la;
 366     }
 367
 368     il.SizeOfStruct = sizeof(il);
 369     if (SymGetLineFromAddr64(dbg_curr_process->handle,
 370                              (DWORD_PTR)memory_to_linear_addr(addr),
 371                              &disp, &il))
 372         source_list(&il, NULL, nlines);
 373 }
 374
 375 void source_free_files(struct dbg_process* p)
 376 {
 377     struct open_file_list*      ofile;
 378     struct open_file_list*      ofile_next;
 379
 380     for (ofile = p->source_ofiles; ofile; ofile = ofile_next)
 381     {
 382         ofile_next = ofile->next;
 383         HeapFree(GetProcessHeap(), 0, ofile->linelist);
 384         HeapFree(GetProcessHeap(), 0, ofile);
 385     }
 386 }