darshan 1.1.0

data/ext/darshan/darshan.c

@@ -0,0 +1,276 @@
+// This program 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.
+//
+// This program 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 this program.  If not, see <http://www.gnu.org/licenses/>.
+//######################################################################
+// Author:       Matthieu Dorier
+// Institution:  ENS Cachan Brittany
+// Mail:         matthieu.dorier [at] irisa.fr
+// Date:         April 14th, 2013
+//######################################################################
+
+#include <ruby.h>
+#define DARSHAN_CONFIG_H "darshan-util-config.h"
+#include <darshan-logutils.h>
+
+VALUE mDarshan; 	// Darshan module in Ruby
+VALUE cDarshanException;// Darshan::Exception class
+VALUE cDarshanLogFile; 	// Darshan::LogFile class
+VALUE cDarshanFile; 	// Darshan::File class
+
+/* Within: Darshan module
+ * Opens a log file using its name and mode.
+ * Returns an instance of Darshan::LogFile on sucess, nil on failure.
+ */
+static VALUE rb_darshan_open(VALUE self, VALUE name, VALUE mode)
+{
+	const char* c_name = rb_string_value_cstr(&name);
+	const char* c_mode = rb_string_value_cstr(&mode);
+	darshan_fd fd = darshan_log_open(c_name, c_mode);
+	if(fd != NULL) {
+		VALUE res = Data_Wrap_Struct(cDarshanLogFile, NULL ,NULL, fd);
+		// set the name of the file
+		rb_iv_set(res, "@name", rb_str_new2(fd->name));
+
+		// get the job struct
+		struct darshan_job job;
+		darshan_log_getjob(fd,&job);
+		
+		// set the version number
+		rb_iv_set(res,"@version", rb_str_new2(job.version_string));
+		// set the magic number
+		rb_iv_set(res,"@magic_number", LL2NUM(job.magic_nr));
+		// set the uid
+		rb_iv_set(res,"@uid", LL2NUM(job.uid));
+		// set the start time
+		rb_iv_set(res,"@start_time", LL2NUM(job.start_time));
+		// set the end time
+		rb_iv_set(res,"@end_time", LL2NUM(job.end_time));
+		// set the job id
+		rb_iv_set(res,"@job_id", LL2NUM(job.jobid));
+		// set the number of processes
+		rb_iv_set(res,"@size", LL2NUM(job.nprocs));
+		// set the metadata
+		rb_iv_set(res,"@metadata", rb_str_new2(job.metadata));
+
+		// set the executable name
+		char exe[CP_EXE_LEN+2];
+		darshan_log_getexe(fd, exe);
+                rb_iv_set(res,"@exe", rb_str_new2(exe));
+
+		// set the list of mount points
+		int64_t* devs;
+		char** mnt_pts;
+		char** fs_types;
+		int count;
+		int err = darshan_log_getmounts(fd,
+				&devs,&mnt_pts,&fs_types,&count);
+		VALUE dev = ID2SYM(rb_intern("dev"));
+		VALUE mount = ID2SYM(rb_intern("mount"));
+		VALUE type = ID2SYM(rb_intern("type"));
+		VALUE mp = rb_ary_new2(count);
+		int i;
+		for(i=0; i<count; i++) {
+			VALUE hash = rb_hash_new();
+			rb_hash_aset(hash,dev,INT2NUM(devs[i]));
+			rb_hash_aset(hash,mount,rb_str_new2(mnt_pts[i]));
+			rb_hash_aset(hash,type,rb_str_new2(fs_types[i]));
+			rb_ary_store(mp,i,hash);
+			free(mnt_pts[i]);
+			free(fs_types[i]);
+		}
+		free(devs);
+		free(mnt_pts);
+		free(fs_types);
+		rb_iv_set(res,"@mount_points", mp);
+		return res;
+	} else {
+		return Qnil;
+	}
+}
+
+/* Within: Darshan module
+ * Closes a file (instance of Darshan::LogFile)
+ * Returns true on success, false on failure.
+ */
+static VALUE rb_darshan_close(VALUE self, VALUE fd)
+{
+	darshan_fd c_fd = NULL;
+	Data_Get_Struct(fd,struct darshan_fd_s,c_fd);
+	if(c_fd != NULL) {
+		darshan_log_close(c_fd);
+		return Qtrue;
+	} else {
+		return Qfalse;
+	}
+}
+
+/* Within: Darshan::LogFile class
+ * Returns the next Darshan::File entry from the log file,
+ * or nil if there is no more such an entry.
+ */
+static VALUE rb_darshan_next_file(VALUE self)
+{
+	
+	darshan_fd fd = NULL;
+	Data_Get_Struct(self,struct darshan_fd_s, fd);
+	if(fd == NULL) return Qnil;
+	struct darshan_file* file = NULL;
+	VALUE rb_file = Data_Make_Struct(cDarshanFile, 
+			struct darshan_file, 
+			NULL, free, file);
+	Data_Get_Struct(rb_file, struct darshan_file, file);
+	if(file == NULL) return Qnil;
+	// if Darshan starts using the 2nd argument of
+	// log_getfile, we'll have a problem
+	if(darshan_log_getfile(fd, NULL, file) != 1) {
+		return Qnil;
+	}
+	return rb_file;
+}
+
+/* Within: Darshan::File class
+ * Returns the value for a given counter, nil on failure.
+ */
+static VALUE rb_darshan_file_get_counter(VALUE self, VALUE counter)
+{
+	int c = NUM2INT(counter);
+	struct darshan_file* file = NULL;
+	Data_Get_Struct(self, struct darshan_file, file);
+	if(file != NULL) {
+		int64_t cnt = file->counters[c];
+		if(cnt == -1) return Qnil;
+		else return LL2NUM(cnt);
+	} else {
+		return Qnil;
+	}
+}
+
+/* Within: Darshan::File class
+ * Returns the value for a given fconter, nil on failure.
+ */
+static VALUE rb_darshan_file_get_fcounter(VALUE self, VALUE counter)
+{
+	int c = NUM2INT(counter);
+	struct darshan_file* file = NULL;
+	Data_Get_Struct(self, struct darshan_file, file);
+	if(file != NULL) {
+		int64_t cnt = file->fcounters[c];
+		if(cnt == -1) return Qnil;
+		else return LL2NUM(cnt);
+	} else {
+		return Qnil;
+	}
+}
+
+/* Within: Darshan::File class
+ * Returns the hash of the file, or nil on failure.
+ */
+static VALUE rb_darshan_file_get_hash(VALUE self)
+{
+	struct darshan_file* file = NULL;
+	Data_Get_Struct(self, struct darshan_file, file);
+	if(file != NULL) {
+		return LL2NUM(file->hash);
+	} else {
+		return Qnil;
+	}
+}
+
+/* Within: Darshan::File class
+ * Returns the rank that produced the file, or nil on failure.
+ */
+static VALUE rb_darshan_file_get_rank(VALUE self)
+{
+	struct darshan_file* file = NULL;
+	Data_Get_Struct(self, struct darshan_file, file);
+	if(file != NULL) {
+		return LL2NUM(file->rank);
+	} else {
+		return Qnil;
+	}
+}
+
+/* Within: Darshan::File class
+ * Returns true if the file was collectively accessed, false otherwise.
+ */
+static VALUE rb_darshan_file_collective(VALUE self)
+{
+        struct darshan_file* file = NULL;
+        Data_Get_Struct(self, struct darshan_file, file);
+        if(file != NULL) {
+		if(file->rank == -1) return Qtrue;
+		else return Qfalse;
+        } else {
+                return Qfalse;
+        }
+}
+
+/* Within: Darshan::File class
+ * Returns the suffix of the name of the file, nil on failure.
+ */
+static VALUE rb_darshan_file_get_name_suffix(VALUE self)
+{
+	struct darshan_file* file = NULL;
+	Data_Get_Struct(self, struct darshan_file, file);
+	if(file != NULL) {
+		return rb_str_new2(file->name_suffix);
+	} else {
+		return Qnil;
+	}
+}
+
+/* Initialize the Darshan Ruby library
+ */
+void Init_RBDarshan() {
+  	mDarshan = rb_define_module("Darshan");
+	cDarshanLogFile =
+		rb_define_class_under(mDarshan,"LogFile",rb_cObject);
+	cDarshanException = 
+		rb_define_class_under(mDarshan,"Exception",rb_cObject);
+	cDarshanFile =
+		rb_define_class_under(mDarshan,"File",rb_cObject);
+
+	rb_define_module_function(mDarshan,"open",rb_darshan_open,2);
+	rb_define_module_function(mDarshan,"close",rb_darshan_close,1);
+
+	// define all the counters as constants and their names
+	VALUE cnames = rb_ary_new2(CP_NUM_INDICES);
+	int i;
+	for(i=0; i < CP_NUM_INDICES; i++) {
+		rb_ary_store(cnames,i,rb_str_new2(darshan_names[i]));
+		rb_define_const(mDarshan,darshan_names[i],INT2NUM(i));
+	}
+	rb_define_const(mDarshan,"NAMES",cnames);
+
+	VALUE cfnames = rb_ary_new2(CP_F_NUM_INDICES);
+	for(i=0; i < CP_F_NUM_INDICES; i++) {
+		rb_ary_store(cfnames,i,rb_str_new2(darshan_f_names[i]));
+		rb_define_const(mDarshan,darshan_f_names[i],INT2NUM(i));
+	}
+	rb_define_const(mDarshan,"F_NAMES",cfnames);
+
+	rb_define_method(cDarshanLogFile,"next_file",
+			rb_darshan_next_file,0);
+
+	rb_define_method(cDarshanFile,"counter",
+			rb_darshan_file_get_counter,1);
+	rb_define_method(cDarshanFile,"fcounter",
+			rb_darshan_file_get_fcounter,1);
+	rb_define_method(cDarshanFile,"hash",
+			rb_darshan_file_get_hash,0);
+	rb_define_method(cDarshanFile,"rank",
+			rb_darshan_file_get_rank,0);
+	rb_define_method(cDarshanFile,"collective",
+			rb_darshan_file_collective,0);
+	rb_define_method(cDarshanFile,"name_suffix",
+			rb_darshan_file_get_name_suffix,0);
+}

