view etc/gnuserv.README @ 4921:17362f371cc2

add more byte-code assertions and better failure output -------------------- ChangeLog entries follow: -------------------- src/ChangeLog addition: 2010-02-03 Ben Wing <ben@xemacs.org> * alloc.c (Fmake_byte_code): * bytecode.h: * lisp.h: * lread.c: * lread.c (readevalloop): * lread.c (Fread): * lread.c (Fread_from_string): * lread.c (read_list_conser): * lread.c (read_list): * lread.c (vars_of_lread): * symbols.c: * symbols.c (Fdefine_function): Turn on the "compiled-function annotation hack". Implement it properly by hooking into Fdefalias(). Note in the docstring to `defalias' that we do this. Remove some old broken code and change code that implemented the old kludgy way of hooking into the Lisp reader into bracketed by `#ifdef COMPILED_FUNCTION_ANNOTATION_HACK_OLD_WAY', which is not enabled. Also enable byte-code metering when DEBUG_XEMACS -- this is a form of profiling for computing histograms of which sequences of two bytecodes are used most often. * bytecode-ops.h: * bytecode-ops.h (OPCODE): New file. Extract out all the opcodes and declare them using OPCODE(), a bit like frame slots and such. This way the file can be included multiple times if necessary to iterate multiple times over the byte opcodes. * bytecode.c: * bytecode.c (NUM_REMEMBERED_BYTE_OPS): * bytecode.c (OPCODE): * bytecode.c (assert_failed_with_remembered_ops): * bytecode.c (READ_UINT_2): * bytecode.c (READ_INT_1): * bytecode.c (READ_INT_2): * bytecode.c (PEEK_INT_1): * bytecode.c (PEEK_INT_2): * bytecode.c (JUMP_RELATIVE): * bytecode.c (JUMP_NEXT): * bytecode.c (PUSH): * bytecode.c (POP_WITH_MULTIPLE_VALUES): * bytecode.c (DISCARD): * bytecode.c (UNUSED): * bytecode.c (optimize_byte_code): * bytecode.c (optimize_compiled_function): * bytecode.c (Fbyte_code): * bytecode.c (vars_of_bytecode): * bytecode.c (init_opcode_table_multi_op): * bytecode.c (reinit_vars_of_bytecode): * emacs.c (main_1): * eval.c (funcall_compiled_function): * symsinit.h: Any time we change either the instruction pointer or the stack pointer, assert that we're going to move it to a valid location. This should catch failures right when they occur rather than sometime later. This requires that we pass in another couple of parameters into some functions (only with error-checking enabled, see below). Also keep track, using a circular queue, of the last 100 byte opcodes seen, and when we hit an assert failure during byte-code execution, output the contents of the queue in a nice readable fashion. This requires that bytecode-ops.h be included a second time so that a table mapping opcodes to the name of their operation can be constructed. This table is constructed in new function reinit_vars_of_bytecode(). Everything in the last two paras happens only when ERROR_CHECK_BYTE_CODE. Add some longish comments describing how the arrays that hold the stack and instructions, and the pointers used to access them, work. * gc.c: Import some code from my `latest-fix' workspace to mark the staticpro's in order from lowest to highest, rather than highest to lowest, so it's easier to debug when something goes wrong. * lisp.h (abort_with_message): Renamed from abort_with_msg(). * symbols.c (defsymbol_massage_name_1): * symbols.c (defsymbol_nodump): * symbols.c (defsymbol): * symbols.c (defkeyword): * symeval.h (DEFVAR_SYMVAL_FWD_OBJECT): Make the various calls to staticpro() instead call staticpro_1(), passing in the name of the C var being staticpro'ed, so that it shows up in staticpro_names. Otherwise staticpro_names just has 1000+ copies of the word `location'.
author Ben Wing <ben@xemacs.org>
date Wed, 03 Feb 2010 08:01:55 -0600
parents 807b51903ed4
children 73eef12660cd
line wrap: on
line source

**** WARNING ****
This file was never meant to be proper documentation, and now is bitrotted.
See the file gnuserv.1 and/or the sources for more information.

