Skip to contentSkip to conversation

tools/kvm_stat: fix termination behavior when not on a terminal

PATCH In review Claudio Fontana 3 participants 7 messages Aug 7, 2024 – Apr 7, 2025 KVM

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 tools/kvm_stat: fix termination behavior when not on a terminal

For the -l and -L options (logging mode), replace the use of the KeyboardInterrupt exception to gracefully terminate in favor of handling the SIGINT and SIGTERM signals.

This allows the program to be run from scripts and still be signaled to gracefully terminate without an interactive terminal.

Before this change, something like this script:

kvm_stat -p 85896 -d -t -s 1 -c -L kvm_stat_85896.csv & sleep 10
pkill -TERM -P $$

would yield an empty log:
-rw-r--r-- 1 root root 0 Aug 7 16:17 kvm_stat_85896.csv

after this commit:
-rw-r--r-- 1 root root 13466 Aug 7 16:57 kvm_stat_85896.csv

Cc Dario Faggioli <[email protected]>
Cc Fabiano Rosas <[email protected]>
---
 tools/kvm/kvm_stat/kvm_stat     | 64 ++++++++++++++++-----------------
 tools/kvm/kvm_stat/kvm_stat.txt | 12 +++++++
 2 files changed, 44 insertions(+), 32 deletions(-)
tools/kvm/kvm_stat/kvm_stat +32 -32
index 15bf00e79e3f..2cf2da3ed002 100755
@@ -297,8 +297,6 @@ IOCTL_NUMBERS = {
     'RESET':       0x00002403,
 }
 
-signal_received = False
-
 ENCODING = locale.getpreferredencoding(False)
 TRACE_FILTER = re.compile(r'^[^\(]*$')
 
@@ -1598,7 +1596,19 @@ class CSVFormat(object):
 
 def log(stats, opts, frmt, keys):
     """Prints statistics as reiterating key block, multiple value blocks."""
-    global signal_received
+    signal_received = defaultdict(bool)
+
+    def handle_signal(sig, frame):
+        nonlocal signal_received
+        signal_received[sig] = True
+        return
+
+
+    signal.signal(signal.SIGINT, handle_signal)
+    signal.signal(signal.SIGTERM, handle_signal)
+    if opts.log_to_file:
+        signal.signal(signal.SIGHUP, handle_signal)
+
     line = 0
     banner_repeat = 20
     f = None
@@ -1624,39 +1634,31 @@ def log(stats, opts, frmt, keys):
     do_banner(opts)
     banner_printed = True
     while True:
-        try:
-            time.sleep(opts.set_delay)
-            if signal_received:
-                banner_printed = True
-                line = 0
-                f.close()
-                do_banner(opts)
-                signal_received = False
-            if (line % banner_repeat == 0 and not banner_printed and
-                not (opts.log_to_file and isinstance(frmt, CSVFormat))):
-                do_banner(opts)
-                banner_printed = True
-            values = stats.get()
-            if (not opts.skip_zero_records or
-                any(values[k].delta != 0 for k in keys)):
-                do_statline(opts, values)
-                line += 1
-                banner_printed = False
-        except KeyboardInterrupt:
+        time.sleep(opts.set_delay)
+        # Do not use the KeyboardInterrupt exception, because we may be running without a terminal
+        if (signal_received[signal.SIGINT] or signal_received[signal.SIGTERM]):
             break
+        if signal_received[signal.SIGHUP]:
+            banner_printed = True
+            line = 0
+            f.close()
+            do_banner(opts)
+            signal_received[signal.SIGHUP] = False
+        if (line % banner_repeat == 0 and not banner_printed and
+            not (opts.log_to_file and isinstance(frmt, CSVFormat))):
+            do_banner(opts)
+            banner_printed = True
+        values = stats.get()
+        if (not opts.skip_zero_records or
+            any(values[k].delta != 0 for k in keys)):
+            do_statline(opts, values)
+            line += 1
+            banner_printed = False
 
     if opts.log_to_file:
         f.close()
 
 
-def handle_signal(sig, frame):
-    global signal_received
-
-    signal_received = True
-
-    return
-
-
 def is_delay_valid(delay):
     """Verify delay is in valid value range."""
     msg = None
