Commit 7fedc4c8 authored by Shane Snyder's avatar Shane Snyder

finalize release steps for 3.2.0

parent 01f8be10
......@@ -2,14 +2,32 @@
Darshan Release Change Log
--------------------------
Darshan-3.2.0-pre2
=============
* silence stdout from darshan-job-summary.pl and remove --summary option
Darshan-3.2.0
=============
* added detailed instrumentation of HDF5 library file and dataset
interfaces
* added new logutil functions: darshan_log_get_modules,
darshan_log_get_name_records, and darshan_log_get_record (contributed
by Jakob Luettgau)
* extended DXT MPIIO module to trace file offsets
* added "--log-path" option to darshan-config to allow users to more
easily determine where Darshan logs are stored
* silenced stdout from darshan-job-summary.pl and remove --summary option
* removed Darshan stubs library traditionally used in static linking test
cases and other general simplifications of Darshan's static linking options
* fixed bug related to multiple definitions of fscanf symbols when building
Darshan (reported by Francois Trahay)
* updated Darshan's compiler wrapper generators, MPICH profiling config
hooks, and Cray software modules to explicitly link in Darshan in
dynamic linking cases using rpath
* added `darshan-config --log-path` command option to display the log path(s)
configured for use with Darshan
Darshan-3.2.0-pre1
=============
* reimplemented Darshan's MPI/PMPI wrapper macros (using functiona aliases)
to avoid potential deadlock with other PMPI tools
* made use of DESTDIR match standard automake practice (contributed by
Christopher Morrone)
* made "--with-mem-align" option optional, with a default of 8 (contributed
by Christopher Morrone)
* corrected pkgconfig path for darshan-util when using DESTDIR (reported by
Matthew Curry)
* added support for non-MPI instrumenation to Darshan, using GCC
......
#! /bin/sh
# Guess values for system-dependent variables and create Makefiles.
# Generated by GNU Autoconf 2.69 for darshan-runtime 3.2.0-pre1.
# Generated by GNU Autoconf 2.69 for darshan-runtime 3.2.0.
#
#
# Copyright (C) 1992-1996, 1998-2012 Free Software Foundation, Inc.
......@@ -577,8 +577,8 @@ MAKEFLAGS=
# Identity of this package.
PACKAGE_NAME='darshan-runtime'
PACKAGE_TARNAME='darshan-runtime'
PACKAGE_VERSION='3.2.0-pre1'
PACKAGE_STRING='darshan-runtime 3.2.0-pre1'
PACKAGE_VERSION='3.2.0'
PACKAGE_STRING='darshan-runtime 3.2.0'
PACKAGE_BUGREPORT=''
PACKAGE_URL=''
......@@ -621,11 +621,11 @@ ac_includes_default="\
ac_subst_vars='LTLIBOBJS
LIBOBJS
DARSHAN_HDF5_LD_FLAGS
DARSHAN_MDHIM_LD_OPTS
BUILD_MDHIM_MODULE
BUILD_LUSTRE_MODULE
BUILD_BGQ_MODULE
DARSHAN_HDF5_LD_FLAGS
DARSHAN_HDF5_ADD_DFLUSH_LD_OPTS
DARSHAN_HDF5_LD_OPTS
BUILD_HDF5_MODULE
......@@ -1290,7 +1290,7 @@ if test "$ac_init_help" = "long"; then
# Omit some internal or obsolete options to make the list less imposing.
# This message is too long to be a string in the A/UX 3.1 sh.
cat <<_ACEOF
\`configure' configures darshan-runtime 3.2.0-pre1 to adapt to many kinds of systems.
\`configure' configures darshan-runtime 3.2.0 to adapt to many kinds of systems.
Usage: $0 [OPTION]... [VAR=VALUE]...
......@@ -1352,7 +1352,7 @@ fi
if test -n "$ac_init_help"; then
case $ac_init_help in
short | recursive ) echo "Configuration of darshan-runtime 3.2.0-pre1:";;
short | recursive ) echo "Configuration of darshan-runtime 3.2.0:";;
esac
cat <<\_ACEOF
......@@ -1476,7 +1476,7 @@ fi
test -n "$ac_init_help" && exit $ac_status
if $ac_init_version; then
cat <<\_ACEOF
darshan-runtime configure 3.2.0-pre1
darshan-runtime configure 3.2.0
generated by GNU Autoconf 2.69
Copyright (C) 2012 Free Software Foundation, Inc.
......@@ -1828,7 +1828,7 @@ cat >config.log <<_ACEOF
This file contains any messages produced by compilers while
running configure, to aid debugging if configure makes a mistake.
It was created by darshan-runtime $as_me 3.2.0-pre1, which was
It was created by darshan-runtime $as_me 3.2.0, which was
generated by GNU Autoconf 2.69. Invocation command line was
$ $0 $@
......@@ -4881,7 +4881,8 @@ fi
rm -f core conftest.err conftest.$ac_objext conftest.$ac_ext
DARSHAN_VERSION="3.2.0-pre1"
DARSHAN_VERSION="3.2.0"
......@@ -5419,7 +5420,7 @@ cat >>$CONFIG_STATUS <<\_ACEOF || ac_write_fail=1
# report actual input values of CONFIG_FILES etc. instead of their
# values after options handling.
ac_log="
This file was extended by darshan-runtime $as_me 3.2.0-pre1, which was
This file was extended by darshan-runtime $as_me 3.2.0, which was
generated by GNU Autoconf 2.69. Invocation command line was
CONFIG_FILES = $CONFIG_FILES
......@@ -5481,7 +5482,7 @@ _ACEOF
cat >>$CONFIG_STATUS <<_ACEOF || ac_write_fail=1
ac_cs_config="`$as_echo "$ac_configure_args" | sed 's/^ //; s/[\\""\`\$]/\\\\&/g'`"
ac_cs_version="\\
darshan-runtime config.status 3.2.0-pre1
darshan-runtime config.status 3.2.0
configured by $0, generated by GNU Autoconf 2.69,
with options \\"\$ac_cs_config\\"
......
......@@ -5,7 +5,7 @@ dnl Process this file with autoconf to produce a configure script.
dnl You may need to use autoheader as well if changing any DEFINEs
dnl sanity checks, output header, location of scripts used here
AC_INIT([darshan-runtime], [3.2.0-pre1])
AC_INIT([darshan-runtime], [3.2.0])
AC_CONFIG_SRCDIR([darshan.h])
AC_CONFIG_AUX_DIR(../maint/config)
AC_CONFIG_MACRO_DIR(../maint/config)
......
......@@ -18,7 +18,7 @@ but, as of version 3.2.0, Darshan also supports instrumentation of non-MPI
applications. Regardless of whether MPI is used, Darshan provides detailed
statistics about POSIX level file accesses made by the application.
In the case of MPI applications, Darshan additionally captures details on MPI-IO
level access, as well as limited information about HDF5 and PnetCDF access.
and HDF5 level access, as well as limited information about PnetCDF access.
Note that instrumentation of non-MPI applications is currently only supported
in Darshan's shared library, which applications must `LD_PRELOAD`.
......@@ -93,20 +93,27 @@ file. See `./configure --help` for details.
active Darshan instrumentation modules can collectively consume.
* `--with-zlib=`: specifies an alternate location for the zlib development
header and library.
* `CC=`: specifies the C compiler to use for compilation.
* `--without-mpi`: disables MPI support when building Darshan - MPI support is
assumed if not specified.
* `--enable-mmap-logs`: enables the use of Darshan's mmap log file mechanism.
* `--disable-cuserid`: disables use of cuserid() at runtime.
* `--disable-ld-preload`: disables building of the Darshan LD_PRELOAD library
* `--disable-bgq-mod`: disables building of the BG/Q module (default checks
and only builds if BG/Q environment detected).
* `--enable-group-readable-logs`: sets Darshan log file permissions to allow
group read access.
* `--enable-HDF5-pre-1.10`: enables the Darshan HDF5 instrumentation module,
with support for HDF5 versions prior to 1.10
* `--enable-HDF5-post-1.10`: enables the Darshan HDF5 instrumentation module,
with support for HDF5 versions 1.10 or higher
* `CC=`: specifies the C compiler to use for compilation.
.Configure arguments for controlling which Darshan modules to use:
* `--disable-posix-mod`: disables compilation and use of Darshan's POSIX module (default=enabled)
* `--disable-mpiio-mod`: disables compilation and usee of Darshan's MPI-IO module (default=enabled)
* `--disable-stdio-mod`: disables compilation and use of Darshan's STDIO module (default=enabled)
* `--disable-dxt-mod`: disables compilation and use of Darshan's DXT module (default=enabled)
* `--enable-hdf5-mod`: enables compilation and use of Darshan's HDF5 module (default=disabled)
** NOTE: This option requires the HDF5 install prefix as an argument (e.g., `--enable-hdf5-mod=/path/to/hdf5/`)
** NOTE: HDF5 instrumentation only works on HDF5 library versions >=1.8, and further requires that the HDF5 library used to build Darshan and the HDF5 library being linked in either both be version >=1.10 or both be version <1.10
** NOTE: This option does not work with the profile configuration instrumentation method described in the "Instrumenting applications" section (link:darshan-runtime.html#_using_a_profile_configuration[Using a profile configuration])
* `--disable-pnetcdf-mod`: disables compilation and use of Darshan's PNetCDF module (default=enabled)
* `--disable-lustre-mod`: disables compilation and use of Darshan's Lustre module (default=enabled)
* `--disable-mdhim-mod`: disables compilation and use of Darshan's MDHIM module (default=disabled)
== Environment preparation
......@@ -439,6 +446,27 @@ Darshan will typically use the LOGNAME environment variable to determine a
userid.
====
If instrumentation of the HDF5 library is desired, additionally load an
acceptable HDF5 module (e.g., `module load cray-hdf5-parallel`) prior to
building and and use the the `--enable-hdf5-mod=/path/to/hdf5/installation/prefix`
configure argument. We additionally recommend that you modify Darshan's
generated Cray software module to include a dependency on the HDF5 software module used
-- this is necessary to ensure Darshan library dependencies are satisfied at
application link and run time.
----
prereq cray-hdf5-parallel
----
Note that the Darshan-enabled Cray compiler wrappers will always prefer
user-supplied HDF5 libraries over the library used to build Darshan.
However, due to ABI changes in the HDF5 library, the two HDF5 libraries
used must be compatible. Specifically, the HDF5 library versions need to
be either both greater than or equal to 1.10 or both less than 1.10. If
users use an HDF5 version that is incompatible with Darshan, either
link or runtime errors will occur and the user will have to switch
HDF5 versions or unload the Darshan module.
As in any Darshan installation, the darshan-mk-log-dirs.pl script can then be
used to create the appropriate directory hierarchy for storing Darshan log
files in the --with-log-path directory.
......@@ -535,37 +563,6 @@ You can enable Darshan instrumentation at compile time by adding
Alternatively you can use `LD_PRELOAD` runtime instrumentation method to
instrument executables that have already been compiled.
== Upgrading to Darshan 3.x from 2.x
Beginning with Darshan 3.0.0, Darshan has been rewritten to modularize its runtime environment
and log file format to simplify the addition of new I/O characterization data. The process of
compiling and installing the Darshan 3.x source code should essentially be identical to this
process on Darshan 2.x. Therefore, the installation recipes given in the previous section
should work irrespective of the Darshan version being used. Similarly, the manner in which
Darshan is used should be the same across versions -- the sections in this document regarding
Darshan link:darshan-runtime.html#_environment_preparation[environment preparation],
instrumenting link:darshan-runtime.html#_instrumenting_statically_linked_applications[statically
linked applications] and link:darshan-runtime.html#_instrumenting_dynamically_linked_applications[
dynamically linked applications], and using link:darshan-runtime.html#_runtime_environment_variables[
runtime environment variables] are equally applicable to both versions.
However, we do provide some suggestions and expectations for system administrators to keep in
mind when upgrading to Darshan 3.x:
* Darshan 2.x and Darshan 3.x produce incompatible log file formats
** log files named *.darshan.gz or *.darshan.bz2: Darshan 2.x format
** log files named *.darshan: Darshan 3.x format
*** a field in the log file header indicates underlying compression method in 3.x logs
** There is currently no tool for converting 2.x logs into the 3.x log format.
** The `darshan-logutils` library will provide error messages to indicate whether a given
log file is incompatible with the correspnonding library version.
* We encourage administrators to use the same log file directory for version 3.x as had been
used for version 2.x.
** Within this directory, the determination on which set of log utilities (version 2.x
or version 3.x) to use can be based on the file extension for a given log (as explained
above).
== Runtime environment variables
The Darshan library honors the following environment variables to modify
......
......@@ -14,7 +14,7 @@ Notes on how to release a new version of Darshan
- in both darshan-util/ and darshan-runtime/
- re-run ./prepare in both darshan-util and darshan-runtime
- commit
- generate example output files on x86_64, ppc32, and ppc64, commit in
- generate example output files on x86_64 and commit in
darshan-test/example-output/ directory
- use "git status" to make sure that all changes have been committed and
pushed to origin/master
......
#! /bin/sh
# Guess values for system-dependent variables and create Makefiles.
# Generated by GNU Autoconf 2.69 for darshan-util 3.2.0-pre1.
# Generated by GNU Autoconf 2.69 for darshan-util 3.2.0.
#
#
# Copyright (C) 1992-1996, 1998-2012 Free Software Foundation, Inc.
......@@ -577,8 +577,8 @@ MAKEFLAGS=
# Identity of this package.
PACKAGE_NAME='darshan-util'
PACKAGE_TARNAME='darshan-util'
PACKAGE_VERSION='3.2.0-pre1'
PACKAGE_STRING='darshan-util 3.2.0-pre1'
PACKAGE_VERSION='3.2.0'
PACKAGE_STRING='darshan-util 3.2.0'
PACKAGE_BUGREPORT=''
PACKAGE_URL=''
......@@ -1247,7 +1247,7 @@ if test "$ac_init_help" = "long"; then
# Omit some internal or obsolete options to make the list less imposing.
# This message is too long to be a string in the A/UX 3.1 sh.
cat <<_ACEOF
\`configure' configures darshan-util 3.2.0-pre1 to adapt to many kinds of systems.
\`configure' configures darshan-util 3.2.0 to adapt to many kinds of systems.
Usage: $0 [OPTION]... [VAR=VALUE]...
......@@ -1309,7 +1309,7 @@ fi
if test -n "$ac_init_help"; then
case $ac_init_help in
short | recursive ) echo "Configuration of darshan-util 3.2.0-pre1:";;
short | recursive ) echo "Configuration of darshan-util 3.2.0:";;
esac
cat <<\_ACEOF
......@@ -1405,7 +1405,7 @@ fi
test -n "$ac_init_help" && exit $ac_status
if $ac_init_version; then
cat <<\_ACEOF
darshan-util configure 3.2.0-pre1
darshan-util configure 3.2.0
generated by GNU Autoconf 2.69
Copyright (C) 2012 Free Software Foundation, Inc.
......@@ -1770,7 +1770,7 @@ cat >config.log <<_ACEOF
This file contains any messages produced by compilers while
running configure, to aid debugging if configure makes a mistake.
It was created by darshan-util $as_me 3.2.0-pre1, which was
It was created by darshan-util $as_me 3.2.0, which was
generated by GNU Autoconf 2.69. Invocation command line was
$ $0 $@
......@@ -4117,7 +4117,7 @@ fi
done
DARSHAN_UTIL_VERSION="3.2.0-pre1"
DARSHAN_UTIL_VERSION="3.2.0"
......@@ -4633,7 +4633,7 @@ cat >>$CONFIG_STATUS <<\_ACEOF || ac_write_fail=1
# report actual input values of CONFIG_FILES etc. instead of their
# values after options handling.
ac_log="
This file was extended by darshan-util $as_me 3.2.0-pre1, which was
This file was extended by darshan-util $as_me 3.2.0, which was
generated by GNU Autoconf 2.69. Invocation command line was
CONFIG_FILES = $CONFIG_FILES
......@@ -4695,7 +4695,7 @@ _ACEOF
cat >>$CONFIG_STATUS <<_ACEOF || ac_write_fail=1
ac_cs_config="`$as_echo "$ac_configure_args" | sed 's/^ //; s/[\\""\`\$]/\\\\&/g'`"
ac_cs_version="\\
darshan-util config.status 3.2.0-pre1
darshan-util config.status 3.2.0
configured by $0, generated by GNU Autoconf 2.69,
with options \\"\$ac_cs_config\\"
......
......@@ -5,7 +5,7 @@ dnl Process this file with autoconf to produce a configure script.
dnl You may need to use autoheader as well if changing any DEFINEs
dnl sanity checks, output header, location of scripts used here
AC_INIT([darshan-util], [3.2.0-pre1])
AC_INIT([darshan-util], [3.2.0])
AC_CONFIG_SRCDIR([darshan-logutils.h])
AC_CONFIG_AUX_DIR(../maint/config)
AC_CONFIG_HEADER(darshan-util-config.h)
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment