lib/libc/i386/sys/i386_set_watch.3

   1 .\" Copyright (c) 2000 Brian S. Dean
   2 .\" All rights reserved.
   3 .\"
   4 .\" This man-page is based on a similar man-page by Jonathan Lemon
   5 .\" which is copyrighted under the following conditions:
   6 .\"
   7 .\" Redistribution and use in source and binary forms, with or without
   8 .\" modification, are permitted provided that the following conditions
   9 .\" are met:
  10 .\" 1. Redistributions of source code must retain the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer.
  12 .\" 2. Redistributions in binary form must reproduce the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer in the
  14 .\"    documentation and/or other materials provided with the distribution.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .\" $FreeBSD: src/lib/libc/i386/sys/i386_set_watch.3,v 1.1.2.4 2002/12/29 16:35:34 schweikh Exp $
  29 .\"
  30 .Dd August 24, 2000
  31 .Dt I386_SET_WATCH 3
  32 .Os
  33 .Sh NAME
  34 .Nm i386_clr_watch ,
  35 .Nm i386_set_watch
  36 .Nd manage i386 debug register values
  37 .Sh LIBRARY
  38 .Lb libc
  39 .Sh SYNOPSIS
  40 .In machine/reg.h
  41 .In machine/sysarch.h
  42 .Ft int
  43 .Fn i386_clr_watch "int watchnum" "struct dbreg *d"
  44 .Ft int
  45 .Fn i386_set_watch "int watchnum" "unsigned int watchaddr" "int size" "int access" "struct dbreg *d"
  46 .Sh DESCRIPTION
  47 .Fn i386_clr_watch
  48 will disable the indicated watch point within the specified debug
  49 register set.
  50 .Pp
  51 .Fn i386_set_watch
  52 will set up the specified debug registers as indicated by the
  53 parameters.  The
  54 .Fa watchnum
  55 argument specifies which watch register is used, 0, 1, 2, 3, or -1.  If
  56 .Fa watchnum
  57 is -1, a free watch register is found and used.  If there are no free
  58 watch registers, an error code of -1 is returned.
  59 .Fa Watchaddr
  60 specifies the watch address,
  61 .Fa size
  62 specifies the size in bytes of the area to be watched (1, 2, or 4 bytes),
  63 and
  64 .Fa access
  65 specifies the type of watch point:
  66 .Pp
  67 .Bd -literal -offset indent -compact
  68 DBREG_DR7_EXEC    An execution breakpoint.
  69 DBREG_DR7_WRONLY  Break only when the watch area is written to.
  70 DBREG_DR7_RDWR    Break when the watch area is read from or written
  71                   to.
  72 .Ed
  73 .Pp
  74 Note that these functions do not actually set or clear breakpoints;
  75 they manipulate the indicated debug register set.  You must use
  76 .Xr ptrace 2
  77 to retrieve and install the debug register values for a process.
  78 .Sh RETURN VALUES
  79 .Fn i386_clr_watch
  80 returns 0 on success, or -1 if
  81 .Fa watchnum
  82 is invalid (not in the range of 0-3).
  83 .Pp
  84 .Fn i386_set_watch
  85 will return the
  86 .Fa watchnum
  87 argument, or the watchnum actually used in the case that
  88 .Fa watchnum
  89 is -1 on success.  On error,
  90 .Fn i386_set_watch
  91 will return -1 indicating that the watchpoint could not be set up
  92 because either no more watchpoints are available, or
  93 .Fa watchnum ,
  94 .Fa size ,
  95 or
  96 .Fa access
  97 is invalid.
  98 .Sh SEE ALSO
  99 .Xr ptrace 2 ,
 100 .Xr procfs 5
 101 .Sh AUTHORS
 102 This man page was written by
 103 .An Brian S. Dean .