Add get_pmu_event_info()

Author: jbboehr

src/functions.c

@@ -45,7 +45,42 @@ static PHP_FUNCTION(perfidious_get_pmu_info)
         Z_PARAM_LONG(pmu)
     ZEND_PARSE_PARAMETERS_END();
 
-    if (SUCCESS != perfidious_get_pmu_info(pmu, return_value, false)) {
+    if (UNEXPECTED(SUCCESS != perfidious_get_pmu_info(pmu, return_value, false))) {
+        RETURN_NULL();
+    }
+}
+
+ZEND_BEGIN_ARG_WITH_RETURN_OBJ_INFO_EX(perfidious_get_pmu_event_info_arginfo, false, 2, Perfidious\\PmuEventInfo, false)
+    ZEND_ARG_TYPE_INFO(false, pmu, IS_LONG, false)
+    ZEND_ARG_TYPE_INFO(false, idx, IS_LONG, false)
+ZEND_END_ARG_INFO()
+
+ZEND_COLD
+static PHP_FUNCTION(perfidious_get_pmu_event_info)
+{
+    zend_long pmu;
+    zend_long idx;
+    pfm_pmu_info_t pmu_info = {0};
+    pmu_info.size = sizeof(pmu_info);
+
+    ZEND_PARSE_PARAMETERS_START(2, 2)
+        Z_PARAM_LONG(pmu)
+        Z_PARAM_LONG(idx)
+    ZEND_PARSE_PARAMETERS_END();
+
+    pfm_err_t pfm_err = pfm_get_pmu_info(pmu, &pmu_info);
+    if (PFM_SUCCESS != pfm_err) {
+        zend_throw_exception_ex(
+            perfidious_pmu_not_found_exception_ce,
+            pfm_err,
+            "cannot get pmu info for %lu: %s",
+            pmu,
+            pfm_strerror(pfm_err)
+        );
+        return;
+    }
+
+    if (UNEXPECTED(SUCCESS != perfidious_get_pmu_event_info(&pmu_info, (int) idx, return_value))) {
         RETURN_NULL();
     }
 }
@@ -268,6 +303,7 @@ static ZEND_FUNCTION(perfidious_debug_uint64_overflow)
 PERFIDIOUS_LOCAL
 const zend_function_entry perfidious_functions[] = {
     ZEND_RAW_FENTRY(PHP_PERFIDIOUS_NAMESPACE "\\get_pmu_info", ZEND_FN(perfidious_get_pmu_info), perfidious_get_pmu_info_arginfo, 0)
+    ZEND_RAW_FENTRY(PHP_PERFIDIOUS_NAMESPACE "\\get_pmu_event_info", ZEND_FN(perfidious_get_pmu_event_info), perfidious_get_pmu_event_info_arginfo, 0)
     ZEND_RAW_FENTRY(PHP_PERFIDIOUS_NAMESPACE "\\global_handle", ZEND_FN(perfidious_global_handle), perfidious_global_handle_arginfo, 0)
     ZEND_RAW_FENTRY(PHP_PERFIDIOUS_NAMESPACE "\\list_pmus", ZEND_FN(perfidious_list_pmus), perfidious_list_pmus_arginfo, 0)
     ZEND_RAW_FENTRY(PHP_PERFIDIOUS_NAMESPACE "\\list_pmu_events", ZEND_FN(perfidious_list_pmu_events), perfidious_list_pmu_events_arginfo, 0)

src/pmu_event_info.c

@@ -28,6 +28,7 @@
 #include "private.h"
 
 PERFIDIOUS_LOCAL zend_string *PERFIDIOUS_INTERNED_EQUIV;
+PERFIDIOUS_LOCAL zend_string *PERFIDIOUS_INTERNED_IDX;
 PERFIDIOUS_PUBLIC zend_class_entry *perfidious_pmu_event_info_ce;
 
 ZEND_COLD
@@ -62,6 +63,9 @@ perfidious_pmu_event_info_ctor(pfm_pmu_info_t *pmu_info, pfm_event_info_t *info,
     ZVAL_LONG(&tmp, (zend_long) info->pmu);
     zend_update_property_ex(Z_OBJCE_P(return_value), Z_OBJ_P(return_value), PERFIDIOUS_INTERNED_PMU, &tmp);
 
+    ZVAL_LONG(&tmp, (zend_long) info->idx);
+    zend_update_property_ex(Z_OBJCE_P(return_value), Z_OBJ_P(return_value), PERFIDIOUS_INTERNED_IDX, &tmp);
+
     ZVAL_BOOL(&tmp, pmu_info->is_present);
     zend_update_property_ex(Z_OBJCE_P(return_value), Z_OBJ_P(return_value), PERFIDIOUS_INTERNED_IS_PRESENT, &tmp);
 
@@ -154,6 +158,19 @@ static zend_always_inline zend_class_entry *register_class_PmuEventInfo(void)
         );
     } while (false);
 
