more samplers to subdirs and per-dir man pages

configure.ac

@@ -1051,6 +1051,9 @@ ldms/src/sampler/app_sampler/Makefile
 ldms/src/sampler/slingshot_metrics/Makefile
 ldms/src/sampler/slingshot_info/Makefile
 ldms/src/sampler/json/Makefile
+ldms/src/sampler/hweventpapi/Makefile \
+ldms/src/sampler/rapl/Makefile \
+ldms/src/sampler/tsampler/Makefile \
 ldms/src/contrib/sampler/Makefile
 ldms/src/contrib/sampler/daos/Makefile
 ldms/src/contrib/sampler/daos/test/Makefile

ldms/man/Makefile.am

@@ -25,13 +25,9 @@ ldms_quickstart.man \
 ldms_sampler_base.man \
 ldmsd_failover.man \
 ldmsd_setgroup.man \
-Plugin_cray_system_sampler_variants.man \
-Plugin_cray_dvs_sampler.man \
 Plugin_jobid.man \
 Plugin_store_csv.man \
 Plugin_store_sos.man \
-Plugin_lustre2_client.man \
-Plugin_shm_sampler.man \
 Plugin_store_papi.man \
 Plugin_store_app.man \
 ldmsd_decomposition.man \

ldms/src/sampler/Makefile.am

@@ -66,29 +66,9 @@ pkglib_LTLIBRARIES += libjobid.la
 endif
 
 if ENABLE_TSAMPLER
-libtsampler_la_SOURCES = tsampler.c tsampler.h
-libtsampler_la_LIBADD = $(COMMON_LIBADD) \
-			$(top_builddir)/lib/src/ovis_event/libovis_event.la -lpthread
-pkglib_LTLIBRARIES += libtsampler.la
-
-libtimer_base_la_SOURCES = timer_base.c timer_base.h
-libtimer_base_la_LIBADD = $(COMMON_LIBADD) libtsampler.la $(JOBID_LIBFLAGS)
-pkglib_LTLIBRARIES += libtimer_base.la
-
-libhfclock_la_SOURCES = hfclock.c
-libhfclock_la_LIBADD = $(COMMON_LIBADD) libtimer_base.la
-pkglib_LTLIBRARIES += libhfclock.la
-
-if ENABLE_CRAY_POWER_SAMPLER
-libcray_power_sampler_la_SOURCES = cray_power_sampler.c
-libcray_power_sampler_la_CFLAGS = $(AM_CFLAGS)
-libcray_power_sampler_la_LIBADD = $(COMMON_LIBADD) \
-			     libtimer_base.la
-pkglib_LTLIBRARIES += libcray_power_sampler.la
+SUBDIRS += tsampler
 endif
 
-endif #ENABLE_TSAMPLER
-
 if ENABLE_KGNILND
 SUBDIRS += kgnilnd
 endif
@@ -203,21 +183,13 @@ endif
 
 if HAVE_LIBPAPI
 SUBDIRS += papi
+
 if HAVE_LIBPFM
 SUBDIRS += syspapi
-
-libhweventpapi_la_SOURCES = hweventpapi.c
-libhweventpapi_la_CFLAGS = $(AM_CFLAGS)
-libhweventpapi_la_LDFLAGS = $(AM_LDFLAGS)
-libhweventpapi_la_LIBADD = $(COMMON_LIBADD) $(JOBID_LIBFLAGS) $(LTLIBPAPI) $(LTLIBPFM) -lm
-pkglib_LTLIBRARIES += libhweventpapi.la
-
-librapl_la_SOURCES = rapl.c
-librapl_la_CFLAGS = $(AM_CFLAGS)
-librapl_la_LDFLAGS = $(AM_LDFLAGS) $(PAPI_LDFLAGS)
-librapl_la_LIBADD = $(COMMON_LIBADD) $(LTLIBPAPI) $(LTLIBPFM) -lm
-pkglib_LTLIBRARIES += librapl.la
+SUBDIRS += rapl
+SUBDIRS += hweventpapi
 endif
