MTRR (Memory Type Range Register) control

MTRR 사용 중단과 PAT 전환

이 문서는 `SPDX-License-Identifier: GPL-2.0`으로 배포됩니다. Richard Gooch `<[email protected]>`가 1999년 6월 3일 작성했고 Luis R. Rodriguez `<[email protected]>`가 2015년 4월 9일 갱신했습니다.

현대 x86 hardware에서는 MTRR 사용을 PAT가 대체합니다. Linux device driver가 MTRR을 직접 사용하는 방식은 완전히 단계적으로 폐지되었습니다. driver는 `arch_phys_wc_add()`와 `ioremap_wc()`를 함께 사용해야 합니다. 이 조합은 PAT가 없는 system에서는 MTRR을 적용하고 PAT가 활성화된 system에서는 no-op이지만 같은 효과를 냅니다.

Linux가 MTRR을 직접 사용하지 않아도 일부 x86 platform firmware는 OS boot 전에 MTRR을 설정할 수 있습니다. platform firmware가 MTRR access를 직접 구현하고 제어하는 경우가 있기 때문입니다.

예를 들어 SMI handler를 이용한 fan control에서는 platform code가 일부 fan-control register에 uncachable access를 해야 할 수 있습니다. 이런 platform access에는 OS의 MTRR code가 필요하지 않지만, OS가 요청하는 mapping이 platform의 MTRR 설정과 일치하는지 확인하기 위한 `mtrr_type_lookup()`은 필요합니다.

MTRR을 platform firmware만 설정하고 OS가 특정 MTRR mapping을 요청하지 않는다면 `mtrr_type_lookup()`은 항상 `MTRR_TYPE_INVALID`를 반환해야 합니다. 자세한 내용은 `Documentation/arch/x86/pat.rst`를 참고하십시오.

legacy processor 지원과 interface

Cyrix 6x86, 6x86MX, M II processor는 MTRR과 비슷한 Address Range Register(ARR)를 제공하며 ARR로 MTRR을 emulate합니다.

AMD K6-2 stepping 8 이상과 K6-3 processor는 지원되는 MTRR 2개를 제공합니다. AMD Athlon family는 Intel 방식 MTRR 8개를 제공합니다.

Centaur C6(WinChip)는 write-combining을 허용하는 MCR 8개를 제공하며 지원됩니다. VIA Cyrix III와 VIA C3 CPU도 Intel 방식 MTRR 8개를 제공합니다.

`CONFIG_MTRR` option은 MTRR을 조작할 수 있는 `/proc/mtrr` file을 만듭니다. 일반적으로 X server가 이를 사용해야 합니다. 다른 processor의 유사한 control register도 쉽게 지원할 수 있도록 interface는 충분히 generic하게 설계되었습니다.

`/proc/mtrr`에는 읽고 쓸 수 있는 ASCII interface와 `ioctl()` interface가 있습니다. ASCII interface는 administration용이고 `ioctl()` interface는 X server 같은 C program용입니다. 다음 구간에서 command와 C code 예시를 설명합니다.

shell에서 MTRR 읽기와 생성

현재 MTRR은 shell에서 다음과 같이 읽습니다.

% cat /proc/mtrr
reg00: base=0x00000000 (   0MB), size= 128MB: write-back, count=1
reg01: base=0x08000000 ( 128MB), size=  64MB: write-back, count=1

C-shell에서는 다음 명령으로 MTRR을 생성합니다.

# echo "base=0xf8000000 size=0x400000 type=write-combining" >! /proc/mtrr

bash에서는 다음 명령을 사용합니다.

# echo "base=0xf8000000 size=0x400000 type=write-combining" >| /proc/mtrr

생성 결과는 다음과 같습니다.

% cat /proc/mtrr
reg00: base=0x00000000 (   0MB), size= 128MB: write-back, count=1
reg01: base=0x08000000 ( 128MB), size=  64MB: write-back, count=1
reg02: base=0xf8000000 (3968MB), size=   4MB: write-combining, count=1

이 entry는 base address `0xf8000000`, 크기 4MB인 video RAM을 위한 것입니다. base address는 linear framebuffer address를 알려 주는 X server output에서 확인해야 합니다. 일반적인 line은 다음과 같습니다.