@@ -1869,8 +1871,6 @@ def main():
         sys.exit(0)
 
     if options.log or options.log_to_file:
-        if options.log_to_file:
-            signal.signal(signal.SIGHUP, handle_signal)
         keys = sorted(stats.get().keys())
         if options.csv:
             frmt = CSVFormat(keys)
tools/kvm/kvm_stat/kvm_stat.txt +12 -0
index 3a9f2037bd23..4a99a111a93c 100644
@@ -115,6 +115,18 @@ OPTIONS
 --skip-zero-records::
         omit records with all zeros in logging mode
 
+
+SIGNALS
+-------
+when kvm_stat is running in logging mode (either with -l or with -L),
+it handles the following signals:
+
+SIGHUP - closes and reopens the log file (-L only), then continues.
+
+SIGINT - closes the log file and terminates.
+SIGTERM - closes the log file and terminates.
+
+
 SEE ALSO
 --------
 'perf'(1), 'trace-cmd'(1)
Signature · 1 line
2.26.2
Reviewed-by on v1 1/1
#1 lore raw
Quoted 19 lines · Claudio Fontana

For the -l and -L options (logging mode), replace the use of the KeyboardInterrupt exception to gracefully terminate in favor of handling the SIGINT and SIGTERM signals.

This allows the program to be run from scripts and still be signaled to gracefully terminate without an interactive terminal.

Before this change, something like this script:

kvm_stat -p 85896 -d -t -s 1 -c -L kvm_stat_85896.csv & sleep 10
pkill -TERM -P $$

would yield an empty log:
-rw-r--r-- 1 root root 0 Aug 7 16:17 kvm_stat_85896.csv

after this commit:
-rw-r--r-- 1 root root 13466 Aug 7 16:57 kvm_stat_85896.csv

Quoted 7 lines
Cc Dario Faggioli <[email protected]>
Cc Fabiano Rosas <[email protected]>
---
 tools/kvm/kvm_stat/kvm_stat     | 64 ++++++++++++++++-----------------
 tools/kvm/kvm_stat/kvm_stat.txt | 12 +++++++
 2 files changed, 44 insertions(+), 32 deletions(-)
#2 lore raw
In reply to Claudio Fontana

Any reason not to commit this patch? It has got a Reviewed-by: tag from Stefan more than 2 months ago...

Quoted 152 lines · Claudio Fontana

For the -l and -L options (logging mode), replace the use of the KeyboardInterrupt exception to gracefully terminate in favor of handling the SIGINT and SIGTERM signals.

This allows the program to be run from scripts and still be signaled to gracefully terminate without an interactive terminal.

Before this change, something like this script:

kvm_stat -p 85896 -d -t -s 1 -c -L kvm_stat_85896.csv & sleep 10
pkill -TERM -P $$

would yield an empty log:
-rw-r--r-- 1 root root 0 Aug 7 16:17 kvm_stat_85896.csv

after this commit:
-rw-r--r-- 1 root root 13466 Aug 7 16:57 kvm_stat_85896.csv

Cc Dario Faggioli <[email protected]>
Cc Fabiano Rosas <[email protected]>
---
  tools/kvm/kvm_stat/kvm_stat     | 64 ++++++++++++++++-----------------
  tools/kvm/kvm_stat/kvm_stat.txt | 12 +++++++
  2 files changed, 44 insertions(+), 32 deletions(-)
tools/kvm/kvm_stat/kvm_stat +32 -32
index 15bf00e79e3f..2cf2da3ed002 100755
@@ -297,8 +297,6 @@ IOCTL_NUMBERS = {
      'RESET':       0x00002403,
  }
 
-signal_received = False
-
  ENCODING = locale.getpreferredencoding(False)
  TRACE_FILTER = re.compile(r'^[^\(]*$')
 
@@ -1598,7 +1596,19 @@ class CSVFormat(object):
 
  def log(stats, opts, frmt, keys):
      """Prints statistics as reiterating key block, multiple value blocks."""
