xref: /netbsd-src/external/gpl3/gdb.old/dist/gdb/target-connection.c (revision f8cf1a9151c7af1cb0bd8b09c13c66bca599c027)
1 /* List of target connections for GDB.
2 
3    Copyright (C) 2017-2023 Free Software Foundation, Inc.
4 
5    This file is part of GDB.
6 
7    This program is free software; you can redistribute it and/or modify
8    it under the terms of the GNU General Public License as published by
9    the Free Software Foundation; either version 3 of the License, or
10    (at your option) any later version.
11 
12    This program is distributed in the hope that it will be useful,
13    but WITHOUT ANY WARRANTY; without even the implied warranty of
14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15    GNU General Public License for more details.
16 
17    You should have received a copy of the GNU General Public License
18    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
19 
20 #include "defs.h"
21 #include "target-connection.h"
22 
23 #include <map>
24 
25 #include "inferior.h"
26 #include "target.h"
27 #include "observable.h"
28 
29 /* A map between connection number and representative process_stratum
30    target.  */
31 static std::map<int, process_stratum_target *> process_targets;
32 
33 /* The highest connection number ever given to a target.  */
34 static int highest_target_connection_num;
35 
36 /* See target-connection.h.  */
37 
38 void
39 connection_list_add (process_stratum_target *t)
40 {
41   if (t->connection_number == 0)
42     {
43       t->connection_number = ++highest_target_connection_num;
44       process_targets[t->connection_number] = t;
45     }
46 }
47 
48 /* See target-connection.h.  */
49 
50 void
51 connection_list_remove (process_stratum_target *t)
52 {
53   /* Notify about the connection being removed before we reset the
54      connection number to zero.  */
55   gdb::observers::connection_removed.notify (t);
56   process_targets.erase (t->connection_number);
57   t->connection_number = 0;
58 }
59 
60 /* See target-connection.h.  */
61 
62 std::string
63 make_target_connection_string (process_stratum_target *t)
64 {
65   if (t->connection_string () != NULL)
66     return string_printf ("%s %s", t->shortname (),
67 			  t->connection_string ());
68   else
69     return t->shortname ();
70 }
71 
72 /* Prints the list of target connections and their details on UIOUT.
73 
74    If REQUESTED_CONNECTIONS is not NULL, it's a list of GDB ids of the
75    target connections that should be printed.  Otherwise, all target
76    connections are printed.  */
77 
78 static void
79 print_connection (struct ui_out *uiout, const char *requested_connections)
80 {
81   int count = 0;
82   size_t what_len = 0;
83 
84   /* Compute number of lines we will print.  */
85   for (const auto &it : process_targets)
86     {
87       if (!number_is_in_list (requested_connections, it.first))
88 	continue;
89 
90       ++count;
91 
92       process_stratum_target *t = it.second;
93 
94       size_t l = make_target_connection_string (t).length ();
95       if (l > what_len)
96 	what_len = l;
97     }
98 
99   if (count == 0)
100     {
101       uiout->message (_("No connections.\n"));
102       return;
103     }
104 
105   ui_out_emit_table table_emitter (uiout, 4, process_targets.size (),
106 				   "connections");
107 
108   uiout->table_header (1, ui_left, "current", "");
109   uiout->table_header (4, ui_left, "number", "Num");
110   /* The text in the "what" column may include spaces.  Add one extra
111      space to visually separate the What and Description columns a
112      little better.  Compare:
113       "* 1    remote :9999 Remote serial target in gdb-specific protocol"
114       "* 1    remote :9999  Remote serial target in gdb-specific protocol"
115   */
116   uiout->table_header (what_len + 1, ui_left, "what", "What");
117   uiout->table_header (17, ui_left, "description", "Description");
118 
119   uiout->table_body ();
120 
121   for (const auto &it : process_targets)
122     {
123       process_stratum_target *t = it.second;
124 
125       if (!number_is_in_list (requested_connections, t->connection_number))
126 	continue;
127 
128       ui_out_emit_tuple tuple_emitter (uiout, NULL);
129 
130       if (current_inferior ()->process_target () == t)
131 	uiout->field_string ("current", "*");
132       else
133 	uiout->field_skip ("current");
134 
135       uiout->field_signed ("number", t->connection_number);
136 
137       uiout->field_string ("what", make_target_connection_string (t));
138 
139       uiout->field_string ("description", t->longname ());
140 
141       uiout->text ("\n");
142     }
143 }
144 
145 /* The "info connections" command.  */
146 
147 static void
148 info_connections_command (const char *args, int from_tty)
149 {
150   print_connection (current_uiout, args);
151 }
152 
153 void _initialize_target_connection ();
154 
155 void
156 _initialize_target_connection ()
157 {
158   add_info ("connections", info_connections_command,
159 	    _("\
160 Target connections in use.\n\
161 Shows the list of target connections currently in use."));
162 }
163