build index.html for all winners

Updated manifest as per recent file changes.

Updated winner `.winner.json` to reflect the manifest changes.

Added [bin/all_run.sh](bin/all_run.sh) tool to run a command over
all winning entries.

These tools had slight improvements in the help usage message:

* bin/gen-author.sh VERSION="1.3.1 2024-01-16"
* bin/gen-inventory.sh VERSION="1.0.1 2024-01-16"
* bin/pandoc_wrapper.sh VERSION="1.3.1 2024-01-16"
* bin/subst.default.sh VERSION="1.1.1 2024-01-16"
* bin/subst.winner-index.sh VERSION="1.1.1 2024-01-16"

The `bin/readme2index.sh` tool was improved so that
if the `index.html` file exists and the tool forms
the exact same content, then the file `index.html`
file is NOT touched.

* bin/readme2index.sh VERSION="1.1 2024-01-16"

We used the following command to generate `index.html` files
for all winning entries:

```sh
bin/all_run.sh -v 3 bin/readme2index.sh
```

NOTE: We have not (yet) built HTML files above the winner directory
level (e.g., no year level nor top level HTML), nor have be built
non-index HTML files for winners.

NOTE: By default we are running `pandoc(1)` with:

```
--fail-if-warnings=true
```

This means that any problems with markdown to HTML
generates an error.  This is done to be sure that
the HTML conversion is clean.

We had to fix the following `README.md` files:

* `2000/rince/README.md`

The reference [^2] was never used.  We made a guess that [^2] applies
to the same spot as [^1].  Perhaps there is a better spot where
[^2] applies?

NOTE: For every reference, there MUST be some place where that
reference is used.

* 2012/vik/README.md

The string "$...$" is assumed to be a TeX encoded string.

NOTE: Every "$..$" needs to be backslashed as in "\$..\$".

* 2018/burton1/README.md

The reference [2] was duplicated.  We changed the
second [2] to [3].

NOTE: Every reference needs to have a unique number.

* 2020/carlini/README.md

The string "$...$" is assumed to be a TeX encoded string.

NOTE: Every "$..$" needs to be backslashed as in "\$..\$".

We also found 2 errors in the `author/author_handle.json` file set:

* author/Anonymous_2001.json

The `author/Anonymous_2001.json` file was missing.

* author/Jari_Arkko.json

The winner ID for `1989_jar.1` had a typo.
This commit is contained in:
Landon Curt Noll committed 2024-01-17 00:32:39 -08:00
1 parent 893cd915b6
commit c1466f5165
350 files changed
+95242 -4217

No files matched your search

