winedbg: Don't assert on some lvalue's write conditions.
[wine] / programs / winedbg / break.c
1 /*
2  * Debugger break-points handling
3  *
4  * Copyright 1994 Martin von Loewis
5  * Copyright 1995 Alexandre Julliard
6  * Copyright 1999,2000 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., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
21  */
22
23 #include "config.h"
24 #include "debugger.h"
25 #include "wine/debug.h"
26
27 WINE_DEFAULT_DEBUG_CHANNEL(winedbg);
28
29 static int is_xpoint_break(int bpnum)
30 {
31     int type = dbg_curr_process->bp[bpnum].xpoint_type;
32
33     if (type == be_xpoint_break || type == be_xpoint_watch_exec) return TRUE;
34     if (type == be_xpoint_watch_read || type == be_xpoint_watch_write) return FALSE;
35     RaiseException(DEBUG_STATUS_INTERNAL_ERROR, 0, 0, NULL);
36     return 0; /* never reached */
37 }
38
39 /***********************************************************************
40  *           break_set_xpoints
41  *
42  * Set or remove all the breakpoints & watchpoints
43  */
44 void  break_set_xpoints(BOOL set)
45 {
46     static BOOL                 last; /* = 0 = FALSE */
47
48     unsigned int                i, ret, size;
49     void*                       addr;
50     struct dbg_breakpoint*      bp = dbg_curr_process->bp;
51
52     if (set == last) return;
53     last = set;
54
55     for (i = 0; i < dbg_curr_process->next_bp; i++)
56     {
57         if (!bp[i].refcount || !bp[i].enabled) continue;
58
59         if (is_xpoint_break(i))
60             size = 0;
61         else
62             size = bp[i].w.len + 1;
63         addr = memory_to_linear_addr(&bp[i].addr);
64
65         if (set)
66             ret = be_cpu->insert_Xpoint(dbg_curr_process->handle,
67                                         dbg_curr_process->process_io,
68                                         &dbg_context, bp[i].xpoint_type, addr,
69                                         &bp[i].info, size);
70         else
71             ret = be_cpu->remove_Xpoint(dbg_curr_process->handle, 
72                                         dbg_curr_process->process_io,
73                                         &dbg_context, bp[i].xpoint_type, addr,
74                                         bp[i].info, size);
75         if (!ret)
76         {
77             dbg_printf("Invalid address (");
78             print_address(&bp[i].addr, FALSE);
79             dbg_printf(") for breakpoint %d, disabling it\n", i);
80             bp[i].enabled = FALSE;
81         }
82     }
83 }
84
85 /***********************************************************************
86  *           find_xpoint
87  *
88  * Find the breakpoint for a given address. Return the breakpoint
89  * number or -1 if none.
90  */
91 static int find_xpoint(const ADDRESS64* addr, enum be_xpoint_type type)
92 {
93     int                         i;
94     void*                       lin = memory_to_linear_addr(addr);
95     struct dbg_breakpoint*      bp = dbg_curr_process->bp;
96
97     for (i = 0; i < dbg_curr_process->next_bp; i++)
98     {
99         if (bp[i].refcount && bp[i].enabled && bp[i].xpoint_type == type &&
100             memory_to_linear_addr(&bp[i].addr) == lin)
101             return i;
102     }
103     return -1;
104 }
105
106 /***********************************************************************
107  *           init_xpoint
108  *
109  * Find an empty slot in BP table to add a new break/watch point
110  */
111 static  int init_xpoint(int type, const ADDRESS64* addr)
112 {
113     int                         num;
114     struct dbg_breakpoint*      bp = dbg_curr_process->bp;
115
116     for (num = (dbg_curr_process->next_bp < MAX_BREAKPOINTS) ? 
117              dbg_curr_process->next_bp++ : 1;
118          num < MAX_BREAKPOINTS; num++)
119     {
120         if (bp[num].refcount == 0)
121         {
122             bp[num].refcount    = 1;
123             bp[num].enabled     = TRUE;
124             bp[num].xpoint_type = type;
125             bp[num].skipcount   = 0;
126             bp[num].addr        = *addr;
127             return num;
128         }
129     }
130
131     dbg_printf("Too many bp. Please delete some.\n");
132     return -1;
133 }
134
135 /***********************************************************************
136  *           get_watched_value
137  *
138  * Returns the value watched by watch point 'num'.
139  */
140 static  BOOL    get_watched_value(int num, DWORD64* val)
141 {
142     DWORD64     buf[1];
143
144     if (!dbg_read_memory(memory_to_linear_addr(&dbg_curr_process->bp[num].addr),
145                          buf, dbg_curr_process->bp[num].w.len + 1))
146         return FALSE;
147
148     switch (dbg_curr_process->bp[num].w.len + 1)
149     {
150     case 8:     *val = *(DWORD64*)buf;  break;
151     case 4:     *val = *(DWORD*)buf;    break;
152     case 2:     *val = *(WORD*)buf;     break;
153     case 1:     *val = *(BYTE*)buf;     break;
154     default: RaiseException(DEBUG_STATUS_INTERNAL_ERROR, 0, 0, NULL);
155     }
156     return TRUE;
157 }
158
159 /***********************************************************************
160  *           break_add_break
161  *
162  * Add a breakpoint.
163  */
164 BOOL break_add_break(const ADDRESS64* addr, BOOL verbose, BOOL swbp)
165 {
166     int                         num;
167     BYTE                        ch;
168     struct dbg_breakpoint*      bp = dbg_curr_process->bp;
169     int                         type = swbp ? be_xpoint_break : be_xpoint_watch_exec;
170
171     if ((num = find_xpoint(addr, type)) >= 1)
172     {
173         bp[num].refcount++;
174         dbg_printf("Breakpoint %d at ", num);
175         print_address(&bp[num].addr, TRUE);
176         dbg_printf(" (refcount=%d)\n", bp[num].refcount);
177         return TRUE;
178     }
179
180     if (!dbg_read_memory(memory_to_linear_addr(addr), &ch, sizeof(ch)))
181     {
182         if (verbose)
183         {
184             dbg_printf("Invalid address ");
185             print_bare_address(addr);
186             dbg_printf(", can't set breakpoint\n");
187         }
188         return FALSE;
189     }
190
191     if ((num = init_xpoint(type, addr)) == -1)
192         return FALSE;
193
194     dbg_printf("Breakpoint %d at ", num);
195     print_address(&bp[num].addr, TRUE);
196     dbg_printf("\n");
197
198     return TRUE;
199 }
200
201 /***********************************************************************
202  *           break_add_break_from_lvalue
203  *
204  * Add a breakpoint.
205  */
206 BOOL break_add_break_from_lvalue(const struct dbg_lvalue* lvalue, BOOL swbp)
207 {
208     ADDRESS64   addr;
209
210     types_extract_as_address(lvalue, &addr);
211
212     if (!break_add_break(&addr, TRUE, swbp))
213     {
214         if (!DBG_IVAR(CanDeferOnBPByAddr))
215         {
216             dbg_printf("Invalid address, can't set breakpoint\n"
217                        "You can turn on deferring bp by address by setting $CanDeferOnBPByAddr to 1\n");
218             return FALSE;
219         }
220         dbg_printf("Unable to add breakpoint, will check again any time a new DLL is loaded\n");
221         dbg_curr_process->delayed_bp = 
222             dbg_heap_realloc(dbg_curr_process->delayed_bp,
223                              sizeof(struct dbg_delayed_bp) * ++dbg_curr_process->num_delayed_bp);
224
225         dbg_curr_process->delayed_bp[dbg_curr_process->num_delayed_bp - 1].is_symbol   = FALSE;
226         dbg_curr_process->delayed_bp[dbg_curr_process->num_delayed_bp - 1].software_bp = swbp;
227         dbg_curr_process->delayed_bp[dbg_curr_process->num_delayed_bp - 1].u.addr      = addr;
228         return TRUE;
229     }
230     return FALSE;
231 }
232
233 /***********************************************************************
234  *           break_add_break_from_id
235  *
236  * Add a breakpoint from a function name (and eventually a line #)
237  */
238 void    break_add_break_from_id(const char *name, int lineno, BOOL swbp)
239 {
240     struct dbg_lvalue   lvalue;
241     int                 i;
242
243     switch (symbol_get_lvalue(name, lineno, &lvalue, TRUE))
244     {
245     case sglv_found:
246         break_add_break(&lvalue.addr, TRUE, swbp);
247         return;
248     case sglv_unknown:
249         break;
250     case sglv_aborted: /* user aborted symbol lookup */
251         return;
252     }
253
254     dbg_printf("Unable to add breakpoint, will check again when a new DLL is loaded\n");
255     for (i = 0; i < dbg_curr_process->num_delayed_bp; i++)
256     {
257         if (dbg_curr_process->delayed_bp[i].is_symbol &&
258             !strcmp(name, dbg_curr_process->delayed_bp[i].u.symbol.name) &&
259             lineno == dbg_curr_process->delayed_bp[i].u.symbol.lineno)
260             return;
261     }
262     dbg_curr_process->delayed_bp = dbg_heap_realloc(dbg_curr_process->delayed_bp,
263                                                     sizeof(struct dbg_delayed_bp) * ++dbg_curr_process->num_delayed_bp);
264
265     dbg_curr_process->delayed_bp[dbg_curr_process->num_delayed_bp - 1].is_symbol       = TRUE;
266     dbg_curr_process->delayed_bp[dbg_curr_process->num_delayed_bp - 1].software_bp     = swbp;
267     dbg_curr_process->delayed_bp[dbg_curr_process->num_delayed_bp - 1].u.symbol.name   = strcpy(HeapAlloc(GetProcessHeap(), 0, strlen(name) + 1), name);
268     dbg_curr_process->delayed_bp[dbg_curr_process->num_delayed_bp - 1].u.symbol.lineno = lineno;
269 }
270
271 struct cb_break_lineno
272 {
273     int         lineno;
274     ADDRESS64   addr;
275 };
276
277 static BOOL CALLBACK line_cb(SRCCODEINFO* sci, void* user)
278 {
279     struct cb_break_lineno*      bkln = user;
280
281     if (bkln->lineno == sci->LineNumber)
282     {
283         bkln->addr.Mode = AddrModeFlat;
284         bkln->addr.Offset = sci->Address;
285         return FALSE;
286     }
287     return TRUE;
288 }
289
290 /***********************************************************************
291  *           break_add_break_from_lineno
292  *
293  * Add a breakpoint from a line number in current file
294  */
295 void    break_add_break_from_lineno(int lineno, BOOL swbp)
296 {
297     struct cb_break_lineno      bkln;
298
299     memory_get_current_pc(&bkln.addr);
300
301     if (lineno != -1)
302     {
303         IMAGEHLP_LINE64 il;
304
305
306         DWORD           disp;
307         DWORD_PTR       linear = (DWORD_PTR)memory_to_linear_addr(&bkln.addr);
308
309         il.SizeOfStruct = sizeof(il);
310         if (!SymGetLineFromAddr64(dbg_curr_process->handle, linear, &disp, &il))
311         {
312             dbg_printf("Unable to add breakpoint (unknown address %lx)\n", linear);
313             return;
314         }
315         bkln.addr.Offset = 0;
316         bkln.lineno = lineno;
317         SymEnumLines(dbg_curr_process->handle, linear, NULL, il.FileName, line_cb, &bkln);
318         if (!bkln.addr.Offset)
319         {
320             dbg_printf("Unknown line number\n"
321                        "(either out of file, or no code at given line number)\n");
322             return;
323         }
324     }
325
326     break_add_break(&bkln.addr, TRUE, swbp);
327 }
328
329 /***********************************************************************
330  *           break_check_delayed_bp
331  *
332  * Check is a registered delayed BP is now available.
333  */
334 void break_check_delayed_bp(void)
335 {
336     struct dbg_lvalue           lvalue;
337     int                         i;
338     struct dbg_delayed_bp*      dbp = dbg_curr_process->delayed_bp;
339     char                        hexbuf[MAX_OFFSET_TO_STR_LEN];
340
341     for (i = 0; i < dbg_curr_process->num_delayed_bp; i++)
342     {
343         if (dbp[i].is_symbol)
344         {
345             if (symbol_get_lvalue(dbp[i].u.symbol.name, dbp[i].u.symbol.lineno,
346                                   &lvalue, TRUE) != sglv_found)
347                 continue;
348             if (lvalue.cookie != DLV_TARGET) continue;
349         }
350         else
351             lvalue.addr = dbp[i].u.addr;
352         WINE_TRACE("trying to add delayed %s-bp\n", dbp[i].is_symbol ? "S" : "A");
353         if (!dbp[i].is_symbol)
354             WINE_TRACE("\t%04x:%s\n", 
355                        dbp[i].u.addr.Segment,
356                        memory_offset_to_string(hexbuf, dbp[i].u.addr.Offset, 0));
357         else
358             WINE_TRACE("\t'%s' @ %d\n", 
359                        dbp[i].u.symbol.name, dbp[i].u.symbol.lineno);
360
361         if (break_add_break(&lvalue.addr, FALSE, dbp[i].software_bp))
362             memmove(&dbp[i], &dbp[i+1], (--dbg_curr_process->num_delayed_bp - i) * sizeof(*dbp));
363     }
364 }
365
366 /***********************************************************************
367  *           break_add_watch
368  *
369  * Add a watchpoint.
370  */
371 static void break_add_watch(const struct dbg_lvalue* lvalue, BOOL is_write)
372 {
373     int         num;
374     DWORD64     l = 4;
375
376     if (lvalue->cookie == DLV_HOST)
377     {
378         dbg_printf("Cannot set a watch point on register or register-based variable\n");
379         return;
380     }
381     num = init_xpoint((is_write) ? be_xpoint_watch_write : be_xpoint_watch_read,
382                       &lvalue->addr);
383     if (num == -1) return;
384
385     if (lvalue->type.id != dbg_itype_none)
386     {
387         if (types_get_info(&lvalue->type, TI_GET_LENGTH, &l))
388         {
389             switch (l)
390             {
391             case 4: case 2: case 1: break;
392             default:
393                 dbg_printf("Unsupported length (%s) for watch-points, defaulting to 4\n",
394                            wine_dbgstr_longlong(l));
395                 break;
396             }
397         }
398         else dbg_printf("Cannot get watch size, defaulting to 4\n");
399     }
400     dbg_curr_process->bp[num].w.len = (DWORD)l - 1;
401
402     if (!get_watched_value(num, &dbg_curr_process->bp[num].w.oldval))
403     {
404         dbg_printf("Bad address. Watchpoint not set\n");
405         dbg_curr_process->bp[num].refcount = 0;
406         return;
407     }
408     dbg_printf("Watchpoint %d at ", num);
409     print_address(&dbg_curr_process->bp[num].addr, TRUE);
410     dbg_printf("\n");
411 }
412
413 /******************************************************************
414  *              break_add_watch_from_lvalue
415  *
416  * Adds a watch point from an address (stored in a lvalue)
417  */
418 void break_add_watch_from_lvalue(const struct dbg_lvalue* lvalue)
419 {
420     struct dbg_lvalue   lval;
421
422     types_extract_as_address(lvalue, &lval.addr);
423     lval.type.id = dbg_itype_none;
424
425     break_add_watch(&lval, TRUE);
426 }
427
428 /***********************************************************************
429  *           break_add_watch_from_id
430  *
431  * Add a watchpoint from a symbol name
432  */
433 void    break_add_watch_from_id(const char *name)
434 {
435     struct dbg_lvalue    lvalue;
436
437     switch (symbol_get_lvalue(name, -1, &lvalue, TRUE))
438     {
439     case sglv_found:
440         break_add_watch(&lvalue, 1);
441         break;
442     case sglv_unknown:
443         dbg_printf("Unable to add watchpoint\n");
444         break;
445     case sglv_aborted: /* user aborted symbol lookup */
446         break;
447     }
448 }
449
450 /***********************************************************************
451  *           break_delete_xpoint
452  *
453  * Delete a breakpoint.
454  */
455 void break_delete_xpoint(int num)
456 {
457     struct dbg_breakpoint*      bp = dbg_curr_process->bp;
458
459     if ((num <= 0) || (num >= dbg_curr_process->next_bp) ||
460         bp[num].refcount == 0)
461     {
462         dbg_printf("Invalid breakpoint number %d\n", num);
463         return;
464     }
465
466     if (--bp[num].refcount > 0)
467         return;
468
469     if (bp[num].condition != NULL)
470     {
471         expr_free(bp[num].condition);
472         bp[num].condition = NULL;
473     }
474
475     bp[num].enabled = FALSE;
476     bp[num].refcount = 0;
477     bp[num].skipcount = 0;
478 }
479
480 static inline BOOL module_is_container(const IMAGEHLP_MODULE* wmod_cntnr,
481                                      const IMAGEHLP_MODULE* wmod_child)
482 {
483     return wmod_cntnr->BaseOfImage <= wmod_child->BaseOfImage &&
484         wmod_cntnr->BaseOfImage + wmod_cntnr->ImageSize >=
485         wmod_child->BaseOfImage + wmod_child->ImageSize;
486 }
487
488 /******************************************************************
489  *              break_delete_xpoints_from_module
490  *
491  * Remove all Xpoints from module which base is 'base'
492  */
493 void break_delete_xpoints_from_module(DWORD64 base)
494 {
495     IMAGEHLP_MODULE64           im, im_elf;
496     int                         i;
497     DWORD_PTR                   linear;
498     struct dbg_breakpoint*      bp = dbg_curr_process->bp;
499
500     /* FIXME: should do it also on the ELF sibbling if any */
501     im.SizeOfStruct = sizeof(im);
502     im_elf.SizeOfStruct = sizeof(im_elf);
503     if (!SymGetModuleInfo64(dbg_curr_process->handle, base, &im)) return;
504
505     /* try to get in fact the underlying ELF module (if any) */
506     if (SymGetModuleInfo64(dbg_curr_process->handle, im.BaseOfImage - 1, &im_elf) &&
507         im_elf.BaseOfImage <= im.BaseOfImage &&
508         im_elf.BaseOfImage + im_elf.ImageSize >= im.BaseOfImage + im.ImageSize)
509         im = im_elf;
510
511     for (i = 0; i < dbg_curr_process->next_bp; i++)
512     {
513         linear = (DWORD_PTR)memory_to_linear_addr(&bp[i].addr);
514         if (bp[i].refcount && bp[i].enabled &&
515             im.BaseOfImage <= linear && linear < im.BaseOfImage + im.ImageSize)
516         {
517             break_delete_xpoint(i);
518         }
519     }
520 }
521
522 /***********************************************************************
523  *           break_enable_xpoint
524  *
525  * Enable or disable a break point.
526  */
527 void break_enable_xpoint(int num, BOOL enable)
528 {
529     if ((num <= 0) || (num >= dbg_curr_process->next_bp) || 
530         dbg_curr_process->bp[num].refcount == 0)
531     {
532         dbg_printf("Invalid breakpoint number %d\n", num);
533         return;
534     }
535     dbg_curr_process->bp[num].enabled = (enable) ? TRUE : FALSE;
536     dbg_curr_process->bp[num].skipcount = 0;
537 }
538
539
540 /***********************************************************************
541  *           find_triggered_watch
542  *
543  * Lookup the watchpoints to see if one has been triggered
544  * Return >= (watch point index) if one is found
545  * Return -1 if none found
546  *
547  * Unfortunately, Linux used to *NOT* (A REAL PITA) report with ptrace
548  * the DR6 register value, so we have to look with our own need the
549  * cause of the TRAP.
550  * -EP
551  */
552 static int find_triggered_watch(void)
553 {
554     int                         found = -1;
555     int                         i;
556     struct dbg_breakpoint*      bp = dbg_curr_process->bp;
557
558     /* Method 1 => get triggered watchpoint from context (doesn't work on Linux
559      * 2.2.x). This should be fixed in >= 2.2.16
560      */
561     for (i = 0; i < dbg_curr_process->next_bp; i++)
562     {
563         DWORD64 val = 0;
564
565         if (bp[i].refcount && bp[i].enabled && !is_xpoint_break(i) &&
566             (be_cpu->is_watchpoint_set(&dbg_context, bp[i].info)))
567         {
568             be_cpu->clear_watchpoint(&dbg_context, bp[i].info);
569
570             if (get_watched_value(i, &val))
571             {
572                 bp[i].w.oldval = val;
573                 return i;
574             }
575         }
576     }
577
578     /* Method 1 failed, trying method 2 */
579
580     /* Method 2 => check if value has changed among registered watchpoints
581      * this really sucks, but this is how gdb 4.18 works on my linux box
582      * -EP
583      */
584     for (i = 0; i < dbg_curr_process->next_bp; i++)
585     {
586         DWORD64 val = 0;
587
588         if (bp[i].refcount && bp[i].enabled && !is_xpoint_break(i) &&
589             get_watched_value(i, &val))
590         {
591             if (val != bp[i].w.oldval)
592             {
593                 be_cpu->clear_watchpoint(&dbg_context, bp[i].info);
594                 bp[i].w.oldval = val;
595                 found = i;
596                 /* cannot break, because two watch points may have been triggered on
597                  * the same access
598                  * only one will be reported to the user (FIXME ?)
599                  */
600             }
601         }
602     }
603     return found;
604 }
605
606 /***********************************************************************
607  *           break_info
608  *
609  * Display break & watch points information.
610  */
611 void break_info(void)
612 {
613     int                         i;
614     int                         nbp = 0, nwp = 0;
615     struct dbg_delayed_bp*      dbp = dbg_curr_process->delayed_bp;
616     struct dbg_breakpoint*      bp = dbg_curr_process->bp;
617
618     for (i = 1; i < dbg_curr_process->next_bp; i++)
619     {
620         if (bp[i].refcount)
621         {
622             if (is_xpoint_break(i)) nbp++; else nwp++;
623         }
624     }
625
626     if (nbp)
627     {
628         dbg_printf("Breakpoints:\n");
629         for (i = 1; i < dbg_curr_process->next_bp; i++)
630         {
631             if (!bp[i].refcount || !is_xpoint_break(i))
632                 continue;
633             dbg_printf("%d: %c ", i, bp[i].enabled ? 'y' : 'n');
634             print_address(&bp[i].addr, TRUE);
635             dbg_printf(" (%u)%s\n", bp[i].refcount, 
636                        bp[i].xpoint_type == be_xpoint_watch_exec ? " (hardware assisted)" : "");
637             if (bp[i].condition != NULL)
638             {
639                 dbg_printf("\t\tstop when  ");
640                 expr_print(bp[i].condition);
641                 dbg_printf("\n");
642             }
643         }
644     }
645     else dbg_printf("No breakpoints\n");
646     if (nwp)
647     {
648         dbg_printf("Watchpoints:\n");
649         for (i = 1; i < dbg_curr_process->next_bp; i++)
650         {
651             if (!bp[i].refcount || is_xpoint_break(i))
652                 continue;
653             dbg_printf("%d: %c ", i, bp[i].enabled ? 'y' : 'n');
654             print_address(&bp[i].addr, TRUE);
655             dbg_printf(" on %d byte%s (%c)\n",
656                        bp[i].w.len + 1, bp[i].w.len > 0 ? "s" : "",
657                        bp[i].xpoint_type == be_xpoint_watch_write ? 'W' : 'R');
658             if (bp[i].condition != NULL)
659             {
660                 dbg_printf("\t\tstop when ");
661                 expr_print(bp[i].condition);
662                 dbg_printf("\n");
663             }
664         }
665     }
666     else dbg_printf("No watchpoints\n");
667     if (dbg_curr_process->num_delayed_bp)
668     {
669         dbg_printf("Delayed breakpoints:\n");
670         for (i = 0; i < dbg_curr_process->num_delayed_bp; i++)
671         {
672             if (dbp[i].is_symbol)
673             {
674                 dbg_printf("%d: %s", i, dbp[i].u.symbol.name);
675                 if (dbp[i].u.symbol.lineno != -1)
676                     dbg_printf(" at line %u", dbp[i].u.symbol.lineno);
677             }
678             else
679             {
680                 dbg_printf("%d: ", i);
681                 print_address(&dbp[i].u.addr, FALSE);
682             }
683             dbg_printf("\n");
684         }
685     }
686 }
687
688 /***********************************************************************
689  *           should_stop
690  *
691  * Check whether or not the condition (bp / skipcount) of a break/watch
692  * point are met.
693  */
694 static  BOOL should_stop(int bpnum)
695 {
696     struct dbg_breakpoint*      bp = &dbg_curr_process->bp[bpnum];
697
698     if (bp->condition != NULL)
699     {
700         struct dbg_lvalue lvalue = expr_eval(bp->condition);
701
702         if (lvalue.type.id == dbg_itype_none)
703         {
704             /*
705              * Something wrong - unable to evaluate this expression.
706              */
707             dbg_printf("Unable to evaluate expression ");
708             expr_print(bp->condition);
709             dbg_printf("\nTurning off condition\n");
710             break_add_condition(bpnum, NULL);
711         }
712         else if (!types_extract_as_integer(&lvalue))
713         {
714             return FALSE;
715         }
716     }
717
718     if (bp->skipcount > 0) bp->skipcount--;
719     return bp->skipcount == 0;
720 }
721
722 /***********************************************************************
723  *           break_should_continue
724  *
725  * Determine if we should continue execution after a SIGTRAP signal when
726  * executing in the given mode.
727  */
728 BOOL break_should_continue(ADDRESS64* addr, DWORD code)
729 {
730     enum dbg_exec_mode  mode = dbg_curr_thread->exec_mode;
731
732
733     if (dbg_curr_thread->stopped_xpoint > 0)
734     {
735         if (!should_stop(dbg_curr_thread->stopped_xpoint)) return TRUE;
736
737         switch (dbg_curr_process->bp[dbg_curr_thread->stopped_xpoint].xpoint_type)
738         {
739         case be_xpoint_break:
740         case be_xpoint_watch_exec:
741             dbg_printf("Stopped on breakpoint %d at ", dbg_curr_thread->stopped_xpoint);
742             print_address(&dbg_curr_process->bp[dbg_curr_thread->stopped_xpoint].addr, TRUE);
743             dbg_printf("\n");
744             break;
745         case be_xpoint_watch_read:
746         case be_xpoint_watch_write:
747             dbg_printf("Stopped on watchpoint %d at ", dbg_curr_thread->stopped_xpoint);
748             print_address(addr, TRUE);
749             dbg_printf(" new value %s\n",
750                        wine_dbgstr_longlong(dbg_curr_process->bp[dbg_curr_thread->stopped_xpoint].w.oldval));
751         }
752         return FALSE;
753     }
754
755     /*
756      * If our mode indicates that we are stepping line numbers,
757      * get the current function, and figure out if we are exactly
758      * on a line number or not.
759      */
760     if (mode == dbg_exec_step_over_line || mode == dbg_exec_step_into_line)
761     {
762         if (symbol_get_function_line_status(addr) == dbg_on_a_line_number)
763             dbg_curr_thread->exec_count--;
764     }
765     else if (mode == dbg_exec_step_over_insn || mode == dbg_exec_step_into_insn)
766         dbg_curr_thread->exec_count--;
767
768     if (dbg_curr_thread->exec_count > 0 || mode == dbg_exec_finish)
769     {
770         /*
771          * We still need to execute more instructions.
772          */
773         return TRUE;
774     }
775
776     /* no breakpoint, continue if in continuous mode */
777     return mode == dbg_exec_cont || mode == dbg_exec_finish;
778 }
779
780 /***********************************************************************
781  *           break_adjust_pc
782  *
783  * Adjust PC to the address where the trap (if any) actually occurred
784  * Also sets dbg_curr_thread->stopped_xpoint
785  */
786 void break_adjust_pc(ADDRESS64* addr, DWORD code, BOOL first_chance, BOOL* is_break)
787 {
788     /* break / watch points are handled on first chance */
789     if ( !first_chance )
790     {
791         *is_break = TRUE;
792         dbg_curr_thread->stopped_xpoint = -1;
793         return;
794     }
795     *is_break = FALSE;
796
797     /* If not single-stepping, back up to the break instruction */
798     if (code == EXCEPTION_BREAKPOINT)
799         addr->Offset += be_cpu->adjust_pc_for_break(&dbg_context, TRUE);
800
801     dbg_curr_thread->stopped_xpoint = find_xpoint(addr, be_xpoint_break);
802     dbg_curr_process->bp[0].enabled = FALSE;  /* disable the step-over breakpoint */
803
804     if (dbg_curr_thread->stopped_xpoint > 0) return;
805
806     if (dbg_curr_thread->stopped_xpoint < 0)
807     {
808         dbg_curr_thread->stopped_xpoint = find_xpoint(addr, be_xpoint_watch_exec);
809         if (dbg_curr_thread->stopped_xpoint < 0)
810             dbg_curr_thread->stopped_xpoint = find_triggered_watch();
811         if (dbg_curr_thread->stopped_xpoint > 0)
812         {
813             /* If not single-stepping, do not back up over the break instruction */
814             if (code == EXCEPTION_BREAKPOINT)
815                 addr->Offset += be_cpu->adjust_pc_for_break(&dbg_context, FALSE);
816             return;
817         }
818     }
819
820     /* If there's no breakpoint and we are not single-stepping, then
821      * either we must have encountered a break insn in the Windows program
822      * or someone is trying to stop us
823      */
824     if (dbg_curr_thread->stopped_xpoint == -1 && code == EXCEPTION_BREAKPOINT)
825     {
826         *is_break = TRUE;
827         addr->Offset += be_cpu->adjust_pc_for_break(&dbg_context, FALSE);
828     }
829 }
830
831 /***********************************************************************
832  *           break_suspend_execution
833  *
834  * Remove all bp before entering the debug loop
835  */
836 void    break_suspend_execution(void)
837 {
838     break_set_xpoints(FALSE);
839     dbg_curr_process->bp[0] = dbg_curr_thread->step_over_bp;
840 }
841
842 /***********************************************************************
843  *           break_restart_execution
844  *
845  * Set the bp to the correct state to restart execution
846  * in the given mode.
847  */
848 void break_restart_execution(int count)
849 {
850     ADDRESS64                   addr;
851     enum dbg_line_status        status;
852     enum dbg_exec_mode          mode, ret_mode;
853     ADDRESS64                   callee;
854     void*                       linear;
855
856     memory_get_current_pc(&addr);
857     linear = memory_to_linear_addr(&addr);
858
859     /*
860      * This is the mode we will be running in after we finish.  We would like
861      * to be able to modify this in certain cases.
862      */
863     ret_mode = mode = dbg_curr_thread->exec_mode;
864
865     /* we've stopped on a xpoint (other than step over) */
866     if (dbg_curr_thread->stopped_xpoint > 0)
867     {
868         /*
869          * If we have set a new value, then save it in the BP number.
870          */
871         if (count != 0 && mode == dbg_exec_cont)
872         {
873             dbg_curr_process->bp[dbg_curr_thread->stopped_xpoint].skipcount = count;
874         }
875         /* If we've stopped on a breakpoint, single step over it (, then run) */
876         if (is_xpoint_break(dbg_curr_thread->stopped_xpoint))
877             mode = dbg_exec_step_into_insn;
878     }
879     else if (mode == dbg_exec_cont && count > 1)
880     {
881         dbg_printf("Not stopped at any breakpoint; argument ignored.\n");
882     }
883
884     if (mode == dbg_exec_finish && be_cpu->is_function_return(linear))
885     {
886         mode = ret_mode = dbg_exec_step_into_insn;
887     }
888
889     /*
890      * See if the function we are stepping into has debug info
891      * and line numbers.  If not, then we step over it instead.
892      * FIXME - we need to check for things like thunks or trampolines,
893      * as the actual function may in fact have debug info.
894      */
895     if (be_cpu->is_function_call(linear, &callee))
896     {
897         status = symbol_get_function_line_status(&callee);
898 #if 0
899         /* FIXME: we need to get the thunk type */
900         /*
901          * Anytime we have a trampoline, step over it.
902          */
903         if ((mode == EXEC_STEP_OVER || mode == EXEC_STEPI_OVER)
904             && status == dbg_in_a_thunk)
905         {
906             WINE_WARN("Not stepping into trampoline at %p (no lines)\n", 
907                       memory_to_linear_addr(&callee));
908             mode = EXEC_STEP_OVER_TRAMPOLINE;
909         }
910 #endif
911         if (mode == dbg_exec_step_into_line && status == dbg_no_line_info)
912         {
913             WINE_WARN("Not stepping into function at %p (no lines)\n",
914                       memory_to_linear_addr(&callee));
915             mode = dbg_exec_step_over_line;
916         }
917     }
918
919     if (mode == dbg_exec_step_into_line && 
920         symbol_get_function_line_status(&addr) == dbg_no_line_info)
921     {
922         dbg_printf("Single stepping until exit from function,\n"
923                    "which has no line number information.\n");
924         ret_mode = mode = dbg_exec_finish;
925     }
926
927     switch (mode)
928     {
929     case dbg_exec_cont: /* Continuous execution */
930         be_cpu->single_step(&dbg_context, FALSE);
931         break_set_xpoints(TRUE);
932         break;
933
934 #if 0
935     case EXEC_STEP_OVER_TRAMPOLINE:
936         /*
937          * This is the means by which we step over our conversion stubs
938          * in callfrom*.s and callto*.s.  We dig the appropriate address
939          * off the stack, and we set the breakpoint there instead of the
940          * address just after the call.
941          */
942         be_cpu->get_addr(dbg_curr_thread->handle, &dbg_context,
943                          be_cpu_addr_stack, &addr);
944         /* FIXME: we assume stack grows as on an i386 */
945         addr.Offset += 2 * sizeof(unsigned int);
946         dbg_read_memory(memory_to_linear_addr(&addr),
947                         &addr.Offset, sizeof(addr.Offset));
948         dbg_curr_process->bp[0].addr = addr;
949         dbg_curr_process->bp[0].enabled = TRUE;
950         dbg_curr_process->bp[0].refcount = 1;
951         dbg_curr_process->bp[0].skipcount = 0;
952         dbg_curr_process->bp[0].xpoint_type = be_xpoint_break;
953         dbg_curr_process->bp[0].condition = NULL;
954         be_cpu->single_step(&dbg_context, FALSE);
955         break_set_xpoints(TRUE);
956         break;
957 #endif
958
959     case dbg_exec_finish:
960     case dbg_exec_step_over_insn:  /* Stepping over a call */
961     case dbg_exec_step_over_line:  /* Stepping over a call */
962         if (be_cpu->is_step_over_insn(linear))
963         {
964             be_cpu->disasm_one_insn(&addr, FALSE);
965             dbg_curr_process->bp[0].addr = addr;
966             dbg_curr_process->bp[0].enabled = TRUE;
967             dbg_curr_process->bp[0].refcount = 1;
968             dbg_curr_process->bp[0].skipcount = 0;
969             dbg_curr_process->bp[0].xpoint_type = be_xpoint_break;
970             dbg_curr_process->bp[0].condition = NULL;
971             be_cpu->single_step(&dbg_context, FALSE);
972             break_set_xpoints(TRUE);
973             break;
974         }
975         /* else fall through to single-stepping */
976
977     case dbg_exec_step_into_line: /* Single-stepping a line */
978     case dbg_exec_step_into_insn: /* Single-stepping an instruction */
979         be_cpu->single_step(&dbg_context, TRUE);
980         break;
981     default: RaiseException(DEBUG_STATUS_INTERNAL_ERROR, 0, 0, NULL);
982     }
983     dbg_curr_thread->step_over_bp = dbg_curr_process->bp[0];
984     dbg_curr_thread->exec_mode = ret_mode;
985 }
986
987 int break_add_condition(int num, struct expr* exp)
988 {
989     if (num <= 0 || num >= dbg_curr_process->next_bp || 
990         !dbg_curr_process->bp[num].refcount)
991     {
992         dbg_printf("Invalid breakpoint number %d\n", num);
993         return FALSE;
994     }
995
996     if (dbg_curr_process->bp[num].condition != NULL)
997     {
998         expr_free(dbg_curr_process->bp[num].condition);
999         dbg_curr_process->bp[num].condition = NULL;
1000     }
1001
1002     if (exp != NULL) dbg_curr_process->bp[num].condition = expr_clone(exp, NULL);
1003
1004     return TRUE;
1005 }