(--) S3: PCI: 968 rev 0, Linear FB @ 0xf8000000

X server가 framebuffer base address를 옮길 수 있으므로 다른 값이 아니라 X server가 보고한 값만 사용해야 합니다.

framebuffer 크기는 다음 line에서 확인할 수 있습니다.

(--) S3: videoram:  4096k

이는 4MB이며 hexadecimal byte 수로는 `0x400000`입니다. 문서 작성 당시 XFree86가 `ioctl()` interface로 `/proc/mtrr`을 자동 조작하게 하는 patch가 작성 중이었습니다. commercial X server를 사용한다면 vendor에 MTRR 지원 추가를 요청해야 합니다.

overlap MTRR 생성과 삭제

16MB write-combining range의 시작 4kB를 uncachable로 겹치게 만들려면 다음 명령을 사용합니다.

%echo "base=0xfb000000 size=0x1000000 type=write-combining" >/proc/mtrr
%echo "base=0xfb000000 size=0x1000 type=uncachable" >/proc/mtrr

결과는 다음과 같습니다.

% cat /proc/mtrr
reg00: base=0x00000000 (   0MB), size=  64MB: write-back, count=1
reg01: base=0xfb000000 (4016MB), size=  16MB: write-combining, count=1
reg02: base=0xfb000000 (4016MB), size=   4kB: uncachable, count=1

일부 card, 특히 Voodoo Graphics board는 region 시작의 4kB를 register에 사용하므로 이 범위를 제외해야 합니다.

C-shell에서 register 2를 비활성화하려면 다음 명령을 사용합니다.

% echo "disable=2" >! /proc/mtrr

bash에서는 다음 명령을 사용합니다.

% echo "disable=2" >| /proc/mtrr

C program에서 ioctl로 MTRR 읽기

`mtrr-show.c` 예제는 `/proc/mtrr`을 직접 읽는 대신 `/proc/mtrr` file descriptor에 `ioctl()`을 호출해 현재 MTRR 설정을 출력합니다. `struct mtrr_gentry`의 `regnum`을 0부터 증가시키며 `MTRRIOC_GET_ENTRY`가 성공하는 동안 각 register의 base, size, type을 표시합니다.

size가 1보다 작으면 disabled register로 출력합니다. `/proc/mtrr`이 없으면 MTRR이 지원되지 않거나 PPro가 아닐 수 있다는 message와 함께 종료하고, enumeration 끝의 `EINVAL`은 정상 종료로 처리합니다.

/*  mtrr-show.c

    Source file for mtrr-show (example program to show MTRRs using ioctl()'s)

    Copyright (C) 1997-1998  Richard Gooch

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.

    Richard Gooch may be reached by email at  [email protected]
    The postal address is:
      Richard Gooch, c/o ATNF, P. O. Box 76, Epping, N.S.W., 2121, Australia.
*/

/*
    This program will use an ioctl() on /proc/mtrr to show the current MTRR
    settings. This is an alternative to reading /proc/mtrr.


    Written by      Richard Gooch   17-DEC-1997

    Last updated by Richard Gooch   2-MAY-1998


*/
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <fcntl.h>
#include <sys/ioctl.h>
#include <errno.h>
#include <asm/mtrr.h>

#define TRUE 1
#define FALSE 0
#define ERRSTRING strerror (errno)

static char *mtrr_strings[MTRR_NUM_TYPES] =
{
    "uncachable",               /* 0 */
    "write-combining",          /* 1 */
    "?",                        /* 2 */
    "?",                        /* 3 */
    "write-through",            /* 4 */
    "write-protect",            /* 5 */
    "write-back",               /* 6 */
};