-    global signal_received
+    signal_received = defaultdict(bool)
+
+    def handle_signal(sig, frame):
+        nonlocal signal_received
+        signal_received[sig] = True
+        return
+
+
+    signal.signal(signal.SIGINT, handle_signal)
+    signal.signal(signal.SIGTERM, handle_signal)
+    if opts.log_to_file:
+        signal.signal(signal.SIGHUP, handle_signal)
+
      line = 0
      banner_repeat = 20
      f = None
@@ -1624,39 +1634,31 @@ def log(stats, opts, frmt, keys):
      do_banner(opts)
      banner_printed = True
      while True:
-        try:
-            time.sleep(opts.set_delay)
-            if signal_received:
-                banner_printed = True
-                line = 0
-                f.close()
-                do_banner(opts)
-                signal_received = False
-            if (line % banner_repeat == 0 and not banner_printed and
-                not (opts.log_to_file and isinstance(frmt, CSVFormat))):
-                do_banner(opts)
-                banner_printed = True
-            values = stats.get()
-            if (not opts.skip_zero_records or
-                any(values[k].delta != 0 for k in keys)):
-                do_statline(opts, values)
-                line += 1
-                banner_printed = False
-        except KeyboardInterrupt:
+        time.sleep(opts.set_delay)
+        # Do not use the KeyboardInterrupt exception, because we may be running without a terminal
+        if (signal_received[signal.SIGINT] or signal_received[signal.SIGTERM]):
              break
+        if signal_received[signal.SIGHUP]:
+            banner_printed = True
+            line = 0
+            f.close()
+            do_banner(opts)
+            signal_received[signal.SIGHUP] = False
+        if (line % banner_repeat == 0 and not banner_printed and
+            not (opts.log_to_file and isinstance(frmt, CSVFormat))):
+            do_banner(opts)
+            banner_printed = True
+        values = stats.get()
+        if (not opts.skip_zero_records or
+            any(values[k].delta != 0 for k in keys)):
+            do_statline(opts, values)
+            line += 1
+            banner_printed = False
 
      if opts.log_to_file:
          f.close()
 
 
-def handle_signal(sig, frame):
-    global signal_received
-
-    signal_received = True
-
-    return
-
-
  def is_delay_valid(delay):
      """Verify delay is in valid value range."""
      msg = None
@@ -1869,8 +1871,6 @@ def main():
          sys.exit(0)
 
      if options.log or options.log_to_file:
-        if options.log_to_file:
-            signal.signal(signal.SIGHUP, handle_signal)
          keys = sorted(stats.get().keys())
          if options.csv:
              frmt = CSVFormat(keys)
tools/kvm/kvm_stat/kvm_stat.txt +12 -0
index 3a9f2037bd23..4a99a111a93c 100644
@@ -115,6 +115,18 @@ OPTIONS
  --skip-zero-records::
          omit records with all zeros in logging mode
 
+
+SIGNALS
+-------
+when kvm_stat is running in logging mode (either with -l or with -L),
+it handles the following signals:
+
+SIGHUP - closes and reopens the log file (-L only), then continues.
+
+SIGINT - closes the log file and terminates.
+SIGTERM - closes the log file and terminates.
+
+
  SEE ALSO
  --------
  'perf'(1), 'trace-cmd'(1)
#3 lore raw

Hi, according to MAINTAINERS file:

M:  Paolo Bonzini <[email protected]>
L:  [email protected]
F:  tools/kvm/

Paolo, is kvm_stat something you still care about, or should it be set to unmaintained? In this case I think someone at SUSE could pick it up.

Ciao,

Claudio

Quoted 157 lines · Juergen Gross

Any reason not to commit this patch? It has got a Reviewed-by: tag from Stefan more than 2 months ago...

Quoted 152 lines · Claudio Fontana

For the -l and -L options (logging mode), replace the use of the KeyboardInterrupt exception to gracefully terminate in favor of handling the SIGINT and SIGTERM signals.

This allows the program to be run from scripts and still be signaled to gracefully terminate without an interactive terminal.

Before this change, something like this script:

kvm_stat -p 85896 -d -t -s 1 -c -L kvm_stat_85896.csv & sleep 10
pkill -TERM -P $$

would yield an empty log:
-rw-r--r-- 1 root root 0 Aug 7 16:17 kvm_stat_85896.csv

after this commit:
-rw-r--r-- 1 root root 13466 Aug 7 16:57 kvm_stat_85896.csv

Cc Dario Faggioli <[email protected]>
Cc Fabiano Rosas <[email protected]>
---
  tools/kvm/kvm_stat/kvm_stat     | 64 ++++++++++++++++-----------------
  tools/kvm/kvm_stat/kvm_stat.txt | 12 +++++++
  2 files changed, 44 insertions(+), 32 deletions(-)
tools/kvm/kvm_stat/kvm_stat +32 -32
index 15bf00e79e3f..2cf2da3ed002 100755
@@ -297,8 +297,6 @@ IOCTL_NUMBERS = {
      'RESET':       0x00002403,
  }
 
-signal_received = False
-
  ENCODING = locale.getpreferredencoding(False)
  TRACE_FILTER = re.compile(r'^[^\(]*$')
 
@@ -1598,7 +1596,19 @@ class CSVFormat(object):
 
  def log(stats, opts, frmt, keys):
      """Prints statistics as reiterating key block, multiple value blocks."""
-    global signal_received
+    signal_received = defaultdict(bool)
+
+    def handle_signal(sig, frame):
+        nonlocal signal_received
+        signal_received[sig] = True
+        return
+
+
+    signal.signal(signal.SIGINT, handle_signal)
+    signal.signal(signal.SIGTERM, handle_signal)
+    if opts.log_to_file:
+        signal.signal(signal.SIGHUP, handle_signal)
+
      line = 0
      banner_repeat = 20
      f = None
@@ -1624,39 +1634,31 @@ def log(stats, opts, frmt, keys):
      do_banner(opts)
      banner_printed = True
      while True:
-        try:
-            time.sleep(opts.set_delay)
-            if signal_received:
-                banner_printed = True
-                line = 0
-                f.close()
-                do_banner(opts)
-                signal_received = False
-            if (line % banner_repeat == 0 and not banner_printed and
-                not (opts.log_to_file and isinstance(frmt, CSVFormat))):
-                do_banner(opts)
-                banner_printed = True
-            values = stats.get()
-            if (not opts.skip_zero_records or
-                any(values[k].delta != 0 for k in keys)):
-                do_statline(opts, values)
-                line += 1
-                banner_printed = False
-        except KeyboardInterrupt:
+        time.sleep(opts.set_delay)
+        # Do not use the KeyboardInterrupt exception, because we may be running without a terminal
+        if (signal_received[signal.SIGINT] or signal_received[signal.SIGTERM]):
              break
+        if signal_received[signal.SIGHUP]:
+            banner_printed = True
+            line = 0
+            f.close()
+            do_banner(opts)
+            signal_received[signal.SIGHUP] = False
+        if (line % banner_repeat == 0 and not banner_printed and
+            not (opts.log_to_file and isinstance(frmt, CSVFormat))):
+            do_banner(opts)
+            banner_printed = True
+        values = stats.get()
+        if (not opts.skip_zero_records or
+            any(values[k].delta != 0 for k in keys)):
+            do_statline(opts, values)
+            line += 1
+            banner_printed = False
 
      if opts.log_to_file:
          f.close()
 
 
-def handle_signal(sig, frame):
-    global signal_received
-
-    signal_received = True
-
-    return
-
-
  def is_delay_valid(delay):
      """Verify delay is in valid value range."""
      msg = None
@@ -1869,8 +1871,6 @@ def main():
          sys.exit(0)
 
      if options.log or options.log_to_file:
-        if options.log_to_file:
-            signal.signal(signal.SIGHUP, handle_signal)
          keys = sorted(stats.get().keys())
          if options.csv:
              frmt = CSVFormat(keys)
tools/kvm/kvm_stat/kvm_stat.txt +12 -0
index 3a9f2037bd23..4a99a111a93c 100644
@@ -115,6 +115,18 @@ OPTIONS
  --skip-zero-records::
          omit records with all zeros in logging mode
 
+
+SIGNALS
+-------
+when kvm_stat is running in logging mode (either with -l or with -L),
+it handles the following signals:
+
+SIGHUP - closes and reopens the log file (-L only), then continues.
+
+SIGINT - closes the log file and terminates.
+SIGTERM - closes the log file and terminates.
+
+
  SEE ALSO
  --------
  'perf'(1), 'trace-cmd'(1)
#4 lore raw

Gentle ping,

we currently need to carry this downstream, could you include this fix?

Thanks,

CLaudio

Quoted 173 lines · Claudio Fontana

Hi, according to MAINTAINERS file:

M:  Paolo Bonzini <[email protected]>
L:  [email protected]
F:  tools/kvm/

Paolo, is kvm_stat something you still care about, or should it be set to unmaintained? In this case I think someone at SUSE could pick it up.

Ciao,

Claudio

Quoted 157 lines · Juergen Gross

Any reason not to commit this patch? It has got a Reviewed-by: tag from Stefan more than 2 months ago...

Quoted 152 lines · Claudio Fontana

For the -l and -L options (logging mode), replace the use of the KeyboardInterrupt exception to gracefully terminate in favor of handling the SIGINT and SIGTERM signals.

This allows the program to be run from scripts and still be signaled to gracefully terminate without an interactive terminal.

Before this change, something like this script:

kvm_stat -p 85896 -d -t -s 1 -c -L kvm_stat_85896.csv & sleep 10
pkill -TERM -P $$

would yield an empty log:
-rw-r--r-- 1 root root 0 Aug 7 16:17 kvm_stat_85896.csv

after this commit:
-rw-r--r-- 1 root root 13466 Aug 7 16:57 kvm_stat_85896.csv

Cc Dario Faggioli <[email protected]>
Cc Fabiano Rosas <[email protected]>
---
  tools/kvm/kvm_stat/kvm_stat     | 64 ++++++++++++++++-----------------
  tools/kvm/kvm_stat/kvm_stat.txt | 12 +++++++
  2 files changed, 44 insertions(+), 32 deletions(-)
tools/kvm/kvm_stat/kvm_stat +32 -32
index 15bf00e79e3f..2cf2da3ed002 100755
@@ -297,8 +297,6 @@ IOCTL_NUMBERS = {
      'RESET':       0x00002403,
  }
 
-signal_received = False
-
  ENCODING = locale.getpreferredencoding(False)
  TRACE_FILTER = re.compile(r'^[^\(]*$')
 
@@ -1598,7 +1596,19 @@ class CSVFormat(object):
 
  def log(stats, opts, frmt, keys):
      """Prints statistics as reiterating key block, multiple value blocks."""
-    global signal_received
+    signal_received = defaultdict(bool)
+
+    def handle_signal(sig, frame):
+        nonlocal signal_received
+        signal_received[sig] = True
+        return
+
+
+    signal.signal(signal.SIGINT, handle_signal)
+    signal.signal(signal.SIGTERM, handle_signal)
+    if opts.log_to_file:
+        signal.signal(signal.SIGHUP, handle_signal)
+
      line = 0
      banner_repeat = 20
      f = None
@@ -1624,39 +1634,31 @@ def log(stats, opts, frmt, keys):
      do_banner(opts)
      banner_printed = True
      while True:
-        try:
-            time.sleep(opts.set_delay)
-            if signal_received:
-                banner_printed = True
-                line = 0
-                f.close()
-                do_banner(opts)
-                signal_received = False
-            if (line % banner_repeat == 0 and not banner_printed and
-                not (opts.log_to_file and isinstance(frmt, CSVFormat))):
-                do_banner(opts)
-                banner_printed = True
-            values = stats.get()
-            if (not opts.skip_zero_records or
-                any(values[k].delta != 0 for k in keys)):
-                do_statline(opts, values)
-                line += 1
-                banner_printed = False
-        except KeyboardInterrupt:
+        time.sleep(opts.set_delay)
+        # Do not use the KeyboardInterrupt exception, because we may be running without a terminal
+        if (signal_received[signal.SIGINT] or signal_received[signal.SIGTERM]):
              break
+        if signal_received[signal.SIGHUP]:
+            banner_printed = True
+            line = 0
+            f.close()
+            do_banner(opts)
+            signal_received[signal.SIGHUP] = False
+        if (line % banner_repeat == 0 and not banner_printed and
+            not (opts.log_to_file and isinstance(frmt, CSVFormat))):
+            do_banner(opts)
+            banner_printed = True
+        values = stats.get()
+        if (not opts.skip_zero_records or
+            any(values[k].delta != 0 for k in keys)):
+            do_statline(opts, values)
+            line += 1
+            banner_printed = False
 
      if opts.log_to_file:
          f.close()
 
 
-def handle_signal(sig, frame):
-    global signal_received
-
-    signal_received = True
-
-    return
-
-
  def is_delay_valid(delay):
      """Verify delay is in valid value range."""
      msg = None
@@ -1869,8 +1871,6 @@ def main():
          sys.exit(0)
 
      if options.log or options.log_to_file:
-        if options.log_to_file:
-            signal.signal(signal.SIGHUP, handle_signal)
          keys = sorted(stats.get().keys())
          if options.csv:
              frmt = CSVFormat(keys)
tools/kvm/kvm_stat/kvm_stat.txt +12 -0
index 3a9f2037bd23..4a99a111a93c 100644
@@ -115,6 +115,18 @@ OPTIONS
  --skip-zero-records::
          omit records with all zeros in logging mode
 
+
+SIGNALS
+-------
+when kvm_stat is running in logging mode (either with -l or with -L),
+it handles the following signals:
+
+SIGHUP - closes and reopens the log file (-L only), then continues.
+
+SIGINT - closes the log file and terminates.
+SIGTERM - closes the log file and terminates.
+
+
  SEE ALSO
  --------
  'perf'(1), 'trace-cmd'(1)
#5 lore raw

(and my offer to maintain this script remains) - Thanks. C

Quoted 183 lines · Claudio Fontana

Gentle ping,

we currently need to carry this downstream, could you include this fix?

Thanks,

CLaudio

Quoted 173 lines · Claudio Fontana

Hi, according to MAINTAINERS file:

M:  Paolo Bonzini <[email protected]>
L:  [email protected]
F:  tools/kvm/

Paolo, is kvm_stat something you still care about, or should it be set to unmaintained? In this case I think someone at SUSE could pick it up.

Ciao,

Claudio

Quoted 157 lines · Juergen Gross

Any reason not to commit this patch? It has got a Reviewed-by: tag from Stefan more than 2 months ago...

Quoted 152 lines · Claudio Fontana

For the -l and -L options (logging mode), replace the use of the KeyboardInterrupt exception to gracefully terminate in favor of handling the SIGINT and SIGTERM signals.

This allows the program to be run from scripts and still be signaled to gracefully terminate without an interactive terminal.

Before this change, something like this script:

kvm_stat -p 85896 -d -t -s 1 -c -L kvm_stat_85896.csv & sleep 10
pkill -TERM -P $$

would yield an empty log:
-rw-r--r-- 1 root root 0 Aug 7 16:17 kvm_stat_85896.csv

after this commit:
-rw-r--r-- 1 root root 13466 Aug 7 16:57 kvm_stat_85896.csv

Cc Dario Faggioli <[email protected]>
Cc Fabiano Rosas <[email protected]>
---
  tools/kvm/kvm_stat/kvm_stat     | 64 ++++++++++++++++-----------------
  tools/kvm/kvm_stat/kvm_stat.txt | 12 +++++++
  2 files changed, 44 insertions(+), 32 deletions(-)
tools/kvm/kvm_stat/kvm_stat +32 -32
index 15bf00e79e3f..2cf2da3ed002 100755
@@ -297,8 +297,6 @@ IOCTL_NUMBERS = {
      'RESET':       0x00002403,
  }
 
-signal_received = False
-
  ENCODING = locale.getpreferredencoding(False)
  TRACE_FILTER = re.compile(r'^[^\(]*$')
 
@@ -1598,7 +1596,19 @@ class CSVFormat(object):
 
  def log(stats, opts, frmt, keys):
      """Prints statistics as reiterating key block, multiple value blocks."""
-    global signal_received
+    signal_received = defaultdict(bool)
+
+    def handle_signal(sig, frame):
+        nonlocal signal_received
+        signal_received[sig] = True
+        return
+
+
+    signal.signal(signal.SIGINT, handle_signal)
+    signal.signal(signal.SIGTERM, handle_signal)
+    if opts.log_to_file:
+        signal.signal(signal.SIGHUP, handle_signal)
+
      line = 0
      banner_repeat = 20
      f = None
