1
0
mirror of https://git.tartarus.org/simon/putty.git synced 2025-01-09 17:38:00 +00:00
Go to file
Simon Tatham afb3dab1e9 Remove some pointless 'static' qualifiers.
In windows/window.c, a few variables inside functions were declared as
static, with no particular purpose that I can see: they don't seem to
have any reason to persist between calls to the function. So it makes
more sense to have them be ordinary stack-allocated automatic
variables.

Static variables removed by this commit:

 - 'RECT ss' in reset_window.
 - 'WORD keys[3]' and 'BYTE keysb[3]' in TranslateKey.
 - several (buffer, length) pairs in do_text_internal.
 - keys_unicode[] in TranslateKey.

All of these variables were originally introduced in patches credited
to Robert de Bath, which means I can't even try to reconstruct my
original thought processes, because they weren't _my_ thoughts anyway.
The arrays in do_text_internal are the easiest to understand: they're
reallocated larger as necessary, and making them static means the
allocation from a previous call can be reused, saving a malloc (though
I don't think that's a good enough reason to bother, these days).

The fixed-size static arrays and RECT are harder to explain. I suspect
they might originally have been that way because of 1990s attitudes to
performance: in x86-32 it's probably marginally faster to give your
variables constant addresses than sp-relative ones, and in the 1990s
computers were much slower, so there's an argument for making things
static if you have no _need_ to make them automatic. These days, the
difference is negligible, and persistent state is much more widely
recognised as a risk!

But keys_unicode[] is by far the strangest, because there was code
that clearly _did_ expect it to persist between calls, namely three
assignments to keys_unicode[0] near the end of the function after it's
finished being used for any other purpose, and a conditioned-out set
of debug() calls at the top of the function that print its contents
before anything has yet written to it.

But as far as I can see, the persistent data in the array is otherwise
completely unused. In any call to the function, if keys_unicode is
used at all, then it's either written directly by a call to ToAsciiEx,
or else (for pre-NT platforms) converted from ToAsciiEx's output via
MultiByteToWideChar. In both cases, the integer variable 'r' indicates
how many array elements were written, and subsequent accesses only
ever read those elements. So the assignments to keys_unicode[0] at the
end of the previous call will be overwritten before anything at all
can depend on them - with the exception of those debug statements.

I don't really understand what was going on here. It's tempting to
guess that those final assignments must have once done something
useful, and the code that used them was later removed. But the source
control history doesn't bear that out: a static array of three
elements (under its original name 'keys') was introduced in commit
0d5d39064a, and then commits 953b7775b3 and 26f1085038
added the other two assignments. And as far as I can see, even as of
the original commit 0d5d39064a, the code already had the property
that there was a final assignment to keys[0] which would inevitably be
overwritten in the next call before it could affect anything.

So I'm totally confused about what those assignments were _ever_
useful for. But an email thread from the time suggests that some of
those patches were being rebased repeatedly past other work (or
rather, the much less reliable CVS analogue of rebasing), so my best
guess is that that's where the confusion crept in - perhaps in RDB's
original version of the code they did do something useful.