+    do {
+        zval default_value = {0};
+        ZVAL_UNDEF(&default_value);
+        zend_declare_typed_property(
+            class_entry,
+            PERFIDIOUS_INTERNED_IDX,
+            &default_value,
+            ZEND_ACC_PUBLIC | ZEND_ACC_READONLY,
+            NULL,
+            (zend_type) ZEND_TYPE_INIT_MASK(MAY_BE_LONG)
+        );
+    } while (false);
+
     do {
         zval default_value = {0};
         ZVAL_UNDEF(&default_value);
@@ -179,6 +196,7 @@ void perfidious_pmu_event_info_minit(void)
     PERFIDIOUS_INTERNED_DESC = zend_string_init_interned(ZEND_STRL("desc"), 1);
     PERFIDIOUS_INTERNED_EQUIV = zend_string_init_interned(ZEND_STRL("equiv"), 1);
     PERFIDIOUS_INTERNED_PMU = zend_string_init_interned(ZEND_STRL("pmu"), 1);
+    PERFIDIOUS_INTERNED_IDX = zend_string_init_interned(ZEND_STRL("idx"), 1);
     PERFIDIOUS_INTERNED_IS_PRESENT = zend_string_init_interned(ZEND_STRL("is_present"), 1);
 
     perfidious_pmu_event_info_ce = register_class_PmuEventInfo();

tests/get-pmu-event-info.phpt

@@ -0,0 +1,25 @@
+--TEST--
+Perfidious\get_pmu_event_info()
+--EXTENSIONS--
+perfidious
+--FILE--
+<?php
+$idx = Perfidious\list_pmu_events(51)[0]->idx;
+$pmu = Perfidious\get_pmu_event_info(51, $idx);
+var_dump(get_class($pmu));
+try {
+    Perfidious\get_pmu_event_info(0, $idx);
+} catch (\Throwable $e) {
+    var_dump(get_class($e), $e->getMessage());
+}
+try {
+    Perfidious\get_pmu_event_info(51, 12345);
+} catch (\Throwable $e) {
+    var_dump(get_class($e), $e->getMessage());
+}
+--EXPECTF--
+string(%d) "Perfidious\PmuEventInfo"
+string(%d) "Perfidious\PmuNotFoundException"
+string(%d) "cannot get pmu info for %d: not supported"
+string(%d) "Perfidious\PmuEventNotFoundException"
+string(%d) "libpfm: cannot get event info for %d: invalid parameters"

tests/list-pmu-events.phpt

@@ -17,7 +17,7 @@ foreach ($events as $event) {
 bool(true)
 int(%d)
 string(%d) "Perfidious\PmuEventInfo"
-object(Perfidious\PmuEventInfo)#%d (5) {
+object(Perfidious\PmuEventInfo)#%d (%d) {
   ["name"]=>
   string(30) "perf::PERF_COUNT_HW_CPU_CYCLES"
   ["desc"]=>
@@ -26,6 +26,8 @@ object(Perfidious\PmuEventInfo)#%d (5) {
   NULL
   ["pmu"]=>
   int(51)
+  ["idx"]=>
+  int(%d)
   ["is_present"]=>
   bool(true)
 }

tests/overflow/whoops.phpt

@@ -0,0 +1,14 @@
+--TEST--
+overflow (whoops)
+--EXTENSIONS--
+perfidious
+gmp
+--SKIPIF--
+<?php if (!Perfidious\DEBUG) die("skip: must be compiled in debug mode"); ?>
+--INI--
+perfidious.overflow_mode=3
+--FILE--
+<?php
+Perfidious\debug_uint64_overflow(PHP_INT_MAX);
+--EXPECTF--
+%A Uncaught TypeError: Overflow mode out-of-range %A