+
 endif
 
 if ENABLE_PROCDISKSTATS

ldms/src/sampler/cray_system_sampler/Makefile.am

@@ -1,5 +1,6 @@
 lib_LTLIBRARIES =
 pkglib_LTLIBRARIES =
+dist_man7_MANS=
 
 AM_CPPFLAGS = @OVIS_INCLUDE_ABS@
 AM_LDFLAGS = @OVIS_LIB_ABS@
@@ -15,6 +16,7 @@ if ENABLE_CRAY_SYSTEM_SAMPLER
 libcray_dvs_sampler_la_SOURCES = dvs_sampler.c
 libcray_dvs_sampler_la_LIBADD = $(COMMON_LIBADD)
 pkglib_LTLIBRARIES += libcray_dvs_sampler.la
+dist_man7_MANS += Plugin_cray_dvs_sampler.man
 
 # then build cray_system_sampler
 
@@ -64,6 +66,7 @@ endif
 libcray_gemini_r_sampler_la_LIBADD = $(CRAY_LIBADD_) \
 	./librtr_util.la
 pkglib_LTLIBRARIES += libcray_gemini_r_sampler.la
+dist_man7_MANS += Plugin_cray_system_sampler_variants.man
 endif
 
 if ENABLE_ARIES_GPCDR
@@ -83,6 +86,7 @@ libcray_aries_r_sampler_la_LDFLAGS = $(CRAY_LDFLAGS_)
 endif
 libcray_aries_r_sampler_la_LIBADD = $(CRAY_LIBADD_)
 pkglib_LTLIBRARIES += libcray_aries_r_sampler.la
+dist_man7_MANS += Plugin_cray_system_sampler_variants.man
 endif
 
 endif

ldms/src/sampler/hweventpapi/Makefile.am

@@ -0,0 +1,22 @@
+
+AM_CPPFLAGS = @OVIS_INCLUDE_ABS@
+AM_LDFLAGS = @OVIS_LIB_ABS@
+COMMON_LIBADD = $(top_builddir)/ldms/src/sampler/libsampler_base.la \
+		$(top_builddir)/ldms/src/core/libldms.la \
+		@LDFLAGS_GETTIME@ \
+		$(top_builddir)/lib/src/ovis_util/libovis_util.la \
+		$(top_builddir)/lib/src/coll/libcoll.la
+
+#	$(top_builddir)/lib/src/ovis_json/libovis_json.la \
+#	$(top_builddir)/lib/src/ovis_log/libovis_log.la \
+#	-lm -lpthread
+
+
+
+libhweventpapi_la_SOURCES = hweventpapi.c
+libhweventpapi_la_CFLAGS = $(AM_CFLAGS)
+libhweventpapi_la_LDFLAGS = $(AM_LDFLAGS)
+libhweventpapi_la_LIBADD = $(COMMON_LIBADD) $(JOBID_LIBFLAGS) $(LTLIBPAPI) $(LTLIBPFM) -lm
+pkglib_LTLIBRARIES = libhweventpapi.la
+
+dist_man7_MANS = Plugin_hweventpapi.man

ldms/src/sampler/hweventpapi/Plugin_hweventpapi.man

