interpreters/git/README.txt

   1 Git is an interpreter for the Glulx virtual machine. Its homepage is here:\r
   2 \r
   3 http://ifarchive.org/indexes/if-archiveXprogrammingXglulxXinterpretersXgit.html\r
   4 \r
   5 Git's main goal in life is to be fast. It's about five times faster than Glulxe,\r
   6 and about twice as fast as Frotz (using the same Inform source compiled for the\r
   7 Z-machine). It also tries to be reasonably careful with memory: it's possible to\r
   8 trade speed off against memory by changing the sizes of Git's internal buffers.\r
   9 \r
  10 I wrote Git because I want people to be able to write huge games or try out\r
  11 complicated algorithms without worrying about how fast their games are going to\r
  12 run. I want to play City of Secrets on a Palm without having to wait ten seconds\r
  13 between each prompt.\r
  14 \r
  15 Have fun, and let me know what you think!\r
  16 \r
  17   Iain Merrick (Original author)\r
  18   iain@diden.net\r
  19 \r
  20   David Kinder (Current maintainer)\r
  21   davidk.kinder@virgin.net\r
  22 \r
  23 --------------------------------------------------------------------------------\r
  24 \r
  25 * Building and installing Git\r
  26 \r
  27 This is just source code, not a usable application. You'll have to do a bit of\r
  28 work before you can start playing games with it. If you're not confident about\r
  29 compiling stuff yourself, you probably want to wait until somebody uploads a\r
  30 compiled version of Git for your own platform.\r
  31 \r
  32 Git needs to be linked with a Glk library in order to run. This can be easy or\r
  33 hard, depending on what kind of computer you're using and whether you want Git\r
  34 to be able to display graphics and play sounds. To find a suitable Glk library,\r
  35 look here:\r
  36 \r
  37 http://eblong.com/zarf/glk/\r
  38 http://ifarchive.org/indexes/if-archiveXprogrammingXglkXimplementations.html\r
  39 \r
  40 Exactly how you build and link everything depends on what platform you're on and\r
  41 which Glk library you're using. The supplied Makefile should work on any Unix\r
  42 machine (including Macs with OS X), but you'll probably want to tweak it to\r
  43 account for your particular setup. If you're not using Unix, I'm afraid you'll\r
  44 have to play it by ear. If the Glk library you chose comes with instructions,\r
  45 that's probably a good place to start.\r
  46 \r
  47 On Unix, git_unix.c contains the startup code required by the Glk library.\r
  48 git_mac.c and git_windows.c contain startup code for MacGlk and WinGlk\r
  49 respectively, but I can't guarantee that they're fully up-to-date.\r
  50 \r
  51 It should be possible to build Git with any C compiler, but it works best with\r
  52 GCC, because that has a non-standard extension that Git can use for a big speed\r
  53 boost. GCC 2.95 actually generates faster code than later versions, so if you\r
  54 have a choice, use the former. (On OS X, this means compiling with 'gcc2'.)\r
  55 \r
  56 --------------------------------------------------------------------------------\r
  57 \r
  58 * Configuring Git\r
  59 \r
  60 There are several configuration options you can use when compiling Git. Have a\r
  61 look at config.h and see which ones look applicable to your platform. The\r
  62 Makefile includes settings to configure Git for maximum speed on Mac OS X; the\r
  63 best settings for other Unix platforms should be similar.\r
  64 \r
  65 The most important setting is USE_DIRECT_THREADING, which makes the interpreter\r
  66 engine use GCC's labels-as-values extension, but this only works with GCC 2.95.\r
  67 \r
  68 --------------------------------------------------------------------------------\r
  69 \r
  70 * Porting to a new platform\r
  71 \r
  72 To do a new port, you first need to find a suitable Glk library, or write a new\r
  73 one. Then you need to write the startup code. Start with a copy of git_unix.c,\r
  74 git_mac.c or git_windows.c and modify it appropriately.\r
  75 \r
  76 The startup code needs to implement the following functions:\r
  77 \r
  78   void glk_main()                 // Standard Glk entrypoint\r
  79   void fatalError(const char* s)  // Display error message and quit\r
  80 \r
  81 In glk_main(), you need to locate the game file somehow. Then you have two\r
  82 options. You can open the game as a Glk stream and pass it to this function:\r
  83 \r
  84   extern void gitWithStream (strid_t stream,\r
  85                              git_uint32 cacheSize,\r
  86                              git_uint32 undoSize);\r
  87 \r
  88 Or you can load the game yourself, and just pass Git a pointer to your buffer:\r
  89 \r
  90   extern void git (const git_uint8 * game,\r
  91                    git_uint32 gameSize,\r
  92                    git_uint32 cacheSize,\r
  93                    git_uint32 undoSize);\r
  94 \r
  95 If the operating system provides some way of memory-mapping files (such as\r
  96 Unix's mmap() system call), you should do that and call git(), because it will\r
  97 allow the game to start up much more quickly. If you can't do memory-mapping,\r
  98 you should just open the game as a file stream and call gitWithStream(). Note\r
  99 that some Glk libraries, such as xglk, aren't compatible with memory-mapped\r
 100 files.\r
 101 \r
 102 "cacheSize" and "undoSize" tell Git what size to use for its two main internal\r
 103 buffers. Both sizes are in bytes. You may want to make these values\r
 104 user-configurable, or you may just want to pick values that make sense for your\r
 105 platform and use those. (My Unix version currently uses fixed values, but I'm\r
 106 going to add some optional command-line parameters to override these defaults.)\r
 107 \r
 108 "cacheSize" is the size of the buffer used to store Glulx code that Git has\r
 109 recompiled into its internal format. Git will run faster with a larger buffer,\r
 110 but using a huge buffer is just a waste of memory; 256KB is plenty.\r
 111 \r
 112 "undoSize" is the maximum amount of memory used to remember previous moves. The\r
 113 larger you make it, the more levels of undo will be available. The amount of\r
 114 memory required to remember one undo position varies from a few KB up to tens of\r
 115 KB. 256KB is usually enough to store dozens of moves.\r
 116 \r
 117 --------------------------------------------------------------------------------\r
 118 \r
 119 * Known problems\r
 120 \r
 121 GCC 3 has bigger problems than I thought. On PowerPC, the direct threading\r
 122 option results in much slower code; and on x86, terp.c crashes GCC itself if\r
 123 direct threading is used. GCC 4 seems to work, given some very limited testing,\r
 124 but still results in slow code. Therefore, I recommend that you use GCC 2.95 if\r
 125 possible. If you only have GCC 3, don't define USE_DIRECT_THREADING.\r
 126 \r
 127 Some Glk libraries, such as xglk, can't deal with memory-mapped files. You can\r
 128 tell that this is happening if Git can open .ulx files, but complains that .blb\r
 129 files are invalid. The solution is to use gitWithStream() rather than git() in\r
 130 your startup file, and make sure you're giving it a file stream rather than a\r
 131 memory stream. If you're using the git_unix.c startup file, just make sure\r
 132 USE_MMAP isn't defined.\r
 133 \r
 134 1-byte and 2-byte local variables are not implemented. This means git can't\r
 135 play games created with old versions of the Superglus system. As these small\r
 136 local variables now deprecated, it is unlikely that this will be fixed.\r
 137 \r
 138 In the search opcodes, direct keys don't work unless they're exactly 4 bytes\r
 139 long.\r
 140 \r
 141 --------------------------------------------------------------------------------\r
 142 \r
 143 * Copyright information\r
 144 \r
 145 Note: previous versions of Git used an informal freeware license, but I've\r
 146 decided it's worth formalising. As of version 1.2.3, I've switched to the\r
 147 MIT license.\r
 148 \r
 149 Copyright (c) 2003 Iain Merrick\r
 150 \r
 151 Permission is hereby granted, free of charge, to any person obtaining a copy of\r
 152 this software and associated documentation files (the "Software"), to deal in\r
 153 the Software without restriction, including without limitation the rights to\r
 154 use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of\r
 155 the Software, and to permit persons to whom the Software is furnished to do so,\r
 156 subject to the following conditions:\r
 157 \r
 158 The above copyright notice and this permission notice shall be included in all\r
 159 copies or substantial portions of the Software.\r
 160 \r
 161 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r
 162 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\r
 163 FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\r
 164 COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\r
 165 IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\r
 166 CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\r
 167 \r
 168 --------------------------------------------------------------------------------\r
 169 \r
 170 * Credits\r
 171 \r
 172 Andrew Plotkin invented Glulx, so obviously Git wouldn't exist without him. I\r
 173 also reused some code from his Glulxe interpreter (glkop.c and search.c), which\r
 174 saved me a lot of time and let me concentrate on the more interesting stuff.\r
 175 \r
 176 Many thanks are due to John Cater, who not only persuaded me to use source\r
 177 control, but let me use his own CVS server. John also provided lots of useful\r
 178 advice and encouragement, as did Sean Barrett.\r
 179 \r
 180 Thanks also to Joe Mason, Adam Thornton, Simon Baldwin and Joonas Pihlaja who\r
 181 were among the first to try it out and complain that it wasn't working. Joonas\r
 182 also gets special brownie points for trying out more bizarre boundary cases than\r
 183 I realised existed in the first place.\r
 184 \r
 185 Tor Andersson was apparently the first person to use setmemsize, since he also\r
 186 explained why it didn't work and contributed a fix. Thanks, Tor!\r
 187 \r
 188 David Kinder has done a stellar job of maintaining the code recently. Thanks\r
 189 also to Eliuk Blau for tracking down bugs in the memory management opcodes.\r
 190 \r
 191 --------------------------------------------------------------------------------\r
 192 \r
 193 * Version History\r
 194 \r
 195 1.2.9 2011-08-28  Fixed a bug in glkop.c dispatching, to do with optional\r
 196                   array arguments, following a similar fix in Glulxe.\r
 197                   Glk array and string operations are now checked for memory\r
 198                   overflows (though not for ROM writing), following a similar\r
 199                   fix in Glulxe.\r
 200 \r
 201 1.2.8 2010-08-25  Fixed a problem with 'undo' when compiled as 64 bit,\r
 202                   contributed by Ben Cressey.\r
 203                   Fixed a sign problem for the @fceil opcode, following a\r
 204                   similar fix in Glulxe.\r
 205 \r
 206 1.2.7 2010-08-20  Floating point opcode support (VM spec 3.1.2).\r
 207                   Restart does not now discard undo information, so that a\r
 208                   restart can be undone.\r
 209 \r
 210 1.2.6 2010-02-09  Imported fix for retained Glk array handling from Glulxe.\r
 211 \r
 212 1.2.5 2009-11-21  Fixes for problems shown by Andrew Plotkin's glulxercise test\r
 213                   cases, from David Kinder.\r
 214 \r
 215 1.2.4 2009-04-02  More David Kinder! Accelerated opcode support (VM spec 3.1.1).\r
 216 \r
 217 1.2.3 2009-02-22  David Kinder and Eliuk Blau fixed some memory management bugs.\r
 218                   Added a regression test (thanks to Emily Short for assistance)\r
 219                   Switched to MIT-style license (see above).\r
 220 \r
 221 1.2.2 2009-01-21  malloc & mfree contributed by the most excellent David Kinder.\r
 222 \r
 223 1.2.1 2008-09-14  Support for 64-bit machines, contributed by Alexander Beels.\r
 224                   Fix for crashing bug in RESTORE, contributed by David Kinder.\r
 225                   Non-Unicode display bug fix, contributed by Jeremy Bernstein.\r
 226 \r
 227 1.2   2008-01-06  Minor version increment for VM spec 3.1.\r
 228                   Implemented mzero and mcopy, but not malloc and mfree (yet).\r
 229 \r
 230 1.1.3 2006-10-04  Fixed a bug in the cache logic that broke the game Floatpoint.\r
 231                   Added some other caching tweaks and put in a few more asserts.\r
 232 \r
 233 1.1.2 2006-08-22  streamnum in filter I/O mode no longer prints a garbage char.\r
 234                   Merged in David Kinder's updated Windows startup code.\r
 235                   \r
 236 1.1.1 2006-08-17  Wow, over a year since the last update.\r
 237                   Rolled in Tor Andersson's fix for setmemsize.\r
 238 \r
 239 1.1   2004-12-22  Minor version increment because we now implement VM spec 3.0.\r
 240                   Implemented new Unicode opcodes and string types.\r
 241 \r
 242 1.0.6 2004-12-10  Random number generator now handles random(0) correctly.\r
 243                   Code cache now tracks the number of function calls properly.\r
 244                   Fixed a bug that could hang the terp when the cache filled up.\r
 245 \r
 246 1.0.5 2004-05-31  Random number generator is now initialised properly.\r
 247                   Some source files had Mac line-endings, now fixed.\r
 248                   Version number is now set in the Makefile, not in git.h.\r
 249                   Merged David Kinder's Windows Git code into main distribution.\r
 250 \r
 251 1.0.4 2004-03-13  Fixed a silly bug in direct threading mode that broke stkroll.\r
 252                   Memory access bounds checking has been tightened up slightly.\r
 253                   aload and astore now work correctly with negative offsets.\r
 254                   Rewrote the shift opcodes a bit more defensively.\r
 255                   Implemented the "verify" opcode.\r
 256                   Code in RAM is no longer cached by default.\r
 257                   Adding some special opcodes to control the code cache.\r
 258                   Bad instructions are now caught in the terp, not the compiler.\r
 259                   Now passes all of Joonas' indirect string decoding tests.\r
 260                   \r
 261 1.0.3 2004-01-22  No longer hangs when using streamnum in the "filter" I/O mode.\r
 262                   setstringtbl opcode now works correctly.\r
 263 \r
 264 1.0.2 2003-10-25  Stupid bug in 1.0.1 -- gitWithStream() was broken and wasn't\r
 265                   able to load Blorb files. Now it's *really* fixed.\r
 266 \r
 267 1.0.1 2003-10-23  Fixed a bug where strings were printed as "[string]"\r
 268                   Fixed a bug in tailcall\r
 269                   Implemented setmemsize\r
 270                   Implemented protect\r
 271                   Moved git_init_dispatch() call out of startup code, into git.c\r
 272                   Added divide-by-zero check\r
 273                   Compiler now stops when it finds a 'quit' or 'restart'\r
 274                   Added gitWithStream() as a workaround for xglk\r
 275 \r
 276 1.0   2003-10-18  First public release\r
 277 \r