Skip to content

Commit e95f3c0

Browse files
author
Stephanie Labasan
committed
- Updating license, adding license header to top of each file
- Removing unused wl_063e.tst - Formatting code, removing trailing whitespace with astyle - Updating README Signed-off-by: Stephanie Labasan <labasan1@llnl.gov>
1 parent 1356b22 commit e95f3c0

11 files changed

Lines changed: 1340 additions & 1175 deletions

File tree

‎LICENSE‎

Lines changed: 165 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,165 @@
1+
GNU LESSER GENERAL PUBLIC LICENSE
2+
Version 3, 29 June 2007
3+
4+
Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
5+
Everyone is permitted to copy and distribute verbatim copies
6+
of this license document, but changing it is not allowed.
7+
8+
9+
This version of the GNU Lesser General Public License incorporates
10+
the terms and conditions of version 3 of the GNU General Public
11+
License, supplemented by the additional permissions listed below.
12+
13+
0. Additional Definitions.
14+
15+
As used herein, "this License" refers to version 3 of the GNU Lesser
16+
General Public License, and the "GNU GPL" refers to version 3 of the GNU
17+
General Public License.
18+
19+
"The Library" refers to a covered work governed by this License,
20+
other than an Application or a Combined Work as defined below.
21+
22+
An "Application" is any work that makes use of an interface provided
23+
by the Library, but which is not otherwise based on the Library.
24+
Defining a subclass of a class defined by the Library is deemed a mode
25+
of using an interface provided by the Library.
26+
27+
A "Combined Work" is a work produced by combining or linking an
28+
Application with the Library. The particular version of the Library
29+
with which the Combined Work was made is also called the "Linked
30+
Version".
31+
32+
The "Minimal Corresponding Source" for a Combined Work means the
33+
Corresponding Source for the Combined Work, excluding any source code
34+
for portions of the Combined Work that, considered in isolation, are
35+
based on the Application, and not on the Linked Version.
36+
37+
The "Corresponding Application Code" for a Combined Work means the
38+
object code and/or source code for the Application, including any data
39+
and utility programs needed for reproducing the Combined Work from the
40+
Application, but excluding the System Libraries of the Combined Work.
41+
42+
1. Exception to Section 3 of the GNU GPL.
43+
44+
You may convey a covered work under sections 3 and 4 of this License
45+
without being bound by section 3 of the GNU GPL.
46+
47+
2. Conveying Modified Versions.
48+
49+
If you modify a copy of the Library, and, in your modifications, a
50+
facility refers to a function or data to be supplied by an Application
51+
that uses the facility (other than as an argument passed when the
52+
facility is invoked), then you may convey a copy of the modified
53+
version:
54+
55+
a) under this License, provided that you make a good faith effort to
56+
ensure that, in the event an Application does not supply the
57+
function or data, the facility still operates, and performs
58+
whatever part of its purpose remains meaningful, or
59+
60+
b) under the GNU GPL, with none of the additional permissions of
61+
this License applicable to that copy.
62+
63+
3. Object Code Incorporating Material from Library Header Files.
64+
65+
The object code form of an Application may incorporate material from
66+
a header file that is part of the Library. You may convey such object
67+
code under terms of your choice, provided that, if the incorporated
68+
material is not limited to numerical parameters, data structure
69+
layouts and accessors, or small macros, inline functions and templates
70+
(ten or fewer lines in length), you do both of the following:
71+
72+
a) Give prominent notice with each copy of the object code that the
73+
Library is used in it and that the Library and its use are
74+
covered by this License.
75+
76+
b) Accompany the object code with a copy of the GNU GPL and this license
77+
document.
78+
79+
4. Combined Works.
80+
81+
You may convey a Combined Work under terms of your choice that,
82+
taken together, effectively do not restrict modification of the
83+
portions of the Library contained in the Combined Work and reverse
84+
engineering for debugging such modifications, if you also do each of
85+
the following:
86+
87+
a) Give prominent notice with each copy of the Combined Work that
88+
the Library is used in it and that the Library and its use are
89+
covered by this License.
90+
91+
b) Accompany the Combined Work with a copy of the GNU GPL and this license
92+
document.
93+
94+
c) For a Combined Work that displays copyright notices during
95+
execution, include the copyright notice for the Library among
96+
these notices, as well as a reference directing the user to the
97+
copies of the GNU GPL and this license document.
98+
99+
d) Do one of the following:
100+
101+
0) Convey the Minimal Corresponding Source under the terms of this
102+
License, and the Corresponding Application Code in a form
103+
suitable for, and under terms that permit, the user to
104+
recombine or relink the Application with a modified version of
105+
the Linked Version to produce a modified Combined Work, in the
106+
manner specified by section 6 of the GNU GPL for conveying
107+
Corresponding Source.
108+
109+
1) Use a suitable shared library mechanism for linking with the
110+
Library. A suitable mechanism is one that (a) uses at run time
111+
a copy of the Library already present on the user's computer
112+
system, and (b) will operate properly with a modified version
113+
of the Library that is interface-compatible with the Linked
114+
Version.
115+
116+
e) Provide Installation Information, but only if you would otherwise
117+
be required to provide such information under section 6 of the
118+
GNU GPL, and only to the extent that such information is
119+
necessary to install and execute a modified version of the
120+
Combined Work produced by recombining or relinking the
121+
Application with a modified version of the Linked Version. (If
122+
you use option 4d0, the Installation Information must accompany
123+
the Minimal Corresponding Source and Corresponding Application
124+
Code. If you use option 4d1, you must provide the Installation
125+
Information in the manner specified by section 6 of the GNU GPL
126+
for conveying Corresponding Source.)
127+
128+
5. Combined Libraries.
129+
130+
You may place library facilities that are a work based on the
131+
Library side by side in a single library together with other library
132+
facilities that are not Applications and are not covered by this
133+
License, and convey such a combined library under terms of your
134+
choice, if you do both of the following:
135+
136+
a) Accompany the combined library with a copy of the same work based
137+
on the Library, uncombined with any other library facilities,
138+
conveyed under the terms of this License.
139+
140+
b) Give prominent notice with the combined library that part of it
141+
is a work based on the Library, and explaining where to find the
142+
accompanying uncombined form of the same work.
143+
144+
6. Revised Versions of the GNU Lesser General Public License.
145+
146+
The Free Software Foundation may publish revised and/or new versions
147+
of the GNU Lesser General Public License from time to time. Such new
148+
versions will be similar in spirit to the present version, but may
149+
differ in detail to address new problems or concerns.
150+
151+
Each version is given a distinguishing version number. If the
152+
Library as you received it specifies that a certain numbered version
153+
of the GNU Lesser General Public License "or any later version"
154+
applies to it, you have the option of following the terms and
155+
conditions either of that published version or of any later version
156+
published by the Free Software Foundation. If the Library as you
157+
received it does not specify a version number of the GNU Lesser
158+
General Public License, you may choose any version of the GNU Lesser
159+
General Public License ever published by the Free Software Foundation.
160+
161+
If the Library as you received it specifies that a proxy can decide
162+
whether future versions of the GNU Lesser General Public License shall
163+
apply, that proxy's public statement of acceptance of any version is
164+
permanent authorization for you to choose that version for the
165+
Library.

