lib/libsysdecode/sysdecode_utrace.3

   1 .\"
   2 .\" Copyright (c) 2015 John Baldwin <jhb@FreeBSD.org>
   3 .\" All rights reserved.
   4 .\"
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\" 1. Redistributions of source code must retain the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer.
  10 .\" 2. Redistributions in binary form must reproduce the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer in the
  12 .\"    documentation and/or other materials provided with the distribution.
  13 .\"
  14 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  18 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24 .\" SUCH DAMAGE.
  25 .\"
  26 .\" $FreeBSD$
  27 .\"
  28 .Dd October 17, 2016
  29 .Dt sysdecode_utrace 3
  30 .Os
  31 .Sh NAME
  32 .Nm sysdecode_utrace
  33 .Nd produce text description of a utrace record
  34 .Sh LIBRARY
  35 .Lb libsysdecode
  36 .Sh SYNOPSIS
  37 .In sys/types.h
  38 .In stdbool.h
  39 .In sysdecode.h
  40 .Ft int
  41 .Fn sysdecode_utrace "FILE *fp" "void *buf" "size_t len" "int decimal"
  42 .Sh DESCRIPTION
  43 The
  44 .Fn sysdecode_utrace
  45 function outputs a textual representation of a
  46 .Xr utrace 2
  47 record identified by
  48 .Fa buf
  49 and
  50 .Fa len
  51 to the output stream
  52 .Fa fp .
  53 .Pp
  54 The function only outputs a representation for certain types of records.
  55 If a record is recognized,
  56 the function outputs the description and returns a non-zero value.
  57 If the record is not recognized,
  58 the function does not output anything and returns zero.
  59 The
  60 .Fn sysdecode_utrace
  61 function currently recognizes
  62 .Xr utrace 2
  63 records generated by
  64 .Xr malloc 3
  65 and
  66 .Xr rtld 1 .
  67 .Sh RETURN VALUES
  68 The
  69 .Fn sysdecode_utrace
  70 function returns a non-zero value if it recognizes a
  71 .Xr utrace 2
  72 record;
  73 otherwise it returns zero.
  74 .Sh SEE ALSO
  75 .Xr utrace 2 ,
  76 .Xr sysdecode 3