Regardless of that, I'm pretty convinced that persistent array can't
be doing anything useful _now_. So I'm taking it out. But if anyone
reports a bug resulting from this change, then I'll eat my words - and
with any luck the details of the bug report will give us a clue what's
going on, and then we can put back some equivalent functionality with
much better comments!
2023-05-27 17:43:02 +01:00
charset sbcsgen.pl: handle \r\n line endings. 2022-09-01 20:43:23 +01:00
cmake Build option to disable scrollback compression. 2023-04-19 14:28:36 +01:00
contrib authplugin-example.py: Flush stderr. 2023-04-19 14:18:58 +01:00
crypto Add support for HMAC-SHA512. 2023-04-23 13:24:19 +01:00
doc Rename the just-added bug-compatibility mode. 2023-05-05 23:20:58 +01:00
icons New script to draw the icons as SVG. 2022-03-18 12:55:01 +00:00
keygen Add some missing #includes. 2022-09-03 11:59:12 +01:00
otherbackends Prevent sending double-EOF in raw backend. 2023-04-19 14:28:36 +01:00
proxy Formatting: normalise to { on same line. 2022-12-28 15:37:57 +00:00
ssh Merge SSH fixes from 'pre-0.79'. 2023-05-05 00:06:00 +01:00
stubs term_get_userpass_input: support the prompts->utf8 flag. 2023-03-04 14:06:04 +00:00
terminal Fix printing double-width char in rightmost column without wrap. 2023-04-19 14:28:36 +01:00
test Add support for HMAC-SHA512. 2023-04-23 13:24:19 +01:00
unicode Function to check a UTF-8 string for unknown characters. 2022-11-11 08:49:05 +00:00
unix Uppity: add a stunt mode --close-after-banner. 2023-04-29 11:34:08 +01:00
utils Add some missing casts in ctype functions. 2023-04-19 14:28:36 +01:00
windows Remove some pointless 'static' qualifiers. 2023-05-27 17:43:02 +01:00
.gitignore Add .gitignore rules for in-tree builds. 2021-04-19 18:26:56 +01:00
aqsync.c Build outgoing SSH agent requests in a strbuf. 2018-05-25 14:36:16 +01:00
be_list.c Merge be_*.c into one ifdef-controlled module. 2021-11-26 17:58:55 +00:00
Buildscr Reinstate putty.chm in Windows binary zipfiles. 2023-04-19 14:28:36 +01:00
Buildscr.cv Replace mkfiles.pl with a CMake build system. 2021-04-17 13:53:02 +01:00
callback.c Add lots of missing 'static' keywords. 2020-01-29 06:44:18 +00:00
cgtest.c Richer data type for interactive prompt results. 2021-12-28 18:08:31 +00:00
CHECKLST.txt Some checklist updates for the Windows Store. 2023-04-19 14:18:58 +01:00
clicons.c Change vtable defs to use C99 designated initialisers. 2020-03-10 21:06:29 +00:00
CMakeLists.txt New centralised version of local line editing. 2023-03-04 13:55:50 +00:00
cmdgen.c cmdgen: Fix docs and usage messages. 2022-10-20 23:55:19 +01:00
cmdline.c term_get_userpass_input: support the prompts->utf8 flag. 2023-03-04 14:06:04 +00:00
config.c Rename the just-added bug-compatibility mode. 2023-05-05 23:20:58 +01:00
console.c Handle the -batch option centrally in cmdline.c. 2022-11-26 10:31:18 +00:00
console.h Mention the host name in host-key prompts. 2021-09-16 14:33:59 +01:00
defs.h New centralised version of local line editing. 2023-03-04 13:55:50 +00:00
dialog.c Rename 'ret' variables passed from allocation to return. 2022-09-14 16:10:29 +01:00
dialog.h Replace integer context2 encoding in conf_editbox_handler. 2022-09-01 20:43:23 +01:00
errsock.c Change vtable defs to use C99 designated initialisers. 2020-03-10 21:06:29 +00:00
import.c Rename 'ret' variables passed from allocation to return. 2022-09-14 16:10:29 +01:00
LATEST.VER Update version number for 0.78 release. 2022-10-28 18:19:19 +01:00
ldisc.c ldisc: fix unwanted double-action of ^U. 2023-04-19 14:28:36 +01:00
LICENCE It's a new year. 2023-04-19 14:28:36 +01:00
licence.pl Separate the functions of licence.pl. 2021-04-17 13:52:27 +01:00
logging.c Move the logeventf wrappers into their own source file. 2023-02-18 14:11:31 +00:00
marshal.h Make encode_utf8() output to a BinarySink. 2022-11-09 19:02:32 +00:00
misc.h decode_utf8: add an enumeration of failure reasons. 2023-02-17 17:16:54 +00:00
mksrcarc.sh Updates to mksrcarc.sh. 2022-09-01 20:43:23 +01:00
mkunxarc.sh Integrate the 'doc' subdir into the CMake system. 2021-05-03 17:01:55 +01:00
mpint.h Utility function mp_resize. 2022-04-15 17:46:06 +01:00
network.h New facility, platform_start_subprocess. 2022-09-01 20:43:23 +01:00
pageant.c Formatting: fix a few mis-spaced assignments. 2022-12-28 15:28:36 +00:00
pageant.h winpgnt: menu options to delete/reencrypt everything. 2021-04-04 10:02:24 +01:00
pinger.c Whitespace rationalisation of entire code base. 2019-09-08 20:29:21 +01:00
pscp.c Handle the -batch option centrally in cmdline.c. 2022-11-26 10:31:18 +00:00
psftp.c Handle the -batch option centrally in cmdline.c. 2022-11-26 10:31:18 +00:00
psftp.h Remove FLAG_VERBOSE. 2020-01-30 06:40:21 +00:00
psftpcommon.c Move the SSH implementation into its own subdirectory. 2021-04-22 18:09:13 +01:00
psocks.c New Seat method, seat_nonfatal(). 2022-09-13 11:26:57 +01:00
psocks.h Auxiliary application: 'psocks', a simple SOCKS server. 2020-02-23 16:36:27 +00:00
putty.h Merge SSH fixes from 'pre-0.79'. 2023-05-05 00:06:00 +01:00
puttymem.h Update source file names in comments and docs. 2022-01-22 15:51:31 +00:00
README README: remove mention of doc/Makefile. 2022-10-23 12:37:20 +01:00
release.pl Remove FTP from release machinery. 2022-09-12 09:34:01 +01:00
settings.c Merge SSH fixes from 'pre-0.79'. 2023-05-05 00:06:00 +01:00
sign.sh GPG key rollover. 2021-08-14 08:02:27 +01:00
specials.h Move SessionSpecial definitions into their own header. 2023-03-04 13:05:20 +00:00
ssh.h Work around key algorithm naming change in OpenSSH <= 7.7. 2023-05-05 00:05:28 +01:00
sshcr.h Formatting: fix a few mis-spaced assignments. 2022-12-28 15:28:36 +00:00
sshkeygen.h Side-channel-safe rewrite of the Miller-Rabin test. 2021-08-27 18:04:49 +01:00
sshpubk.c Remove a pointless allocation. 2023-04-19 14:18:58 +01:00
sshrand.c Remove dependency of sshrand.c on SHA-512. 2020-09-13 09:11:31 +01:00
storage.h New Seat method, seat_nonfatal(). 2022-09-13 11:26:57 +01:00
timing.c Whitespace rationalisation of entire code base. 2019-09-08 20:29:21 +01:00
tree234.h Formatting: remove spurious spaces in 'type * var'. 2022-08-03 20:48:46 +01:00
version.h Replace mkfiles.pl with a CMake build system. 2021-04-17 13:53:02 +01:00
x11disp.c Move the SSH implementation into its own subdirectory. 2021-04-22 18:09:13 +01:00

This is the README for PuTTY, a free Windows and Unix Telnet and SSH
client.

PuTTY is built using CMake <https://cmake.org/>. To compile in the
simplest way (on any of Linux, Windows or Mac), run these commands in
the source directory:

  cmake .
  cmake --build .

Then, to install in the simplest way on Linux or Mac:

  cmake --build . --target install

On Unix, pterm would like to be setuid or setgid, as appropriate, to
permit it to write records of user logins to /var/run/utmp and
/var/log/wtmp. (Of course it will not use this privilege for
anything else, and in particular it will drop all privileges before
starting up complex subsystems like GTK.) The cmake install step
doesn't attempt to add these privileges, so if you want user login
recording to work, you should manually ch{own,grp} and chmod the
pterm binary yourself after installation. If you don't do this,
pterm will still work, but not update the user login databases.

Documentation (in various formats including Windows Help and Unix
`man' pages) is built from the Halibut (`.but') files in the `doc'
subdirectory. If you aren't using one of our source snapshots,
you'll need to do this yourself. Halibut can be found at
<https://www.chiark.greenend.org.uk/~sgtatham/halibut/>.

The PuTTY home web site is

    https://www.chiark.greenend.org.uk/~sgtatham/putty/

If you want to send bug reports or feature requests, please read the
Feedback section of the web site before doing so. Sending one-line
reports saying `it doesn't work' will waste your time as much as
ours.

See the file LICENCE for the licence conditions.