@@ -1624,39 +1634,31 @@ def log(stats, opts, frmt, keys):
      do_banner(opts)
      banner_printed = True
      while True:
-        try:
-            time.sleep(opts.set_delay)
-            if signal_received:
-                banner_printed = True
-                line = 0
-                f.close()
-                do_banner(opts)
-                signal_received = False
-            if (line % banner_repeat == 0 and not banner_printed and
-                not (opts.log_to_file and isinstance(frmt, CSVFormat))):
-                do_banner(opts)
-                banner_printed = True
-            values = stats.get()
-            if (not opts.skip_zero_records or
-                any(values[k].delta != 0 for k in keys)):
-                do_statline(opts, values)
-                line += 1
-                banner_printed = False
-        except KeyboardInterrupt:
+        time.sleep(opts.set_delay)
+        # Do not use the KeyboardInterrupt exception, because we may be running without a terminal
+        if (signal_received[signal.SIGINT] or signal_received[signal.SIGTERM]):
              break
+        if signal_received[signal.SIGHUP]:
+            banner_printed = True
+            line = 0
+            f.close()
+            do_banner(opts)
+            signal_received[signal.SIGHUP] = False
+        if (line % banner_repeat == 0 and not banner_printed and
+            not (opts.log_to_file and isinstance(frmt, CSVFormat))):
+            do_banner(opts)
+            banner_printed = True
+        values = stats.get()
+        if (not opts.skip_zero_records or
+            any(values[k].delta != 0 for k in keys)):
+            do_statline(opts, values)
+            line += 1
+            banner_printed = False
 
      if opts.log_to_file:
          f.close()
 
 
-def handle_signal(sig, frame):
-    global signal_received
-
-    signal_received = True
-
-    return
-
-
  def is_delay_valid(delay):
      """Verify delay is in valid value range."""
      msg = None
@@ -1869,8 +1871,6 @@ def main():
          sys.exit(0)
 
      if options.log or options.log_to_file:
-        if options.log_to_file:
-            signal.signal(signal.SIGHUP, handle_signal)
          keys = sorted(stats.get().keys())
          if options.csv:
              frmt = CSVFormat(keys)
tools/kvm/kvm_stat/kvm_stat.txt +12 -0
index 3a9f2037bd23..4a99a111a93c 100644
@@ -115,6 +115,18 @@ OPTIONS
  --skip-zero-records::
          omit records with all zeros in logging mode
 
+
+SIGNALS
+-------
+when kvm_stat is running in logging mode (either with -l or with -L),
+it handles the following signals:
+
+SIGHUP - closes and reopens the log file (-L only), then continues.
+
+SIGINT - closes the log file and terminates.
+SIGTERM - closes the log file and terminates.
+
+
  SEE ALSO
  --------
  'perf'(1), 'trace-cmd'(1)
#6 lore raw
In reply to Claudio Fontana

Below patch was Acked in August last year, and despite a ping by me in October it wasn't committed yet.

Pablo, do you have any concerns with this patch? Or are you just no longer interested in maintaining kvm_stat?

As this patch is fixing a real bug which we at SUSE would like to see fixed, please take the patch or tell us what to do to get it upstream.

In case you just don't mind, I could offer to merge it via the Xen tree, even if this patch doesn't really belong there.

Juergen

Quoted 152 lines · Claudio Fontana

For the -l and -L options (logging mode), replace the use of the KeyboardInterrupt exception to gracefully terminate in favor of handling the SIGINT and SIGTERM signals.

This allows the program to be run from scripts and still be signaled to gracefully terminate without an interactive terminal.

Before this change, something like this script:

kvm_stat -p 85896 -d -t -s 1 -c -L kvm_stat_85896.csv & sleep 10
pkill -TERM -P $$

would yield an empty log:
-rw-r--r-- 1 root root 0 Aug 7 16:17 kvm_stat_85896.csv

after this commit:
-rw-r--r-- 1 root root 13466 Aug 7 16:57 kvm_stat_85896.csv

