mirror of
https://sourceware.org/git/binutils-gdb.git
synced 2025-03-01 13:26:47 +08:00
0a2dde4a32
This patch implements the ability to set/unset environment variables on the remote target, mimicking what GDB already offers to the user. There are two features present here: user-set and user-unset environment variables. User-set environment variables are only the variables that are explicitly set by the user, using the 'set environment' command. This means that variables that were already present in the environment when starting GDB/GDBserver are not transmitted/considered by this feature. User-unset environment variables are variables that are explicitly unset by the user, using the 'unset environment' command. The idea behind this patch is to store user-set and user-unset environment variables in two separate sets, both part of gdb_environ. Then, when extended_remote_create_inferior is preparing to start the inferior, it will iterate over the two sets and set/unset variables accordingly. Three new packets are introduced: - QEnvironmentHexEncoded, which is used to set environment variables, and contains an hex-encoded string in the format "VAR=VALUE" (VALUE can be empty if the user set a variable with a null value, by doing 'set environment VAR='). - QEnvironmentUnset, which is used to unset environment variables, and contains an hex-encoded string in the format "VAR". - QEnvironmentReset, which is always the first packet to be transmitted, and is used to reset the environment, i.e., discard any changes made by the user on previous runs. The QEnvironmentHexEncoded packet is inspired on LLDB's extensions to the RSP. Details about it can be seen here: <https://raw.githubusercontent.com/llvm-mirror/lldb/master/docs/lldb-gdb-remote.txt> I decided not to implement the QEnvironment packet because it is considered deprecated by LLDB. This packet, on LLDB, serves the same purpose of QEnvironmentHexEncoded, but sends the information using a plain text, non-hex-encoded string. The other two packets are new. This patch also includes updates to the documentation, testsuite, and unit tests, without introducing regressions. gdb/ChangeLog: 2017-08-31 Sergio Durigan Junior <sergiodj@redhat.com> * NEWS (Changes since GDB 8.0): Add entry mentioning new support for setting/unsetting environment variables on the remote target. (New remote packets): Add entries for QEnvironmentHexEncoded, QEnvironmentUnset and QEnvironmentReset. * common/environ.c (gdb_environ::operator=): Extend method to handle m_user_set_env_list and m_user_unset_env_list. (gdb_environ::clear): Likewise. (match_var_in_string): Change type of first parameter from 'char *' to 'const char *'. (gdb_environ::set): Extend method to handle m_user_set_env_list and m_user_unset_env_list. (gdb_environ::unset): Likewise. (gdb_environ::clear_user_set_env): New method. (gdb_environ::user_set_envp): Likewise. (gdb_environ::user_unset_envp): Likewise. * common/environ.h (gdb_environ): Handle m_user_set_env_list and m_user_unset_env_list on move constructor/assignment. (unset): Add new default parameter 'update_unset_list = true'. (clear_user_set_env): New method. (user_set_envp): Likewise. (user_unset_envp): Likewise. (m_user_set_env_list): New std::set. (m_user_unset_env_list): Likewise. * common/rsp-low.c (hex2str): New function. (bin2hex): New overload for bin2hex function. * common/rsp-low.c (hex2str): New prototype. (str2hex): New overload prototype. * remote.c: Include "environ.h". Add QEnvironmentHexEncoded, QEnvironmentUnset and QEnvironmentReset. (remote_protocol_features): Add QEnvironmentHexEncoded, QEnvironmentUnset and QEnvironmentReset packets. (send_environment_packet): New function. (extended_remote_environment_support): Likewise. (extended_remote_create_inferior): Call extended_remote_environment_support. (_initialize_remote): Add QEnvironmentHexEncoded, QEnvironmentUnset and QEnvironmentReset packet configs. * unittests/environ-selftests.c (gdb_selftest_env_var): New variable. (test_vector_initialization): New function. (test_init_from_host_environ): Likewise. (test_reinit_from_host_environ): Likewise. (test_set_A_unset_B_unset_A_cannot_find_A_can_find_B): Likewise. (test_unset_set_empty_vector): Likewise. (test_vector_clear): Likewise. (test_std_move): Likewise. (test_move_constructor): (test_self_move): Likewise. (test_set_unset_reset): Likewise. (run_tests): Rewrite in terms of the functions above. gdb/gdbserver/ChangeLog: 2017-08-31 Sergio Durigan Junior <sergiodj@redhat.com> * server.c (handle_general_set): Handle QEnvironmentHexEncoded, QEnvironmentUnset and QEnvironmentReset packets. (handle_query): Inform remote that QEnvironmentHexEncoded, QEnvironmentUnset and QEnvironmentReset are supported. gdb/doc/ChangeLog: 2017-08-31 Sergio Durigan Junior <sergiodj@redhat.com> * gdb.texinfo (set environment): Add @anchor. Explain that environment variables set by the user are sent to GDBserver. (unset environment): Likewise, but for unsetting variables. (Connecting) <Remote Packet>: Add "environment-hex-encoded", "QEnvironmentHexEncoded", "environment-unset", "QEnvironmentUnset", "environment-reset" and "QEnvironmentReset" to the table. (Remote Protocol) <QEnvironmentHexEncoded, QEnvironmentUnset, QEnvironmentReset>: New item, explaining the packet. gdb/testsuite/ChangeLog: 2017-08-31 Sergio Durigan Junior <sergiodj@redhat.com> * gdb.base/share-env-with-gdbserver.c: New file. * gdb.base/share-env-with-gdbserver.exp: Likewise.
92 lines
3.5 KiB
C++
92 lines
3.5 KiB
C++
/* Low-level RSP routines for GDB, the GNU debugger.
|
|
|
|
Copyright (C) 1988-2017 Free Software Foundation, Inc.
|
|
|
|
This file is part of GDB.
|
|
|
|
This program is free software; you can redistribute it and/or modify
|
|
it under the terms of the GNU General Public License as published by
|
|
the Free Software Foundation; either version 3 of the License, or
|
|
(at your option) any later version.
|
|
|
|
This program is distributed in the hope that it will be useful,
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
GNU General Public License for more details.
|
|
|
|
You should have received a copy of the GNU General Public License
|
|
along with this program. If not, see <http://www.gnu.org/licenses/>. */
|
|
|
|
#ifndef COMMON_RSP_LOW_H
|
|
#define COMMON_RSP_LOW_H
|
|
|
|
/* Convert hex digit A to a number, or throw an exception. */
|
|
|
|
extern int fromhex (int a);
|
|
|
|
/* Convert number NIB to a hex digit. */
|
|
|
|
extern int tohex (int nib);
|
|
|
|
/* Write a character representing the low order four bits of NIBBLE in
|
|
hex to *BUF. Returns BUF+1. */
|
|
|
|
extern char *pack_nibble (char *buf, int nibble);
|
|
|
|
/* Write the low byte of BYTE in hex to *BUF. Returns BUF+2. */
|
|
|
|
extern char *pack_hex_byte (char *pkt, int byte);
|
|
|
|
/* Read hex digits from BUFF and convert to a number, which is stored
|
|
in RESULT. Reads until a non-hex digit is seen. Returns a pointer
|
|
to the terminating character. */
|
|
|
|
extern char *unpack_varlen_hex (char *buff, ULONGEST *result);
|
|
|
|
/* HEX is a string of characters representing hexadecimal digits.
|
|
Convert pairs of hex digits to bytes and store sequentially into
|
|
BIN. COUNT is the maximum number of characters to convert. This
|
|
will convert fewer characters if the number of hex characters
|
|
actually seen is odd, or if HEX terminates before COUNT characters.
|
|
Returns the number of characters actually converted. */
|
|
|
|
extern int hex2bin (const char *hex, gdb_byte *bin, int count);
|
|
|
|
/* Like hex2bin, but return a std::string. */
|
|
|
|
extern std::string hex2str (const char *hex);
|
|
|
|
/* Convert some bytes to a hexadecimal representation. BIN holds the
|
|
bytes to convert. COUNT says how many bytes to convert. The
|
|
resulting characters are stored in HEX, followed by a NUL
|
|
character. Returns the number of bytes actually converted. */
|
|
|
|
extern int bin2hex (const gdb_byte *bin, char *hex, int count);
|
|
|
|
/* Overloaded version of bin2hex that returns a std::string. */
|
|
|
|
extern std::string bin2hex (const gdb_byte *bin, int count);
|
|
|
|
/* Convert BUFFER, binary data at least LEN_UNITS addressable memory units
|
|
long, into escaped binary data in OUT_BUF. Only copy memory units that fit
|
|
completely in OUT_BUF. Set *OUT_LEN_UNITS to the number of units from
|
|
BUFFER successfully encoded in OUT_BUF, and return the number of bytes used
|
|
in OUT_BUF. The total number of bytes in the output buffer will be at most
|
|
OUT_MAXLEN_BYTES. This function properly escapes '*', and so is suitable
|
|
for the server side as well as the client. */
|
|
|
|
extern int remote_escape_output (const gdb_byte *buffer, int len_units,
|
|
int unit_size, gdb_byte *out_buf,
|
|
int *out_len_units, int out_maxlen_bytes);
|
|
|
|
/* Convert BUFFER, escaped data LEN bytes long, into binary data
|
|
in OUT_BUF. Return the number of bytes written to OUT_BUF.
|
|
Raise an error if the total number of bytes exceeds OUT_MAXLEN.
|
|
|
|
This function reverses remote_escape_output. */
|
|
|
|
extern int remote_unescape_input (const gdb_byte *buffer, int len,
|
|
gdb_byte *out_buf, int out_maxlen);
|
|
|
|
#endif /* COMMON_RSP_LOW_H */
|