@@ -0,0 +1,71 @@
+.\" Manpage for Plugin_hweventpapi
+.\" Contact [email protected] to correct errors or typos.
+.TH man 7 "18 Feb 2018" "v4" "LDMS Plugin hweventpapi man page"
+
+.SH NAME
+Plugin_hweventpapi - man page for the LDMS hweventpapi plugin
+
+.SH SYNOPSIS
+Within ldmsd_controller or a configuration file:
+.br
+config name=hweventpapi [ <attr>=<value> ]
+
+.SH DESCRIPTION
+With LDMS (Lightweight Distributed Metric Service), plugins for the ldmsd (ldms daemon) are configured via ldmsd_controller
+or a configuration file. The hweventpapi plugin provides energy sampling using RAPL via the PAPI interface for sandybridge.
+
+WARNING: This sampler is unsupported.
+
+.SH CONFIGURATION ATTRIBUTE SYNTAX
+The hweventpapi plugin uses the sampler_base base class. This man page covers only the configuration attributes, or those with default values, specific to the this plugin; see ldms_sampler_base.man for the attributes of the base class.
+
+
+.TP
+.BR config
+name=<plugin_name> [schema=<sname>]
+.br
+configuration line
+.RS
+.TP
+name=<plugin_name>
+.br
+This MUST be hweventpapi.
+.TP
+schema=<schema>
+.br
+Optional schema name. It is intended that the same sampler on different nodes with different metrics have a
+different schema. If not specified, will default to `hweventpapi`.
+.TP
+metafile=<PATH>
+.br
+The metafile defines what to collect with undocumented "attribute=value" syntax.
+The metafile is watched for changes and automatically reloaded.
+.RE
+
+.SH BUGS
+This man page is incomplete.
+
+.SH NOTES
+.PP
+.IP \[bu]
+This sampler is unsupported.
+
+.SH EXAMPLES
+.PP
+Within ldmsd_controller or a configuration file:
+.nf
+load name=jobinfo
+config name=jobinfo producer=${HOSTNAME} instance=${HOSTNAME}/jobinfo component_id=${COMPONENT_ID} uid=0 gid=0 perm=0700
+load name=hweventpapi
+config name=hweventpapi producer=${HOSTNAME} instance=${HOSTNAME}/hweventpapi job_set=${HOSTNAME}/jobinfo component_id=${COMPONENT_ID} metafile=/tmp/papi.conf uid=0 gid=0 perm=0700
+start name=hweventpapi interval=1000000 offset=0
+.fi
+
+.PP
+Within the metafile configuration:
+.nf
+this needs to be filled in.
+.fi
+
+.SH SEE ALSO
+ldmsd(8), ldms_quickstart(7), ldmsd_controller(8), ldms_sampler_base(7)

ldms/src/sampler/lustre/Makefile.am

@@ -1,4 +1,5 @@
 pkglib_LTLIBRARIES =
+dist_man7_MANS =
 
 AM_CPPFLAGS = @OVIS_INCLUDE_ABS@
 AM_LDFLAGS = @OVIS_LIB_ABS@
@@ -34,3 +35,4 @@ pkglib_LTLIBRARIES += liblustre2_oss.la
 liblustre2_client_la_SOURCES = lustre2_client.c
 liblustre2_client_la_LIBADD = $(COMMON_LIBADD)
 pkglib_LTLIBRARIES += liblustre2_client.la
+dist_man7_MANS += Plugin_lustre2_client.man

ldms/man/Plugin_lustre2_client.man → ldms/src/sampler/lustre/Plugin_lustre2_client.man

@@ -61,8 +61,8 @@ to include the uid part. For example, 'lustre-ffff8803245d4000' is the
 actual file in /proc/fs/lustre/llite/, but you can just say llites=lustre to
 include this component into the set.
 .PP
-osc_path, mdc_path, llite_path are optional full path names of stats files 
-if not in default location. The default locations are: 
+osc_path, mdc_path, llite_path are optional full path names of stats files
+if not in default location. The default locations are:
 /sys/kernel/debug/lustre/{osc, mdc, llite}, and /proc/fs/lustre/{osc, mdc, llite} depends on the Lustre version.
 Be aware that /sys/kernel/debug is only readable by privileged users.
 

ldms/man/Plugin_papi.man → ldms/src/sampler/papi/Plugin_papi.man

@@ -9,7 +9,7 @@ Plugin_papi - man page for the LDMS papi sampler plugin.
 
 Within ldmsctl
 .br
-ldmsctl> config name=spapi [ <attr>=<value> ] 
+ldmsctl> config name=spapi [ <attr>=<value> ]
 
 .SH DESCRIPTION
 With LDMS (Lightweight Distributed Metric Service), plugins for the ldmsd (ldms daemon) are configured via ldmsctl. The papi sampler plugin runs on the nodes and provides data about the the occurrence of micro-architectural events using papi library by accessing hardware performance counters.