+364 -13
View File
@@ -1,4 +1,6 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<!-- START: two lines up starts content from: inc/top.default.html -->
<!-- -->
<!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
<!-- !!! DO NOT MODIFY THIS FILE - This file is generated by a tool !!! -->
@@ -6,27 +8,376 @@
<!-- !!! DO NOT MODIFY THIS FILE - This file is generated by a tool !!! -->
<!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
<!-- -->
<!-- file: 2001/anonymous/index.html created by: fake.gen_index.sh version: 1.0.5 2023-10-31 -->
<html lang="en">
<!-- END: this line ends content from: inc/top.default.html -->
<!-- -->
<!-- This file was formed by the tool: bin/readme2index.sh version: 1.1 2024-01-16 -->
<!-- -->
<!-- START: this line starts content from: inc/head.default.html -->
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>2001 anonymous</title>
<meta name="description" content="IOCCC year: 2001 IOCCC winner: anonymous winner index page">
<meta name="keywords" content="IOCCC,2001,anonymous,winner index page">
<link rel="stylesheet" href="/temp-test-ioccc/ioccc.css">
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
<title>2001/anonymous</title>
<meta name="description" content="2001 IOCCC winner anonymous">
<meta name="keywords" content="IOCCC, 2001, IOCCC 2001, IOCCC winner, anonymous">
</head>
<!-- END: this line ends content from: inc/head.default.html -->
<!-- START: this line starts content from: inc/body.default.html -->
<body>
<h1>2001 anonymous</h1>
<!-- END: this line ends content from: inc/body.default.html -->
<!-- START: this line starts content from: inc/header.default.html -->
<p>XXX - fake content until readme2index is working - XXX</p>
<div class="header">
<img src="/temp-test-ioccc/png/ioccc.png" alt="IOCCC image by Matt Zucker" width=300 height=110>
<h1>The International Obfuscated C Code Contest</h1>
<h2>2001/anonymous</h2>
</div>
<hr style="width:50%;text-align:left;margin-left:0">
<!-- END: this line ends content from: inc/header.default.html -->
<!-- START: this line starts content from: inc/topnav.first.html -->
<!-- Start Nu Html Checker -->
<p><a href="https://validator.w3.org/nu/?doc=https%3A%2F%2Fioccc-src.github.io%2Ftemp-test-ioccc%2F2001%2Fanonymous%2Findex.html">Nu Html check https://ioccc-src.github.io/temp-test-ioccc/2001/anonymous/index.html</a></p>
<!-- End Nu Html Checker -->
<div class="topnav">
<a class="Left Disabled" href="#">first entry</a>
<a class="Left" href="../index.html">&uarr; 2001 &uarr;</a>
<a class="Left" href="../bellard/index.html">bellard &rarr;</a>
<a class="Right" href="#inventory">Inventory</a>
</div>
<!-- END: this line ends content from: inc/topnav.first.html -->
<!-- START: this line starts content from: inc/begin-row.default.html -->
<div class="row">
<!-- END: this line ends content from: inc/begin-row.default.html -->
<!-- START: this line starts content from: inc/begin-leftcolumn.default.html -->
<div class="leftcolumn">
<!-- END: this line ends content from: inc/begin-leftcolumn.default.html -->
<!-- START: this line starts content from: inc/sidenav.default.html -->
<div class="sidenav">
<a href="#content">Jump to contents</a>
</div>
<hr>
<div class="sidenav">
<a href="/temp-test-ioccc/index.html">IOCCC Home</a>
<a href="/temp-test-ioccc/years.html">Winning Entries</a>
<a href="/temp-test-ioccc/winners.html">People who have won</a>
</div>
<hr>
<div class="sidenav">
<a href="/temp-test-ioccc/news.html">IOCCC News</a>
<a href="/temp-test-ioccc/faq.html#submit">How to enter the IOCCC</a>
<a href="/temp-test-ioccc/faq.html">FAQ</a>
</div>
<hr>
<div class="sidenav">
<a href="/temp-test-ioccc/bugs.html">Bugs &amp; (mis)features</a>
<a href="/temp-test-ioccc/faq.html#fix_a_winner">Fixing IOCCC winners</a>
<a href="/temp-test-ioccc/faq.html#fix_web_site">Fixing the web site</a>
<a href="/temp-test-ioccc/faq.html#fix_author">Fixing winner info</a>
<a href="/temp-test-ioccc/thanks-for-help.html">Thanks for the help</a>
</div>
<hr>
<div class="sidenav">
<a href="/temp-test-ioccc/judges.html">The IOCCC Judges</a>
<a href="/temp-test-ioccc/contact.html">Contacting the IOCCC</a>
</div>
<hr>
<div class="sidenav">
<a href="#top">Jump to top</a>
</div>
<!-- END: this line ends content from: inc/sidenav.default.html -->
<!-- START: this line starts content from: inc/end-leftcolumn.default.html -->
</div>
<!-- END: this line ends content from: inc/end-leftcolumn.default.html -->
<!-- START: this line starts content from: inc/begin-rightcolumn.default.html -->
<div class="rightcolumn">
<!-- END: this line ends content from: inc/begin-rightcolumn.default.html -->
<!-- START: this line starts content from: inc/before-content.default.html -->
<a name="content"></a>
<!-- END: this line ends content from: inc/before-content.default.html -->
<!-- START: this line starts content generated by: bin/gen-author.sh -->
<p><a name="author"><strong>Author:</strong></a> <br><br>Name: <a
href="/temp-test-ioccc/winners.html#Anonymous_2001">Anonymous
2001</a><br> Location: <a
href="/temp-test-ioccc/location.html#GB">GB</a></p>
<!-- END: next line ends content generated by: bin/gen-author.sh -->
<h2 id="to-build">To build:</h2>
<div class="sourceCode" id="cb1"><pre class="sourceCode sh"><code class="sourceCode bash"><span id="cb1-1"><a href="#cb1-1" aria-hidden="true" tabindex="-1"></a><span class="fu">make</span></span></code></pre></div>
<p>The programs that this program is supposed to act on, <a
href="anonymous.ten.c">anonymous.ten.c</a> and <a
href="anonymous.bed.c">anonymous.bed.c</a>, compiled with
<code>make</code>, MUST be compiled as 32-bit ELF binaries. In the case
that this fails these programs will be compiled as 64-bit binaries as
alternate code, <code>anonymous.ten.alt</code> and
<code>anonymous.bed.alt</code>, ELF or otherwise. However trying to use
the entry on these files will fail. See <a
href="#alternate-code">Alternate code</a> below for information on how
to compile these programs as 64-bit binaries (or whatever your system
will compile them as).</p>
<h3 id="bugs-and-misfeatures">Bugs and (Mis)features:</h3>
<p>The current status of this entry is:</p>
<pre><code>STATUS: INABIAF - please **DO NOT** fix</code></pre>
<p>For more detailed information see <a
href="/bugs.md#2001-anonymous">2001 anonymous in bugs.md</a>.</p>
<h2 id="to-use">To use:</h2>
<div class="sourceCode" id="cb3"><pre class="sourceCode sh"><code class="sourceCode bash"><span id="cb3-1"><a href="#cb3-1" aria-hidden="true" tabindex="-1"></a><span class="ex">./anonymous</span> x86_program</span></code></pre></div>
<h2 id="try">Try:</h2>
<div class="sourceCode" id="cb4"><pre class="sourceCode sh"><code class="sourceCode bash"><span id="cb4-1"><a href="#cb4-1" aria-hidden="true" tabindex="-1"></a><span class="ex">./try.sh</span></span>
<span id="cb4-2"><a href="#cb4-2" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb4-3"><a href="#cb4-3" aria-hidden="true" tabindex="-1"></a><span class="ex">./anonymous</span> anonymous.bed <span class="co"># if able to compile as a 32-bit (-m32) ELF binary</span></span></code></pre></div>
<p>NOTE: if the 32-bit version cannot be compiled the script will at
least compile <a href="anonymous.ten.c">anonymous.ten</a> as a 64-bit
program (or whatever your system is set to) and run it directly.</p>
<p>What happens if the x86 program has already been modified by this
program? The judges’ remarks below might give you a hint!</p>
<p>What happens if you try it on another file like <a
href="anonymous.c">anonymous.c</a>? Can you recompile it okay? What if
you run it on <code>anonymous</code> itself? Can you run the program
successfully after it without recompiling?</p>
<h2 id="alternate-code">Alternate code:</h2>
<p>In the case you you wish to manually compile the extra programs as
64-bit code you may do so. Using the entry on these binaries will very
likely crash the program or do something terribly wrong like
slaughtering all the <a
href="https://www.glyphweb.com/arda/e/elves.html">elves</a> of <a
href="https://www.glyphweb.com/arda/i/imladris.php">Imladris</a>! :-) so
please don’t do that :-(</p>
<h3 id="alternate-build">Alternate build:</h3>
<div class="sourceCode" id="cb5"><pre class="sourceCode sh"><code class="sourceCode bash"><span id="cb5-1"><a href="#cb5-1" aria-hidden="true" tabindex="-1"></a><span class="fu">make</span> alt</span></code></pre></div>
<h3 id="alternate-use">Alternate use:</h3>
<div class="sourceCode" id="cb6"><pre class="sourceCode sh"><code class="sourceCode bash"><span id="cb6-1"><a href="#cb6-1" aria-hidden="true" tabindex="-1"></a><span class="ex">./anonymous.ten.alt</span></span>
<span id="cb6-2"><a href="#cb6-2" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb6-3"><a href="#cb6-3" aria-hidden="true" tabindex="-1"></a><span class="ex">./anonymous.bed.alt</span></span></code></pre></div>
<h3 id="a-2023-note-about-the-warning-from-the-author">A 2023 note about
the warning from the author:</h3>
<p>The author suggested that this <em>might</em> somewhat destroy the
binaries this touches but after the fix of 2023 this was not observed
(yet?). It does indeed modify the files (though not all files are
modified: can you figure out why that is?) but using them after did not
result in any problems. It could be that it’s no longer known exactly
what is supposed to happen and possibly that the modification might not
be entirely correct for that reason though it does appear to be
correct.</p>
<p>It appears that the corruption happens only if the modification fails
in the middle of doing so so that might be why it hasn’t been
observed.</p>
<h2 id="judges-remarks">Judges’ remarks:</h2>
<p>Is emulation the sincerest form of flattery? This small program does
quite a lot of bit twiddling.</p>
<h2 id="authors-remarks">Author’s remarks:</h2>
<p>This program is an optimizing dynamic binary translator, allowing you
to run x86 programs on any machine (x86 or otherwise).</p>
<p>I have included a simple <a
href="https://www.bbc.co.uk/teach/school-radio/nursery-rhymes-ten-green-bottles/zncyt39">10
Green Bottles</a> <a href="anonymous.ten.c">program</a> (try
<code>make anonymous.ten</code>), meant to be compiled as a 32-bit ELF
binary.</p>
<p>The program <code>anonymous.ten</code>, and its source (dull) are
included as data files.</p>
<h3 id="warning">Warning</h3>
<p>Note that the translator screws around with the binary you run on it
and <em>might</em> corrupt the binary to some extent and in so doing
might leave any program you run on it unusable.</p>
<p>The build script should give an example command to compile the
program.</p>
<h3 id="features">Features</h3>
<p><a href="https://en.wikipedia.org/wiki/Basic_block">Basic Block</a>
<a href="https://en.wikipedia.org/wiki/Cache_(computing)">Cache</a>:
Rather than translating each instruction individually the dynamic binary
translator generates a translation for an entire basic block of subject
code. Having translated a block once, the target code generated will be
stored for the duration that the program is running, so as a program
runs its performance will improve, as it hits cached blocks. This can be
clearly observed in the example program, <a
href="anonymous.ten.c">anonymous.ten</a> which must be compiled as a
32-bit ELF binary.</p>
<h3 id="target-library-linking">Target Library Linking:</h3>
<p>The program runs <a
href="https://en.wikipedia.org/wiki/Dynamic_linker">dynamically
linked</a> <a
href="https://en.wikipedia.org/wiki/Executable_and_Linkable_Format">ELF
binaries</a>, and when the subject program attempts to make a call to a
standard <a
href="https://en.wikipedia.org/wiki/Library_(computing)">library</a>,
the translator attempts to make an appropriate call to the native system
libraries on the target machine. This involves mangling between
different calling conventions, etc.</p>
<h3 id="automatic-endian-detectionreversal">Automatic Endian
Detection/Reversal:</h3>
<p>There are various problems raised when attempting to run little <a
href="https://en.wikipedia.org/wiki/Endianness">endian</a> <a
href="https://en.wikipedia.org/wiki/X86">x86</a> code on a big endian
chip, such as a <a href="https://en.wikipedia.org/wiki/PowerPC">PPC</a>.
These problems are dealt with in a manner that is entirely transparent
to the user.</p>
<h3 id="configuration">Configuration:</h3>
<h4 id="warnings">Warnings:</h4>
<p>By default the build script should compile the program with a set of
switches such that while compiling the program it generates one error
(which I feel is useful advice). The program should generate no further
compiler errors while it is running (yes, the program can generate
compiler errors while it is running). If you do not wish to see this
error, or if the program generates any further error when compiled using
your C compiler please remove the <code>-Dwarning='-Dprocessor'</code>
line and the <code>$$warning</code> from the compiler invocation.</p>
<h3 id="optimization">Optimization</h3>
<p>The build script contains a <code>-O1</code> switch for the compiler.
Increasing the optimization level will make the program run
<em>slower</em>, while compiling the program without any optimization
will allow it to run <em>faster</em>.</p>
<h3 id="obfuscation">Obfuscation</h3>
<p>The most obvious part of the obfuscation is probably the mess of
<code>#define</code>s at the top. This may seem a somewhat tired old
obfuscation - however since many of these macros are (sometimes only)
used by the program once it has dynamically recompiled itself, they are
only referenced within the source code from within strings - and
therefore the macros cannot be expanded. Furthermore, some of these
strings of code are not given as strings, but instead are wrapped up in
macros that use the <code>#</code> preprocessor operator to turn them
into strings. In the hope of throwing off a few C beautifiers the macro
to generate the strings is not contained within the source code but
instead is passed in on the command line.</p>
<p>Buried under all this, and the fact that the entire program is just a
call to <code>exit(3)</code>, there are some nice subtle little
obfuscations. For example, you may notice that there are a couple of
macros that use the <code>##</code> preprocessor operator to build pairs
of functions. One of these macros is used to build pairs of functions of
which only one has local variables which shadow global variables: so one
modifies the global state, and the other doesn’t.</p>
<p>There is also quite a nice trick where I wave a magic wand, and a
chunk of code which should only be run when the program is run for the
first time (setting the <a
href="https://en.wikipedia.org/wiki/Program_counter">PC / IP</a> to
point at <code>main()</code> etc.) gets turned into a
<strike>frog</strike>string. The C compiler sees a string by itself in
the code, thinks “yup, that’s a valid C expression”, and quietly moves
on to the next line of code.</p>
<h3 id="limitations">Limitations</h3>
<p>Due to space limitations only a handful of instructions are
supported; these instructions which are supported are supported in
somewhat non-conventional ways: chunks of the architecture (e.g. flags)
are just ignored, the ELF <a
href="https://en.wikipedia.org/wiki/Loader_(computing)">loader</a> does
not really load the <a
href="https://en.wikipedia.org/wiki/Executable_and_Linkable_Format">ELF
binary</a>, the target <a
href="https://en.wikipedia.org/wiki/Linker_(computing)">library
linking</a> can only pass up to 3 parameters to the target library
function, etc.</p>
<p>In short, please consider this a full disclaimer for any bug that may
turn up - yes the program is unsafe, but it’s pretty cool anyway.</p>
<p>Despite all this, the translator is not exclusively limited to
running the <a href="anonymous.ten.c">anonymous.ten</a> program. Other
trivial <strong><em>x86</em></strong> programs may run on the translator
- and I have successfully run a wide range of “Hello World” programs,
including one of last year’s IOCCC winners, <a
href="/2000/tomx/tomx.c">tomx</a>.</p>
<h3 id="complete-program">Complete Program</h3>
<p>The fact that the program makes calls to <code>system(3)</code> and
<code>execv(3)</code> may imply that it is not a complete program in its
own right, as it relies on other programs. The call to
<code>system(3)</code> is a call to ask gcc to recompile the translator
with a new set of switches, and the call to <code>execv(3)</code> asks
for the newly compiled program to be executed. I would point out that
almost every other entry to this competition also require a C compiler
(well, the published winners at any rate, and I recognize that a few
don’t). There is little real difference between this program and one
like last year’s entry <a href="/2000/dhyang/dhyang.c">dhyang</a>; both
are just C programs that generate C code as their output.</p>
<p>Enjoy and thanks!</p>
<h2 id="copyright-and-cc-by-sa-4.0-license">Copyright and CC BY-SA 4.0
License:</h2>
<p>This file is Copyright (c) 2023 by Landon Curt Noll. All Rights
Reserved. You are free to share and adapt this file under the terms of
this license:</p>
<pre><code>Creative Commons Attribution-ShareAlike 4.0 International (CC BY-SA 4.0)</code></pre>
<p>For more information, see:
https://creativecommons.org/licenses/by-sa/4.0/</p>
<!-- START: this line starts content generated by: bin/gen-inventory.sh -->
<h1 id="inventory-for-2001anonymous"><a name="inventory"></a>Inventory
for 2001/anonymous</h1>
<h2 id="primary-files">Primary files</h2>
<ul>
<li><a href="index.html">index.html</a> - winner home page</li>
<li><a
href="https://github.com/ioccc-src/temp-test-ioccc/blob/master/2001/anonymous/anonymous.c">anonymous.c</a>
- winning source</li>
<li><a
href="https://github.com/ioccc-src/temp-test-ioccc/blob/master/2001/anonymous/Makefile">Makefile</a>
- winner Makefile</li>
<li><a
href="https://github.com/ioccc-src/temp-test-ioccc/blob/master/2001/anonymous/anonymous.orig.c">anonymous.orig.c</a>
- original source</li>
<li><a
href="https://github.com/ioccc-src/temp-test-ioccc/blob/master/2001/anonymous/anonymous.bed.c">anonymous.bed.c</a>
- roll over song C source</li>
<li><a
href="https://github.com/ioccc-src/temp-test-ioccc/blob/master/2001/anonymous/anonymous.ten.c">anonymous.ten.c</a>
- green bottles song C source</li>
<li><a
href="https://github.com/ioccc-src/temp-test-ioccc/blob/master/2001/anonymous/try.sh">try.sh</a>
- how to run</li>
<li><a href="2001_anonymous.tar.bz2">2001_anonymous.tar.bz2</a> -
download winning source</li>
</ul>
<h2 id="secondary-files">Secondary files</h2>
<ul>
<li><a
href="https://github.com/ioccc-src/temp-test-ioccc/blob/master/2001/anonymous/.gitignore">.gitignore</a>
- list of files that should not be committed under git</li>
<li><a href=".path">.path</a> - directory path from top directory</li>
<li><a
href="https://github.com/ioccc-src/temp-test-ioccc/blob/master/2001/anonymous/.winner.json">.winner.json</a>
- description of winner in JSON</li>
<li><a
href="https://github.com/ioccc-src/temp-test-ioccc/blob/master/2001/anonymous/README.md">README.md</a>
- markdown source for index.html</li>
</ul>
<!-- END: next line ends content generated by: bin/gen-inventory.sh -->
<!-- START: this line starts content from: inc/after-content.default.html -->
<!-- END: this line ends content from: inc/after-content.default.html -->
<!-- START: this line starts content from: inc/end-rightcolumn.default.html -->
</div>
<!-- END: this line ends content from: inc/end-rightcolumn.default.html -->
<!-- START: this line starts content from: inc/end-row.default.html -->
</div>
<!-- END: this line ends content from: inc/end-row.default.html -->
<!-- START: this line starts content from: inc/footer.default.html -->
<div class="footer">
<hr>
<h2>Coda</h2>
<p><a href="https://validator.w3.org/nu/?doc=https%3A%2F%2Fioccc-src.github.io%2Ftemp-test-ioccc%2F2001%2Fanonymous%2Findex.html">Nu HTML check this web page</a></p>
<p><a href="#top">Jump to top</a> <a href="#content">Jump to Content</a> <a href="#inventory">Jump to Inventory</a></p>
</div>
<!-- END: this line ends content from: inc/footer.default.html -->
<!-- START: this line starts content from: inc/bottom.default.html -->
</body>
</html>
<!-- END: this line ends content from: inc/bottom.default.html -->