int main ()
{
    int fd;
    struct mtrr_gentry gentry;

    if ( ( fd = open ("/proc/mtrr", O_RDONLY, 0) ) == -1 )
    {
  if (errno == ENOENT)
  {
      fputs ("/proc/mtrr not found: not supported or you don't have a PPro?\n",
      stderr);
      exit (1);
  }
  fprintf (stderr, "Error opening /proc/mtrr\t%s\n", ERRSTRING);
  exit (2);
    }
    for (gentry.regnum = 0; ioctl (fd, MTRRIOC_GET_ENTRY, &gentry) == 0;
  ++gentry.regnum)
    {
  if (gentry.size < 1)
  {
      fprintf (stderr, "Register: %u disabled\n", gentry.regnum);
      continue;
  }
  fprintf (stderr, "Register: %u base: 0x%lx size: 0x%lx type: %s\n",
    gentry.regnum, gentry.base, gentry.size,
    mtrr_strings[gentry.type]);
    }
    if (errno == EINVAL) exit (0);
    fprintf (stderr, "Error doing ioctl(2) on /dev/mtrr\t%s\n", ERRSTRING);
    exit (3);
}   /*  End Function main  */

C program에서 ioctl로 MTRR 생성

`mtrr-add.c` 예제는 `/proc/mtrr`에 직접 쓰는 대신 `ioctl()`로 새 entry를 추가하며 첫 번째 available MTRR을 사용합니다. command line에서 `base`, `size`, `type` 세 argument를 받습니다.

문자열 type을 `MTRR_NUM_TYPES` 범위에서 찾아 `struct mtrr_sentry`에 저장하고 `/proc/mtrr`을 write-only로 엽니다. `MTRRIOC_ADD_ENTRY`로 entry를 추가한 뒤 5초간 sleep하고 file을 닫습니다. close되면 새 entry가 제거되었음을 알립니다.

/*  mtrr-add.c

    Source file for mtrr-add (example programme to add an MTRRs using ioctl())

    Copyright (C) 1997-1998  Richard Gooch

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.

    Richard Gooch may be reached by email at  [email protected]
    The postal address is:
      Richard Gooch, c/o ATNF, P. O. Box 76, Epping, N.S.W., 2121, Australia.
*/

/*
    This programme will use an ioctl() on /proc/mtrr to add an entry. The first
    available mtrr is used. This is an alternative to writing /proc/mtrr.


    Written by      Richard Gooch   17-DEC-1997

    Last updated by Richard Gooch   2-MAY-1998


*/
#include <stdio.h>
#include <string.h>
#include <stdlib.h>
#include <unistd.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <fcntl.h>
#include <sys/ioctl.h>
#include <errno.h>
#include <asm/mtrr.h>

#define TRUE 1
#define FALSE 0
#define ERRSTRING strerror (errno)

static char *mtrr_strings[MTRR_NUM_TYPES] =
{
    "uncachable",               /* 0 */
    "write-combining",          /* 1 */
    "?",                        /* 2 */
    "?",                        /* 3 */
    "write-through",            /* 4 */
    "write-protect",            /* 5 */
    "write-back",               /* 6 */
};

int main (int argc, char **argv)
{
    int fd;
    struct mtrr_sentry sentry;

    if (argc != 4)
    {
  fprintf (stderr, "Usage:\tmtrr-add base size type\n");
  exit (1);
    }
    sentry.base = strtoul (argv[1], NULL, 0);
    sentry.size = strtoul (argv[2], NULL, 0);
    for (sentry.type = 0; sentry.type < MTRR_NUM_TYPES; ++sentry.type)
    {
  if (strcmp (argv[3], mtrr_strings[sentry.type]) == 0) break;
    }
    if (sentry.type >= MTRR_NUM_TYPES)
    {
  fprintf (stderr, "Illegal type: \"%s\"\n", argv[3]);
  exit (2);
    }
    if ( ( fd = open ("/proc/mtrr", O_WRONLY, 0) ) == -1 )
    {
  if (errno == ENOENT)
  {
      fputs ("/proc/mtrr not found: not supported or you don't have a PPro?\n",
      stderr);
      exit (3);
  }
  fprintf (stderr, "Error opening /proc/mtrr\t%s\n", ERRSTRING);
  exit (4);
    }
    if (ioctl (fd, MTRRIOC_ADD_ENTRY, &sentry) == -1)
    {
  fprintf (stderr, "Error doing ioctl(2) on /dev/mtrr\t%s\n", ERRSTRING);
  exit (5);
    }
    fprintf (stderr, "Sleeping for 5 seconds so you can see the new entry\n");
    sleep (5);
    close (fd);
    fputs ("I've just closed /proc/mtrr so now the new entry should be gone\n",
    stderr);
}   /*  End Function main  */