Migrating updated libmsr code base with Doxygen documentation:

- Added more turbo functionality, specifically, turbo activation ratio and
  turbo ratio limits.
- Added functionality to modify p-states.
- Auto-formatting code base using astyle.
- Created standard libmsr error handler.
- Cleaning up powmon demoapp - should work with current libmsr version.
- Refactoring msrmod tool to use getopt for command line parsing.

Signed-off-by: Stephanie Labasan <[email protected]>

Author: Stephanie Labasan

.gitignore

@@ -1,15 +1,17 @@
-test/libmsr_test
-*.o
-*.so
-app
-cab*
-pebs
-*.core
 *.btr
+*.core
+*.o
 *.out
+*.so
 *~
 BUILD/
+CMakeCache.txt
+CMakeFiles/
+Makefile
 _autoconf_
+app
+cab*
+cmake_install.cmake
 demoapps/powmon/Makefile
 demoapps/powmon/Makefile.in
 demoapps/powmon/aclocal.m4
@@ -29,5 +31,25 @@ demoapps/powmon/src/power_wrapper_dynamic
 demoapps/powmon/src/power_wrapper_static
 demoapps/powmon/src/powmon
 demoapps/powmon/stamp-h1
+documentation/doxygen_*.pdf
+dox/html
+dox/latex
 headers/master.h
+include/CMakeFiles/
+include/Makefile
+include/cmake_install.cmake
 include/master.h
+install_manifest.txt
+lib/
+libmsr-config.cmake
+mpi_test
+pebs
+platform_headers/master.h
+test/dump-data
+test/libmsr-test
+test/libmsr_test
+test/pstate-test
+test/rapl-data
+test/translate
+test/turbo-test
+test/unit-test

CMakeLists.txt

@@ -10,32 +10,90 @@ if (NOT CMAKE_BUILD_TYPE)
     "Choose the type of build, options are: Debug Release RelWithDebInfo." FORCE)
 endif()
 
-#
-# Add install RPATH to all executables & libraries.
-#
-#set(CMAKE_SKIP_BUILD_RPATH FALSE)
-#set(CMAKE_BUILD_WITH_INSTALL_RPATH FALSE)
-#set(CMAKE_INSTALL_RPATH_USE_LINK_PATH TRUE)
-#list(FIND CMAKE_PLATFORM_IMPLICIT_LINK_DIRECTORIES "${CMAKE_INSTALL_PREFIX}/lib" index)
-#if (index LESS 0)
-#  set(CMAKE_INSTALL_RPATH "${CMAKE_INSTALL_PREFIX}/lib")
-#endif()
-
-# libmsr headers are in top level include directory
+# Headers are in top level include directory
 include_directories(${PROJECT_SOURCE_DIR}/include)
 
-#Make libmsr findable
+# Make libmsr findable
 configure_file(
     ${PROJECT_SOURCE_DIR}/libmsr-config.cmake.in
     ${PROJECT_BINARY_DIR}/libmsr-config.cmake
-    @ONLY)
+    @ONLY
+)
 
 install(FILES ${PROJECT_BINARY_DIR}/libmsr-config.cmake DESTINATION
-"${CMAKE_INSTALL_PREFIX}/share/cmake/libmsr")
+    "${CMAKE_INSTALL_PREFIX}/share/cmake/libmsr"
+)
 install(EXPORT libmsr-libs DESTINATION
-"${CMAKE_INSTALL_PREFIX}/share/cmake/libmsr")
+    "${CMAKE_INSTALL_PREFIX}/share/cmake/libmsr"
+)
+
+set(CMAKE_LIBRARY_OUTPUT_DIRECTORY ${PROJECT_SOURCE_DIR}/lib)
+set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY ${PROJECT_SOURCE_DIR}/lib)
 
 add_subdirectory(src)
 add_subdirectory(include)