data/ext/darshan/extconf.rb

@@ -0,0 +1,46 @@
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program 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 General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#######################################################################
+# Author:       Matthieu Dorier
+# Institution:  ENS Cachan Brittany
+# Mail:         matthieu.dorier [at] irisa.fr
+# Date:         April 14th, 2013
+#######################################################################
+
+require 'mkmf'
+
+dir_config('darshan')
+
+if(not have_header('darshan-util-config.h'))
+	$stderr << "Error, could not find darshan-util-config.h\n"
+	$stderr << "Please use --with-darshan-dir=...\n"
+	abort "Missing darshan-util-config.h"
+end
+
+if(not have_library('z'))
+	$stderr << "Error, could not locate zlib.\n"
+	abort "Missing zlib"
+end
+
+if(not have_library('bz2'))
+	$stderr << "Error, could not locate libbz2.\n"
+	abort "Missing bz2"
+end
+
+if(not have_library('darshan-util'))
+	$stderr << "Error, could not locate libdarshan-util.\n"
+	$stderr << "Please use --with-darshan-dir=...\n"
+	abort "Missing libdarshan-util.a"
+end
+
+create_makefile("RBDarshan")

data/lib/darshan.rb

@@ -0,0 +1,88 @@
+# This program 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.
+#
+# This program 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 this program.  If not, see <http://www.gnu.org/licenses/>.
+#######################################################################
+# Author: 	Matthieu Dorier
+# Institution: 	ENS Cachan Brittany
+# Mail: 	matthieu.dorier [at] irisa.fr
+# Date: 	April 14th, 2013
+#######################################################################
+require "RBDarshan"
+
+#=====================================================================#
+# Darshan module, contains the functions to open and close a LogFile,
+# as well as all the classes (LogFile, Job and File). Some of these
+# classes are defined through the C code, and are thus not shown here.
+#=====================================================================#
+module Darshan
+
+	#=============================================================#
+	# LogFile class, represents a binary log file (compressed).
+	# Open it by using
+	#	logfile = LogFile.open("filename")
+	#	...
+	#	logfile.close
+	# or
+	#	LogFile.open("filename") do | logfile |
+	#		...
+	#	end
+	#=============================================================#
+	class LogFile
+
+		attr_reader :name
+		attr_reader :version
+		attr_reader :exe
+		attr_reader :magic_number
+		attr_reader :uid
+		attr_reader :start_time
+		attr_reader :end_time
+		attr_reader :job_id
+		attr_reader :size
+		attr_reader :metadata
+		attr_reader :mount_points
+
+		#=====================================================#
+		# Opens a logfile, calls the given block if present.
+		#=====================================================#
+		def self.open(filename,mode="r")
+			lf = Darshan.open(filename,mode)
+			if block_given? and lf != nil
+				yield lf
+				lf.close
+				lf = nil
+			end
+			return lf
+		end
+
+		#======================================================#
+		# Close the file.
+		#======================================================#
+		def close
+			Darshan.close(self)
+		end
+
+		#======================================================#
+		# Iterates through all the file entries described in
+		# the log file.
+		#======================================================#
+		def each_file
+			if not block_given?
+				return nil
+			end
+			file = nil
+			while((file = next_file()) != nil)
+				yield file
+			end
+			return nil
+		end
+	end
+end

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification 
+name: darshan
+version: !ruby/object:Gem::Version 
+  version: 1.1.0
+platform: ruby
+authors: 
+- Matthieu Dorier
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2013-09-08 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+description: Ruby binding to ANL's Darshan library for HPC I/O tracing and analysis
+email: matthieu.dorier@irisa.fr
+executables: []
+
+extensions: 
+- ext/darshan/extconf.rb
+extra_rdoc_files: []
+
+files: 
+- lib/darshan.rb
+- ext/darshan/darshan.c
+- ext/darshan/extconf.rb
+has_rdoc: true
+homepage: http://darshan-ruby.gforge.inria.fr/
+licenses: 
+- LGPL
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+- ext
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: nowarning
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Ruby binding to Darshan
+test_files: []
+