README

#  Copyright (c) 2011, 2012, 2013, 2014, 2015 by Lawrence Livermore National
#  Security, LLC. LLNL-CODE-645430
#  Produced at the Lawrence Livermore National Laboratory.
#  Written by Marty McFadden, Kathleen Shoga and Barry Rountree
#  (mcfadden1|shoga1|rountree@llnl.gov).  All rights reserved.
#
#  This file is part of msr-safe.
#
#  msr-safe is free software: you can redistribute it and/or modify it under
#  the terms of the GNU Lesser General Public License as published by the Free
#  Software Foundation, either version 3 of the License, or (at your option)
#  any later version.
#
#  msr-safe 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 Lesser General Public License for
#  more details.
#
#  You should have received a copy of the GNU Lesser General Public License
#  along with msr-safe. If not, see <http://www.gnu.org/licenses/>.
#
#  This material is based upon work supported by the U.S. Department of
#  Energy's Lawrence Livermore National Laboratory. Office of Science, under
#  Award number DE-AC52-07NA27344.

The msr-safe.ko module is comprised of the following source files:

Makefile
msr_entry.c		Original MSR driver with added calls to batch and
			whitelist implementations.
msr_batch.[ch]		MSR batching implementation
msr_whitelist.[ch]	MSR Whitelist implementation
whitelists		Sample text whitelist that may be input to msr_safe

Configuration notes after install:

Set up permissions and groups for /dev/cpu/#/msr_safe as you like since white
list will protect you from harm.

Sample white lists for each architecture are provided in whitelists directory.

To configure whitelist (as root):
	cat whitelist/wl_file > /dev/cpu/msr_whitelist

To enumerate current whitelist (as root):
	cat < /dev/cpu/msr_whitelist

To remove whitelist (as root):
	echo > /dev/cpu/msr_whitelist