‎Makefile‎

Lines changed: 30 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,32 @@
1-
# Copyright (c) 2011, 2012, 2013, 2014, 2015 by Lawrence Livermore National
2-
# Security, LLC. LLNL-CODE-645430 Produced at the Lawrence Livermore National
3-
# Laboratory. Written by Marty McFadden, Kathleen Shoga and Barry Rountree
4-
# (mcfadden1|shoga1|rountree@llnl.gov).
5-
# All rights reserved.
6-
#
7-
# This file is part of msr-safe.
8-
#
9-
# msr-safe is free software: you can redistribute it and/or
10-
# modify it under the terms of the GNU Lesser General Public
11-
# License as published by the Free Software Foundation, either
12-
# version 3 of the License, or (at your option) any
13-
# later version.
14-
#
15-
# msr-safe is distributed in the hope that it will be useful, but
16-
# WITHOUT ANY WARRANTY; without even the implied warranty of
17-
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18-
# Lesser General Public License for more details.
19-
#
20-
# You should have received a copy of the GNU Lesser General Public
21-
# License along
22-
# with msr-safe. If not, see <http://www.gnu.org/licenses/>.
23-
#
24-
# This material is based upon work supported by the U.S. Department
25-
# of Energy's Lawrence Livermore National Laboratory. Office of
26-
# Science, under Award number DE-AC52-07NA27344.
27-
1+
# Copyright (c) 2011-2017 by Lawrence Livermore National Security, LLC.
2+
# LLNL-CODE-645430
3+
#
4+
# Produced at Lawrence Livermore National Laboratory.
5+
# Written by Marty McFadden, mcfadden8@llnl.gov
6+
# Kathleen Shoga, shoga1@llnl.gov
7+
# Barry Rountree, rountree@llnl.gov
8+
#
9+
# All rights reserved.
10+
#
11+
# This file is part of msr-safe.
2812
#
13+
# msr-safe is free software: you can redistribute it and/or modify it under
14+
# the terms of the GNU Lesser General Public License as published by the Free
15+
# Software Foundation, either version 3 of the License, or (at your option)
16+
# any later version.
17+
#
18+
# msr-safe is distributed in the hope that it will be useful, but WITHOUT ANY
19+
# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
20+
# FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
21+
# details.
22+
#
23+
# You should have received a copy of the GNU Lesser General Public License
24+
# along with msr-safe. If not, see <http://www.gnu.org/licenses/>.
25+
#
26+
# This material is based upon work supported by the U.S. Department of
27+
# Energy's Lawrence Livermore National Laboratory. Office of Science, under
28+
# Award number DE-AC52-07NA27344.
29+
2930
# Uncomment following line(s) to enable debug output from different
3031
# portions of kernel module.
3132
#
@@ -34,11 +35,11 @@
3435
#CFLAGS_msr_batch.o := -DDEBUG
3536
#CFLAGS_msr-smp.o := -DDEBUG
3637

