From 83aa25512de00bbbc469d3bf2414e99c8374e0d7 Mon Sep 17 00:00:00 2001
From: Tom de Vries <tdevries@suse.de>
Date: Wed, 21 Jun 2023 16:29:04 +0200
Subject: [PATCH] [gdb/testsuite] Add have_host_locale

With test-case gdb.tui/pr30056.exp, I run into:
...
sh: warning: setlocale: LC_ALL: cannot change locale (C.UTF-8)^M
...
and then subsequently into:
...
WARNING: timeout in accept_gdb_output
FAIL: gdb.tui/pr30056.exp: Control-C
...

This is on a CentOS 7 distro for powerpc64le.

Either it has no C.UTF-8 support, or it's not installed:
...
$ locale -a | grep ^C
C
$
...

Fix this by:
- adding a new proc have_host_locale, and
- using it in all test-cases using setenv LC_ALL.

Tested on powerpc64le-linux and x86_64-linux.
---
 gdb/testsuite/gdb.ada/non-ascii-latin-1.exp |  1 +
 gdb/testsuite/gdb.ada/non-ascii-latin-3.exp |  1 +
 gdb/testsuite/gdb.ada/non-ascii-utf-8.exp   |  1 +
 gdb/testsuite/gdb.base/utf8-identifiers.exp |  1 +
 gdb/testsuite/gdb.rust/unicode.exp          |  1 +
 gdb/testsuite/gdb.tui/pr30056.exp           |  1 +
 gdb/testsuite/lib/gdb.exp                   | 36 +++++++++++++++++++++
 7 files changed, 42 insertions(+)

diff --git a/gdb/testsuite/gdb.ada/non-ascii-latin-1.exp b/gdb/testsuite/gdb.ada/non-ascii-latin-1.exp
index 3cdf53dcdfc..877a864717b 100644
--- a/gdb/testsuite/gdb.ada/non-ascii-latin-1.exp
+++ b/gdb/testsuite/gdb.ada/non-ascii-latin-1.exp
@@ -18,6 +18,7 @@
 load_lib "ada.exp"
 
 require allow_ada_tests
+require {have_host_locale C.UTF-8}
 
 # Enable basic use of UTF-8.  LC_ALL gets reset for each testfile.  We
 # want this despite the program itself using Latin-1, as this test is
diff --git a/gdb/testsuite/gdb.ada/non-ascii-latin-3.exp b/gdb/testsuite/gdb.ada/non-ascii-latin-3.exp
index 5b5ae292177..285fa23e16a 100644
--- a/gdb/testsuite/gdb.ada/non-ascii-latin-3.exp
+++ b/gdb/testsuite/gdb.ada/non-ascii-latin-3.exp
@@ -18,6 +18,7 @@
 load_lib "ada.exp"
 
 require allow_ada_tests
+require {have_host_locale C.UTF-8}
 
 # Enable basic use of UTF-8.  LC_ALL gets reset for each testfile.  We
 # want this despite the program itself using Latin-1, as this test is
diff --git a/gdb/testsuite/gdb.ada/non-ascii-utf-8.exp b/gdb/testsuite/gdb.ada/non-ascii-utf-8.exp
index c1211619ca8..acf13fc84ce 100644
--- a/gdb/testsuite/gdb.ada/non-ascii-utf-8.exp
+++ b/gdb/testsuite/gdb.ada/non-ascii-utf-8.exp
@@ -18,6 +18,7 @@
 load_lib "ada.exp"
 
 require allow_ada_tests
+require {have_host_locale C.UTF-8}
 
 # Enable basic use of UTF-8.  LC_ALL gets reset for each testfile.
 setenv LC_ALL C.UTF-8
diff --git a/gdb/testsuite/gdb.base/utf8-identifiers.exp b/gdb/testsuite/gdb.base/utf8-identifiers.exp
index 48dce3cdc11..54a9a471f26 100644
--- a/gdb/testsuite/gdb.base/utf8-identifiers.exp
+++ b/gdb/testsuite/gdb.base/utf8-identifiers.exp
@@ -25,6 +25,7 @@ if { [is_c_compiler_gcc] } {
     # Gcc fully supports fextended-identifiers starting GCC 5.
     require {expr [gcc_major_version] >= 5}
 }
+require {have_host_locale C.UTF-8}
 
 standard_testfile
 
diff --git a/gdb/testsuite/gdb.rust/unicode.exp b/gdb/testsuite/gdb.rust/unicode.exp
index 97b37af316a..62619e8e769 100644
--- a/gdb/testsuite/gdb.rust/unicode.exp
+++ b/gdb/testsuite/gdb.rust/unicode.exp
@@ -18,6 +18,7 @@
 load_lib rust-support.exp
 require allow_rust_tests
 require {can_compile rust}
+require {have_host_locale C.UTF-8}
 
 # Non-ASCII identifiers were allowed starting in 1.53.
 require {rust_at_least 1.53}
diff --git a/gdb/testsuite/gdb.tui/pr30056.exp b/gdb/testsuite/gdb.tui/pr30056.exp
index 48eaa5735b8..55229dc1965 100644
--- a/gdb/testsuite/gdb.tui/pr30056.exp
+++ b/gdb/testsuite/gdb.tui/pr30056.exp
@@ -18,6 +18,7 @@
 # This PR is fixed in the in-repo copy of readline.  System readline may or
 # may not be fixed, so skip this test-case.
 require !with_system_readline
+require {have_host_locale C.UTF-8}
 
 tuiterm_env
 
diff --git a/gdb/testsuite/lib/gdb.exp b/gdb/testsuite/lib/gdb.exp
index f214a6bb54d..50fcb844183 100644
--- a/gdb/testsuite/lib/gdb.exp
+++ b/gdb/testsuite/lib/gdb.exp
@@ -9794,5 +9794,41 @@ proc lappend_include_file { flags file } {
     }
 }
 
+# Return a list of supported host locales.
+
+gdb_caching_proc host_locales { } {
+    set result [remote_exec host "locale -a"]
+    set status [lindex $result 0]
+    set output [lindex $result 1]
+
+    if { $status != 0 } {
+	return {}
+    }
+
+    # Split into list.
+    set output [string trim $output]
+    set l [split $output \n]
+
+    # Trim items.
+    set l [lmap v $l { string trim $v }]
+
+    # Normalize items to lower-case.
+    set l [lmap v $l { string tolower $v }]
+
+    return $l
+}
+
+# Return 1 if host locale LOCALE is supported.
+
+proc have_host_locale { locale } {
+    # Normalize to lower-case.
+    set locale [string tolower $locale]
+    # Normalize to without dash.
+    set locale [string map { "-" "" } $locale]
+
+    set idx [lsearch [host_locales] $locale]
+    return [expr $idx != -1]
+}
+
 # Always load compatibility stuff.
 load_lib future.exp
-- 
2.30.2