****
NOTE: This version of gnuserv has some enhancements over the original version 
  distributed by Andy Norman. See the end of this file for more details. 
****

To install, copy gnuserv.el into a directory on your GNU Emacs
load-path. Edit Makefile and change INCLUDES to point to the src
directory underneath your emacs source tree (or make yourself a
config.h file in this directory by hand, starting with config.h.proto
as a first cut) and type:

     make

This should compile the server and the two clients. Now put gnuserv,
gnuclient and gnudoit in a directory that users have in their executable
search paths.

File                    : Description
----------------------------------------------------------------
Makefile		: Makefile to build gnuserv
LICENSE			: GNU General License
README			: this file
gnuclient.c		: editor client C code
gnudoit.c		: eval client C code
gnuserv.1		: gnuserv man page
gnuserv.c		: server C code
gnuserv.el		: server LISP code for GNU Emacs V18,V19, 
                          XEmacs/Lucid Emacs and Epoch V4
gnuserv.h		: server/client C header file
gnuslib.c		: server/client C common code
src.x11fns.diff		: diffs to src/x11fns to raise window (for emacs18)

config.h.proto          : Use this file as the starting point for constructing
                          a config.h if you don't have access to the
                          one that was used when compiling your emacs. 

If you find *any* problems at all with gnuserv, or you can think of better
ways of doing things (especially remote file access), please e-mail me at one
of the addresses below.

ange@hplb.hpl.hp.com
ange@hpl.hp.co.uk
...!hplabs!hplb!ange
...!ukc!hplb!ange



This version of gnuserv has been enhanced by a number of people, including
Bob Weiner <weiner@mot.com>, Darrell Kindred <dkindred@cmu.edu>,
Arup Mukherjee <arup@cmu.edu>, and Ben Wing <ben@xemacs.org>. The
modifications are basically as follows:

Bob Weiner: 

     Integrated support for several versions of emacs. New requests
     from gnuclient cause the creation of new frames. Removed the
     restriction on the length of the string passed to gnudoit. Later
     added a server-done-function variable to control what happens to
     a buffer after the user is done with it. Mods to each of the .c
     files as well as gnuserv.el.

Darrell Kindred:

     Removed the restriction on the length of the string returned from
     a gnudoit request, for the purposes of unix/internet sockets.
     Allow the gnudoit request to be read from stdin if it's not
     specified on the command line. Internet sockets are not opened
     unless the GNU_SECURE variable is specified. Unix sockets are
     created in a protected ancestral directory, since many Unix
     variants don't enforce socket permissions properly. An internet
     socket accepting local connections is not opened by default
     because this would make it possibly to override all security on
     the unix socket. See the man page for details. Unless told to do
     otherwise by a command-line argument, gnuclient and gnudoit now
     try to open a unix socket by default if support for them was
     compiled in.  Mods to each of the .c files and to gnuserv.el.

Arup Mukherjee:
     Removed the restriction on the length of the string returned from
     a gnudoit request, for the purposes of sysv ipc. Added support
     for the "gnuserv-frame" variable allowing you to specify control
     whether or not new screens are created in response to each
     gnuclient request. Made a number of other bugfixes and changes to
     the lisp part of the code, allowing gnuserv to work properly with
     newer emacs versions. All the changes are listed in the changelog
     at the beginning of gnuserv.el. Also fixed up the man page to
     reflect the new gnuserv features. On HPs, stopped the "-r"
     parameter (in gnuclient) from defaulting to /net/<remotehost>.
     Not all installations want this, and it's much harder to debug
     when things stop working. Changed the man page to reflect this.
     Mods to each of the .c files, gnuserv.el and gnuserv.1

     More recently - added Xauth(1X11)-style authentication to gnuserv (as 
     of version 2.1). Although the code is completely new, credit is
     due to Richard Caley <rjc@cogsci.edinburgh.ac.uk> ... he wrote a
     prototype implementation from which I borrowed the basic
     mechanism for hooking Xauth into gnuserv. 

Ben Wing:
     Added gnuattach.