37-
obj-m += msr-safe.o
38+
obj-m += msr-safe.o
3839
msr-safe-objs := msr_entry.o msr_whitelist.o msr-smp.o msr_batch.o
3940

4041
all: msrsave/msrsave
41-
make -C /lib/modules/$(shell uname -r)/build M=$(PWD) modules
42+
make -C /lib/modules/$(shell uname -r)/build M=$(PWD) modules
4243

4344
clean:
4445
make -C /lib/modules/$(shell uname -r)/build M=$(PWD) clean

‎README‎

Lines changed: 41 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,5 @@
1-
# Copyright (c) 2011, 2012, 2013, 2014, 2015 by Lawrence Livermore National
2-
# Security, LLC. LLNL-CODE-645430
3-
# Produced at the Lawrence Livermore National Laboratory.
4-
# Written by Marty McFadden, Kathleen Shoga and Barry Rountree
5-
# (mcfadden1|shoga1|rountree@llnl.gov). All rights reserved.
6-
#
7-
# This file is part of msr-safe.
8-
#
9-
# msr-safe is free software: you can redistribute it and/or modify it under
10-
# the terms of the GNU Lesser General Public License as published by the Free
11-
# Software Foundation, either version 3 of the License, or (at your option)
12-
# any later version.
13-
#
14-
# msr-safe is distributed in the hope that it will be useful, but WITHOUT ANY
15-
# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
16-
# FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for
17-
# more details.
18-
#
19-
# You should have received a copy of the GNU Lesser General Public License
20-
# along with msr-safe. If not, see <http://www.gnu.org/licenses/>.
21-
#
22-
# This material is based upon work supported by the U.S. Department of
23-
# Energy's Lawrence Livermore National Laboratory. Office of Science, under
24-
# Award number DE-AC52-07NA27344.
1+
MSR-SAFE
2+
========
253

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

@@ -32,25 +10,58 @@ The msr-safe.ko module is comprised of the following source files:
3210
msr_whitelist.[ch] MSR Whitelist implementation
3311
whitelists Sample text whitelist that may be input to msr_safe
3412

35-
Configuration notes after install
36-
=================================
37-
Setup permissions and groups for `/dev/cpu/#/msr_safe` as you like since
13+
Kernel Build & Load
14+
-------------------
15+
Building the msr-safe.ko module can be done with the commands below. A
16+
successful load of the msr-safe kernel module will have `msr_batch` and
17+
`msr_whitelist` in `/dev/cpu`, and will have an `msr_safe` present under each
18+
CPU directory in `/dev/cpu/*`.
19+
20+
git clone https://github.com/LLNL/msr-safe
21+
cd msr-safe
22+
make
23+
insmod msr-safe.ko
24+
25+
Configuration Notes After Install
26+
---------------------------------
27+
Setup permissions and group ownership for `/dev/cpu/msr_batch`,
28+
`/dev/cpu/msr_whitelist`, and `/dev/cpu/*/msr_safe` as you like since the
3829
whitelist will protect you from harm.
3930

40-
Sample whitelists for each architecture are provided in `whitelists/` directory.
31+
Sample whitelists for specific architectures are provided in `whitelists/`
32+
directory. These are meant to be a starting point, and should be used with
33+
caution. Each site may add to, remove from, or modify the write masks in the
34+
whitelist depending on specific needs.
4135

42-
To configure whitelist (as root):
36+
To configure whitelist:
4337

4438
cat whitelist/wl_file > /dev/cpu/msr_whitelist
4539

4640
Where `wl_file` can be determined as follows:
4741

4842
printf 'wl_%.2x%x\n' $(lscpu | grep "CPU family:" | awk -F: '{print $2}') $(lscpu | grep "Model:" | awk -F: '{print $2}')
4943

50-
To enumerate current whitelist (as root):
44+
To confirm successful whitelist configured:
45+
46+
cat /dev/cpu/msr_whitelist
47+
48+
To enumerate the current whitelist (i.e., implies whitelist was loaded
49+
successfully):
5150

5251
cat < /dev/cpu/msr_whitelist
5352

5453
To remove whitelist (as root):
5554

5655
echo > /dev/cpu/msr_whitelist
56+
57+
msrsave
58+
-------
59+
The msrsave utility provides a mechanism for saving and restoring MSR values
60+
based on entries in the whitelist. To restore MSR values, the register must
61+
have an appropriate writemask.
62+
63+
Release
64+
-------
65+
66+
msr-safe is released under the GPLv3 license. For more details, please see the
67+
[LICENSE](https://github.com/LLNL/msr-safe/blob/master/LICENSE) file.

0 commit comments

Comments
 (0)