-add_subdirectory(cmd)
-add_subdirectory(wrap)
+
+find_package(Doxygen)
+if (DOXYGEN_FOUND)
+    add_subdirectory(dox)
+endif(DOXYGEN_FOUND)
+
+add_subdirectory(test)
+
+add_custom_target(distclean
+    rm -f CMakeCache.txt
+    rm -f Makefile
+    rm -f _autoconf_
+    rm -f cmake_install.cmake
+    rm -f demoapps/powmon/Makefile.in
+    rm -f demoapps/powmon/aclocal.m4
+    rm -f demoapps/powmon/config.h
+    rm -f demoapps/powmon/config.h.in
+    rm -f demoapps/powmon/config.log
+    rm -f demoapps/powmon/config.status
+    rm -f demoapps/powmon/configure
+    rm -f demoapps/powmon/depcomp
+    rm -f demoapps/powmon/install-sh
+    rm -f demoapps/powmon/missing
+    rm -f demoapps/powmon/src/Makefile.in
+    rm -f demoapps/powmon/src/Makefile
+    rm -f demoapps/powmon/src/power_wrapper_dynamic
+    rm -f demoapps/powmon/src/power_wrapper_static
+    rm -f demoapps/powmon/src/powmon
+    rm -f demoapps/powmon/stamp-h1
+    rm -f dox/CMakeCache.txt
+    rm -f dox/Makefile
+    rm -f dox/cmake_install.cmake
+    rm -f include/Makefile
+    rm -f include/cmake_install.cmake
+    rm -f include/master.h
+    rm -f install_manifest.txt
+    rm -f libmsr-config.cmake
+    rm -f msrmod/msrmod
+    rm -f platform_headers/master.h
+    rm -f src/Makefile
+    rm -f src/cmake_install.cmake
+    rm -f test/CMakeCache.txt
+    rm -f test/Makefile
+    rm -f test/cmake_install.cmake
+    rm -f test/dump-data
+    rm -f test/libmsr-test
+    rm -f test/pstate-test
+    rm -f test/rapl-data
+    rm -f test/translate
+    rm -f test/turbo-test
+    rm -f test/unit-test
+    rm -rf BUILD/
+    rm -rf CMakeFiles/
+    rm -rf demoapps/powmon/autom4te.cache/
+    rm -rf demoapps/powmon/src/.deps/
+    rm -rf dox/CMakeFiles/
+    rm -rf dox/html/
+    rm -rf dox/latex/
+    rm -rf include/CMakeFiles/
+    rm -rf lib/
+    rm -rf src/CMakeFiles/
+    rm -rf test/CMakeFiles/
+    rm -rf wrap/CMakeFiles/
+    COMMENT "Cleaning up unwanted files" VERBATIM
+)

README

@@ -0,0 +1,107 @@
+LIBMSR
+======
+
+Welcome to libmsr, a friendly (well, friendlier) interface to many of the
+model-specific registers in Intel processors. Now with PCI configuration
+register support for some Intel hardware.
+
+version 0.2.0
+
+
+Last Update
+-----------
+18 August 2016
+
+
+Overview
+--------
+
+Libmsr provides an interface to accessing the model-specific registers (MSRs)
+on Intel platforms, which provide privileged functionality for monitoring and
+controlling various CPU features.
+
+
+Installation
+------------
+
+Installation is simple. You will need [cmake](http://www.cmake.org) version 2.8
+or higher and GCC. The old installation method is deprecated, you MUST use the
+script. In most cases, the installation is as follows:
+
+	install.sh [ /path/to/install ] [ -f arch_model ]
+
+The install script can take two (optional) arguments. The first argument is the
+install directory. If a null or empty string is specified, then a BUILD/
+directory is automatically created in the top-level directory (i.e, where
+install.sh is launched from).
+
+The second argument can explicitly tell the auto-configuration tool to use the
+header file of a specific architecture. To do this, simply add the following
+flag when executing the install script: "-f[architecture number]", where the
+architecture number is in hexadecimal.
+
+Example:
+
+I have an Ivy Bridge client processor which the auto-configuration tool does not
+detect. So, I will force the auto-configuration tool to use the Ivy Bridge
+header file defined in platform_headers/.
+
+	install.sh ~/build/libmsr -f3E
+
+Currently supported architectures are Intel Xeon v1-3 (Sandy Bridge, Ivy
+Bridge, and Haswell server processors). The library technically supports all
+processors based on these architectures, but some features may be missing from
+client products. Using the wrong header file is likely to cause problems.
+
+Supported Architectures:
+
+	2D (Sandy Bridge)
+	3E (Ivy Bridge)
+	3F (Haswell)
+
+If you are unsure of your architecture number, check the "model" field in `lscpu`
+or `/proc/cpuinfo` (note that it won't be in hexadecimal).
+
+
+Notes
+-----
+
+This software depends on the files `/dev/cpu/*/msr` being present with R/W
+permissions. Recent kernels require additional capabilities. We have found it
+easier to use our own [MSR-SAFE](https://github.com/LLNL/msr-safe) kernel
+module, but running as root (or going through the bother of adding the
+capabilities to the binaries) is another option.
+
+If you need PCI configuration register (CSR) support in Libmsr, you MUST have
+CSR-SAFE installed. This code is not currently on Github -- you will need to
+request it.
+
+Call `msr_init()` before using any of the APIs.
+
+For sample code, see libmsr_test.c in the test/ directory.
+
+Our most up-to-date documentation for Libmsr use is generated as part of the
+install script using Doxygen. There are also some useful PDF files in the
+documentation/ directory.
+
+
+Contributing
+------------
+
+Code formatting can be automated using astyle with the following parameters:
+
+    astyle --style=allman --indent=spaces=4 -y -S -C -N <src_file>
+
+
+Contact
+-------
+
+Stephanie Labasan, Developer <[email protected]>
+Scott Walker, Developer, <[email protected]>
+Kathleen Shoga, Developer, <[email protected]>
+Lauren Morita, Developer, <[email protected]>
+Barry Rountree, Project Lead <[email protected]>
+
+We are in the process of migrating our bug tracking to Github. For now, please
+feel free to contact the authors with questions, problems, bugs, and feature
+requests.