@@ -37,7 +37,7 @@ The producer string value.
 instance=<set_name>
 .br
 The name of the metric set
-.TP	
+.TP
 schema=<schema>
 .br
 Optional schema name. It is intended that the same sampler on different nodes with different metrics have a different schema.
@@ -90,10 +90,10 @@ ldmsctl> load name=spapi
 .br
 ldmsctl> config name=spapi producer=$PRODUCER_NAME instance=$INSTANCE_NAME pid=$PID events=PAPI_TOT_INS,PAPI_TOT_CYC,PAPI_BR_INS,PAPI_BR_MSP
 .br
-ldmsctl> start name=spapi interval=$INTERVAL_VALUE 
+ldmsctl> start name=spapi interval=$INTERVAL_VALUE
 .br
-ldmsctl> quit 
-		
+ldmsctl> quit
+
 
 
 

ldms/src/sampler/rapl/Makefile.am

@@ -0,0 +1,20 @@
+
+AM_CPPFLAGS = @OVIS_INCLUDE_ABS@
+AM_LDFLAGS = @OVIS_LIB_ABS@
+COMMON_LIBADD = $(top_builddir)/ldms/src/sampler/libsampler_base.la \
+		$(top_builddir)/ldms/src/core/libldms.la \
+		@LDFLAGS_GETTIME@ \
+		$(top_builddir)/lib/src/ovis_util/libovis_util.la \
+		$(top_builddir)/lib/src/coll/libcoll.la
+
+#	$(top_builddir)/lib/src/ovis_json/libovis_json.la \
+#	$(top_builddir)/lib/src/ovis_log/libovis_log.la \
+#	-lm -lpthread
+
+
+librapl_la_SOURCES = rapl.c
+librapl_la_CFLAGS = $(AM_CFLAGS)
+librapl_la_LDFLAGS = $(AM_LDFLAGS) $(PAPI_LDFLAGS)
+librapl_la_LIBADD = $(COMMON_LIBADD) $(LTLIBPAPI) $(LTLIBPFM) -lm
+pkglib_LTLIBRARIES = librapl.la
+dist_man7_MANS = Plugin_rapl.man

ldms/src/sampler/shm/Makefile.am

@@ -19,6 +19,7 @@ LIBADD = $(COMMON_LIBADD)
 libshm_sampler_la_SOURCES = shm_sampler.c
 libshm_sampler_la_LIBADD = $(LIBADD) $(JOBID_LIBFLAGS) shm_util/liblshm.la -lm -lrt -lpthread
 pkglib_LTLIBRARIES += libshm_sampler.la
+dist_man7_MANS = Plugin_shm_sampler.man
 
 EXTRA_DIST = \
 	outline \

ldms/man/Plugin_shm_sampler.man → ldms/src/sampler/shm/Plugin_shm_sampler.man

@@ -6,10 +6,10 @@
 
 .Sh Name                 \" Section Header - required - don't modify
 .Nm shm_sampler
-.Nd 
-This is a sampler plug-in module within the the LDMS that can read from a dynamic number of shm files. 
+.Nd
+This is a sampler plug-in module within the the LDMS that can read from a dynamic number of shm files.
 
-.Sh SYNOPSIS 
+.Sh SYNOPSIS
 Within ldmsd_controller or a configuration file:
 .br
 load name=shm_sampler
@@ -19,44 +19,44 @@ config name=shm_sampler [ <attr>=<value> ]
 
 .Sh DESCRIPTION          \" Section Header - required - don't modify
 .Nm
-is a sampler plug-in module within the the LDMS. This sampler can read from a dynamic number of shm files. 
-These files are tracked by a central index file in shared memory. 
+is a sampler plug-in module within the the LDMS. This sampler can read from a dynamic number of shm files.
+These files are tracked by a central index file in shared memory.
 The main usage of this sampler is to stream application performance data.
 
 .Pp                      \" Inserts a space
 Configuration options:
 .br
