usr.sbin/memcontrol/memcontrol.8

   1 .\" Copyright (c) 1999 Chris Costello
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\"
  13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  23 .\" SUCH DAMAGE.
  24 .\"
  25 .\" $FreeBSD$
  26 .\"
  27 .Dd September 28, 1999
  28 .Dt MEMCONTROL 8
  29 .Os
  30 .Sh NAME
  31 .Nm memcontrol
  32 .Nd "control system cache behaviour with respect to memory"
  33 .Sh SYNOPSIS
  34 .Nm
  35 .Ar list
  36 .Op Fl a
  37 .Pp
  38 .Nm
  39 .Ar set
  40 .Fl b Ar base
  41 .Fl l Ar length
  42 .Fl o Ar owner
  43 .Ar attribute
  44 .Pp
  45 .Nm
  46 .Ar clear
  47 .Fl o Ar owner
  48 .Pp
  49 .Nm
  50 .Ar clear
  51 .Fl b Ar base
  52 .Fl l Ar length
  53 .Sh DESCRIPTION
  54 A number of supported system architectures allow the behaviour of the CPU
  55 cache to be programmed to behave differently depending on the region being
  56 written.
  57 .Pp
  58 The
  59 .Nm
  60 utility
  61 provides an interface to this facility, allowing CPU cache behavior to
  62 be altered for ranges of system physical memory.
  63 .Pp
  64 These ranges are typically power-of-2 aligned and sized, however the specific
  65 rules governing their layout vary between architectures.  The
  66 .Nm
  67 utility does not attempt to enforce these rules, however the system will
  68 reject any attempt to set an illegal combination.
  69 .Bl -tag -width clear
  70 .It Ar list
  71 List range slots.
  72 .Bl -tag -width xxxxxx
  73 .It Op Fl a
  74 List all range slots, even those that are inactive
  75 .El
  76 .It Ar set
  77 Set memory range attributes.
  78 .Bl -tag -width xxxxxx
  79 .It Fl b Ar base
  80 Memory range base address
  81 .It Fl l Ar length
  82 Length of memory range in bytes, power of 2
  83 .It Fl o Ar owner
  84 Text identifier for this setting (7 char max)
  85 .It Ar attribute
  86 Attributes applied to this range; combinations of
  87 .Ar force ,
  88 .Ar uncacheable ,
  89 .Ar write-combine ,
  90 .Ar write-through ,
  91 .Ar write-back ,
  92 .Ar write-protect
  93 .El
  94 .It Ar clear
  95 Clear memory range attributes.
  96 Ranges may be cleared by owner or by
  97 base/length combination.
  98 .Pp
  99 To clear based on ownership:
 100 .Bl -tag -width xxxxxx
 101 .It Fl o Ar owner
 102 All ranges with this owner will be cleared
 103 .El
 104 .Pp
 105 To clear based on the base/length combination:
 106 .Bl -tag -width xxxxxx
 107 .It Fl b Ar base
 108 Memory range base address
 109 .It Fl l Ar length
 110 Length of memory range in bytes, power of 2
 111 .El
 112 .Pp
 113 Base and length must exactly match an existing range.
 114 .El
 115 .Sh SEE ALSO
 116 .Xr mem 4