Cc Dario Faggioli <[email protected]>
Cc Fabiano Rosas <[email protected]>
---
  tools/kvm/kvm_stat/kvm_stat     | 64 ++++++++++++++++-----------------
  tools/kvm/kvm_stat/kvm_stat.txt | 12 +++++++
  2 files changed, 44 insertions(+), 32 deletions(-)
tools/kvm/kvm_stat/kvm_stat +32 -32
index 15bf00e79e3f..2cf2da3ed002 100755
@@ -297,8 +297,6 @@ IOCTL_NUMBERS = {
      'RESET':       0x00002403,
  }
 
-signal_received = False
-
  ENCODING = locale.getpreferredencoding(False)
  TRACE_FILTER = re.compile(r'^[^\(]*$')
 
@@ -1598,7 +1596,19 @@ class CSVFormat(object):
 
  def log(stats, opts, frmt, keys):
      """Prints statistics as reiterating key block, multiple value blocks."""
-    global signal_received
+    signal_received = defaultdict(bool)
+
+    def handle_signal(sig, frame):
+        nonlocal signal_received
+        signal_received[sig] = True
+        return
+
+
+    signal.signal(signal.SIGINT, handle_signal)
+    signal.signal(signal.SIGTERM, handle_signal)
+    if opts.log_to_file:
+        signal.signal(signal.SIGHUP, handle_signal)
+
      line = 0
      banner_repeat = 20
      f = None
@@ -1624,39 +1634,31 @@ def log(stats, opts, frmt, keys):
      do_banner(opts)
      banner_printed = True
      while True:
-        try:
-            time.sleep(opts.set_delay)
-            if signal_received:
-                banner_printed = True
-                line = 0
-                f.close()
-                do_banner(opts)
-                signal_received = False
-            if (line % banner_repeat == 0 and not banner_printed and
-                not (opts.log_to_file and isinstance(frmt, CSVFormat))):
-                do_banner(opts)
-                banner_printed = True
-            values = stats.get()
-            if (not opts.skip_zero_records or
-                any(values[k].delta != 0 for k in keys)):
-                do_statline(opts, values)
-                line += 1
-                banner_printed = False
-        except KeyboardInterrupt:
+        time.sleep(opts.set_delay)
+        # Do not use the KeyboardInterrupt exception, because we may be running without a terminal
+        if (signal_received[signal.SIGINT] or signal_received[signal.SIGTERM]):
              break
+        if signal_received[signal.SIGHUP]:
+            banner_printed = True
+            line = 0
+            f.close()
+            do_banner(opts)
+            signal_received[signal.SIGHUP] = False
+        if (line % banner_repeat == 0 and not banner_printed and
+            not (opts.log_to_file and isinstance(frmt, CSVFormat))):
+            do_banner(opts)
+            banner_printed = True
+        values = stats.get()
+        if (not opts.skip_zero_records or
+            any(values[k].delta != 0 for k in keys)):
+            do_statline(opts, values)
+            line += 1
+            banner_printed = False
 
      if opts.log_to_file:
          f.close()
 
 
-def handle_signal(sig, frame):
-    global signal_received
-
-    signal_received = True
-
-    return
-
-
  def is_delay_valid(delay):
      """Verify delay is in valid value range."""
      msg = None
@@ -1869,8 +1871,6 @@ def main():
          sys.exit(0)
 
      if options.log or options.log_to_file:
-        if options.log_to_file:
-            signal.signal(signal.SIGHUP, handle_signal)
          keys = sorted(stats.get().keys())
          if options.csv:
              frmt = CSVFormat(keys)
tools/kvm/kvm_stat/kvm_stat.txt +12 -0
index 3a9f2037bd23..4a99a111a93c 100644
@@ -115,6 +115,18 @@ OPTIONS
  --skip-zero-records::
          omit records with all zeros in logging mode
 
+
+SIGNALS
+-------
+when kvm_stat is running in logging mode (either with -l or with -L),
+it handles the following signals:
+
+SIGHUP - closes and reopens the log file (-L only), then continues.
+
+SIGINT - closes the log file and terminates.
+SIGTERM - closes the log file and terminates.
+
+
  SEE ALSO
  --------
  'perf'(1), 'trace-cmd'(1)