system_cmds/zlog.tproj/zlog.1

   1 .\" Copyright (c) 2018, Apple Inc.  All rights reserved.
   2 .\"
   3 .Dd February 21, 2018
   4 .Dt ZLOG 1
   5 .Os "Mac OS X"
   6 .Sh NAME
   7 .Nm zlog
   8 .Nd show allocation backtraces for kernel zones
   9 .Sh SYNOPSIS
  10 .Nm
  11 .Op Fl t
  12 .Op Fl z Ar name Op Fl n Ar num | Fl l
  13 .Op Fl h
  14 .Sh DESCRIPTION
  15 .Nm
  16 displays allocation (and free, if used in corruption tracking mode with
  17 the boot-arg "-zc") backtraces for zones that have zone logging enabled.
  18 Zone logging can be turned on by using the boot-arg "zlog<N>=<name>",
  19 where 'N' can range from 1 to 10, and 'name' is the name of the zone to
  20 be tracked.
  21 .Pp
  22 .Nm
  23 interprets the following options:
  24 .Pp
  25 .Bl -tag -width "disable -"
  26 .\" -t
  27 .It Fl t
  28 (Default) list all the zones that have logging enabled
  29 .\" -z
  30 .It Fl z Ar name
  31 show all allocation backtraces for zone
  32 .Ar name
  33 .\" -n
  34 .It Fl n Ar num
  35 Can be used in combination with the
  36 .Fl z
  37 option to show the top
  38 .Ar num
  39 backtraces with the most active references in the zone
  40 .Ar name
  41 .\" -l
  42 .It Fl l
  43 Can be used in combination with the
  44 .Fl z
  45 option to show the backtrace most likely contributing to a leak in the zone
  46 .Ar name
  47 (prints the backtrace with the most active references)
  48 .\" -h
  49 .It Fl h
  50 show the help text
  51 .El
  52 .Sh DIAGNOSTICS
  53 .Ex -std
  54 .Sh SEE ALSO
  55 .Xr zprint 1 ,
  56 .Xr ioclasscount 1