valgrind 0.0.0 → 0.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f4c8be38a432e5ceff7bebd2c75c2d1507685b99b0e8ac7427048aef0c4b2beb
-  data.tar.gz: dae5536d6035f67546136f12ffe1fc52d602bdffc8dd5eeba120fec2313c4cd7
+  metadata.gz: af95f1fc8df6aa9b4e3280a38d634e4c6556870fc11106e718c2dff5aa69973e
+  data.tar.gz: 96251e4b25209fa8f083c2b271a251bf495a1b8e4b137bb47da1f1601d39b0fc
 SHA512:
-  metadata.gz: 199c7cc4d4da63d7ee6491e14f8bf95f41489d49c591e1caa7fe436850b470e680038e97f363fb6c29689d5c45699a37cffb4fe970135369f05a8b3953474f9d
-  data.tar.gz: 8cf8d948c812075b068479e25737a0d43999831f2dea87a018d6d62fe8c1049d96bb27076f88173ed91d4bd4ae1939669d768402ee9e8ce8e5c215c14014d909
+  metadata.gz: 25f9757ee618417b4b6104bb2dc1ec878e79fe8d20b4559efae3aa9fe08f249eca122b2aa47088eca93731faf2d718cee3a92c350f461c18964eccdd48b8e368
+  data.tar.gz: f9af638c310880355594d336c4f3735606ac5eca860c2dd5afeaec40bd0ca14d02f31a5611b5228b31e250af048a209ac88e78c33428a961ced039a89b4f6a85

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Max Bernstein
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,46 @@
+# `valgrind`
+
+Control callgrind instrumentation from Ruby. A port of
+[tekknolagi/valgrind](https://github.com/tekknolagi/valgrind) (Python).
+
+## Usage
+
+Run `gem install valgrind`.
+
+In `benchmark.rb` put:
+
+```ruby
+require "valgrind"
+
+some_startup_code
+Valgrind.callgrind_start_instrumentation
+some_expensive_function
+Valgrind.callgrind_stop_instrumentation
+Valgrind.callgrind_dump_stats("myprofile")
+```
+
+Run `valgrind --tool=callgrind --instr-atstart=no ruby benchmark.rb`.
+
+See profile in `myprofile` file. Consider opening with KCachegrind or
+QCachegrind.
+
+## API
+
+All methods are module functions on `Valgrind` and return `nil`. Outside of
+valgrind the underlying client requests are no-ops.
+
+- `Valgrind.callgrind_start_instrumentation`
+- `Valgrind.callgrind_stop_instrumentation`
+- `Valgrind.callgrind_zero_stats`
+- `Valgrind.callgrind_dump_stats(description = nil)`
+
+## Development
+
+```sh
+bundle install
+bundle exec rake        # compile + test
+```
+
+## Authors
+
+Matthias Braun (original C), Max Bernstein

data/ext/valgrind/callgrind.h

@@ -0,0 +1,129 @@
+
+/*
+   ----------------------------------------------------------------
+
+   Notice that the following BSD-style license applies to this one
+   file (callgrind.h) only.  The rest of Valgrind is licensed under the
+   terms of the GNU General Public License, version 2, unless
+   otherwise indicated.  See the COPYING file in the source
+   distribution for details.
+
+   ----------------------------------------------------------------
+
+   This file is part of callgrind, a valgrind tool for cache simulation
+   and call tree tracing.
+
+   Copyright (C) 2003-2017 Josef Weidendorfer.  All rights reserved.
+
+   Redistribution and use in source and binary forms, with or without
+   modification, are permitted provided that the following conditions
+   are met:
+
+   1. Redistributions of source code must retain the above copyright
+      notice, this list of conditions and the following disclaimer.
+
+   2. The origin of this software must not be misrepresented; you must
+      not claim that you wrote the original software.  If you use this
+      software in a product, an acknowledgment in the product
+      documentation would be appreciated but is not required.
+
+   3. Altered source versions must be plainly marked as such, and must
+      not be misrepresented as being the original software.
+
+   4. The name of the author may not be used to endorse or promote
+      products derived from this software without specific prior written
+      permission.
+
+   THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS
+   OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+   WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+   ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
+   DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+   DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
+   GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+   INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
+   WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+   NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+   SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+   ----------------------------------------------------------------
+
+   Notice that the above BSD-style license applies to this one file
+   (callgrind.h) only.  The entire rest of Valgrind is licensed under
+   the terms of the GNU General Public License, version 2.  See the
+   COPYING file in the source distribution for details.
+
+   ----------------------------------------------------------------
+*/
+
+#ifndef __CALLGRIND_H
+#define __CALLGRIND_H
+
+#include "valgrind.h"
+
+/* !! ABIWARNING !! ABIWARNING !! ABIWARNING !! ABIWARNING !!
+   This enum comprises an ABI exported by Valgrind to programs
+   which use client requests.  DO NOT CHANGE THE ORDER OF THESE
+   ENTRIES, NOR DELETE ANY -- add new ones at the end.
+
+   The identification ('C','T') for Callgrind has historical
+   reasons: it was called "Calltree" before. Besides, ('C','G') would
+   clash with cachegrind.
+ */
+
+typedef
+   enum {
+      VG_USERREQ__DUMP_STATS = VG_USERREQ_TOOL_BASE('C','T'),
+      VG_USERREQ__ZERO_STATS,
+      VG_USERREQ__TOGGLE_COLLECT,
+      VG_USERREQ__DUMP_STATS_AT,
+      VG_USERREQ__START_INSTRUMENTATION,
+      VG_USERREQ__STOP_INSTRUMENTATION
+   } Vg_CallgrindClientRequest;
+
+/* Dump current state of cost centers, and zero them afterwards */
+#define CALLGRIND_DUMP_STATS                                    \
+  VALGRIND_DO_CLIENT_REQUEST_STMT(VG_USERREQ__DUMP_STATS,       \
+                                  0, 0, 0, 0, 0)
+
+/* Dump current state of cost centers, and zero them afterwards.
+   The argument is appended to a string stating the reason which triggered
+   the dump. This string is written as a description field into the
+   profile data dump. */
+#define CALLGRIND_DUMP_STATS_AT(pos_str)                        \
+  VALGRIND_DO_CLIENT_REQUEST_STMT(VG_USERREQ__DUMP_STATS_AT,    \
+                                  pos_str, 0, 0, 0, 0)
+
+/* Zero cost centers */
+#define CALLGRIND_ZERO_STATS                                    \
+  VALGRIND_DO_CLIENT_REQUEST_STMT(VG_USERREQ__ZERO_STATS,       \
+                                  0, 0, 0, 0, 0)
+
+/* Toggles collection state.
+   The collection state specifies whether the happening of events
+   should be noted or if they are to be ignored. Events are noted
+   by increment of counters in a cost center */
+#define CALLGRIND_TOGGLE_COLLECT                                \
+  VALGRIND_DO_CLIENT_REQUEST_STMT(VG_USERREQ__TOGGLE_COLLECT,   \
+                                  0, 0, 0, 0, 0)
+
+/* Start full callgrind instrumentation if not already switched on.
+   When cache simulation is done, it will flush the simulated cache;
+   this will lead to an artificial cache warmup phase afterwards with
+   cache misses which would not have happened in reality. */
+#define CALLGRIND_START_INSTRUMENTATION                              \
+  VALGRIND_DO_CLIENT_REQUEST_STMT(VG_USERREQ__START_INSTRUMENTATION, \
+                                  0, 0, 0, 0, 0)
+
+/* Stop full callgrind instrumentation if not already switched off.
+   This flushes Valgrinds translation cache, and does no additional
+   instrumentation afterwards, which effectivly will run at the same
+   speed as the "none" tool (ie. at minimal slowdown).
+   Use this to bypass Callgrind aggregation for uninteresting code parts.
+   To start Callgrind in this mode to ignore the setup phase, use
+   the option "--instr-atstart=no". */
+#define CALLGRIND_STOP_INSTRUMENTATION                               \
+  VALGRIND_DO_CLIENT_REQUEST_STMT(VG_USERREQ__STOP_INSTRUMENTATION,  \
+                                  0, 0, 0, 0, 0)
+
+#endif /* __CALLGRIND_H */

data/ext/valgrind/extconf.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require "mkmf"
+
+$INCFLAGS << " -I#{File.expand_path(__dir__)}"
+
+create_makefile("valgrind/valgrind")

data/ext/valgrind/valgrind.c

@@ -0,0 +1,46 @@
+// Copyright (c) Meta Platforms, Inc. and affiliates. (http://www.meta.com)
+// Originally authored by Matthias Braun for Python; ported to Ruby.
+#include <ruby.h>
+
+#include "callgrind.h"
+
+static VALUE callgrind_dump_stats(int argc, VALUE *argv, VALUE self) {
+  VALUE description = Qnil;
+  rb_scan_args(argc, argv, "01", &description);
+
+  if (NIL_P(description)) {
+    CALLGRIND_DUMP_STATS;
+  } else {
+    const char *str = StringValueCStr(description);
+    CALLGRIND_DUMP_STATS_AT(str);
+    (void)str; // No-op on platforms valgrind.h does not support.
+  }
+  return Qnil;
+}
+
+static VALUE callgrind_start_instrumentation(VALUE self) {
+  CALLGRIND_START_INSTRUMENTATION;
+  return Qnil;
+}
+
+static VALUE callgrind_stop_instrumentation(VALUE self) {
+  CALLGRIND_STOP_INSTRUMENTATION;
+  return Qnil;
+}
+
+static VALUE callgrind_zero_stats(VALUE self) {
+  CALLGRIND_ZERO_STATS;
+  return Qnil;
+}
+
+void Init_valgrind(void) {
+  VALUE mValgrind = rb_define_module("Valgrind");
+  rb_define_module_function(mValgrind, "callgrind_dump_stats",
+                            callgrind_dump_stats, -1);
+  rb_define_module_function(mValgrind, "callgrind_start_instrumentation",
+                            callgrind_start_instrumentation, 0);
+  rb_define_module_function(mValgrind, "callgrind_stop_instrumentation",
+                            callgrind_stop_instrumentation, 0);
+  rb_define_module_function(mValgrind, "callgrind_zero_stats",
+                            callgrind_zero_stats, 0);
+}