-producer=<name> instance=<name> [shm_index=<name>][shm_boxmax=<int>][shm_array_max=<int>][shm_metric_max=<int>] 
-[shm_set_timeout=<int>][component_id=<int>] [schema=<name>] [job_set=<name> job_id=<name> app_id=<name> 
+producer=<name> instance=<name> [shm_index=<name>][shm_boxmax=<int>][shm_array_max=<int>][shm_metric_max=<int>]
+[shm_set_timeout=<int>][component_id=<int>] [schema=<name>] [job_set=<name> job_id=<name> app_id=<name>
 job_start=<name> job_end=<name>]
 .Bl -tag -width -indent  \" Begins a tagged list
 .It producer               \" Each item preceded by .It macro
  A unique name for the host providing the data
 .It instance
 A unique name for the metric set
-.It shm_index    
+.It shm_index
 A unique name for the shared memory index file
-.It    shm_boxmax   
+.It    shm_boxmax
 Maximum number of entries in the shared memory index file
-.It    shm_array_max   
+.It    shm_array_max
 Maximum number of elements in array metrics
-.It    shm_metric_max  
+.It    shm_metric_max
 Maximum number of metrics
-.It    shm_set_timeout 
+.It    shm_set_timeout
 No read/write timeout in seconds
-.It    component_id 
+.It    component_id
 A unique number for the component being monitored, Defaults to zero.
-.It    schema       
+.It    schema
 The name of the metric set schema, Defaults to the sampler name
-.It    job_set      
+.It    job_set
 The instance name of the set containing the job data, default is 'job_info'
-.It    job_id       
+.It    job_id
 The name of the metric containing the Job Id, default is 'job_id'
-.It    app_id       
+.It    app_id
 The name of the metric containing the Application Id, default is 'app_id'
-.It    job_start    
+.It    job_start
 The name of the metric containing the Job start time, default is 'job_start'
-.It    job_end      
+.It    job_end
 The name of the metric containing the Job end time, default is 'job_end'
 .El \" Ends the list
 

ldms/src/sampler/tsampler/Makefile.am

@@ -0,0 +1,31 @@
+pkglib_LTLIBRARIES =
+
+AM_CPPFLAGS = @OVIS_INCLUDE_ABS@
+AM_LDFLAGS = @OVIS_LIB_ABS@
+COMMON_LIBADD = $(top_builddir)/ldms/src/sampler/libsampler_base.la \
+		$(top_builddir)/ldms/src/core/libldms.la \
+		@LDFLAGS_GETTIME@ \
+		$(top_builddir)/lib/src/ovis_util/libovis_util.la \
+		$(top_builddir)/lib/src/coll/libcoll.la
+
+
+libtsampler_la_SOURCES = tsampler.c tsampler.h
+libtsampler_la_LIBADD = $(COMMON_LIBADD) \
+                        $(top_builddir)/lib/src/ovis_event/libovis_event.la -lpthread
+pkglib_LTLIBRARIES += libtsampler.la
+
+libtimer_base_la_SOURCES = timer_base.c timer_base.h
+libtimer_base_la_LIBADD = $(COMMON_LIBADD) libtsampler.la $(JOBID_LIBFLAGS)
+pkglib_LTLIBRARIES += libtimer_base.la
+
+libhfclock_la_SOURCES = hfclock.c
+libhfclock_la_LIBADD = $(COMMON_LIBADD) libtimer_base.la
+pkglib_LTLIBRARIES += libhfclock.la
+
+if ENABLE_CRAY_POWER_SAMPLER
+libcray_power_sampler_la_SOURCES = cray_power_sampler.c
+libcray_power_sampler_la_CFLAGS = $(AM_CFLAGS)
+libcray_power_sampler_la_LIBADD = $(COMMON_LIBADD) \
+                             libtimer_base.la
+pkglib_LTLIBRARIES += libcray_power_sampler.la
+endif