home *** CD-ROM | disk | FTP | other *** search
/ PC World 2003 May / PCWorld_2003-05_cd.bin / Komunik / apache / apache_2.0.45-win32-x86-no_ssl.msi / Data.Cab / F233012_ebcdic.xml < prev    next >
Extensible Markup Language  |  2002-11-16  |  18KB  |  563 lines
  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <!DOCTYPE manualpage SYSTEM "../style/manualpage.dtd">
  3. <?xml-stylesheet type="text/xsl" href="../style/manual.en.xsl"?>
  4.  
  5. <manualpage>
  6.   <relativepath href=".." />
  7.   <parentdocument href="./">Platform Specific Notes</parentdocument>
  8.  
  9.   <title>The Apache EBCDIC Port</title>
  10.  
  11.   <summary>
  12.  
  13.     <note type="warning"><strong>Warning:</strong> This document
  14.     has not been updated to take into account changes made in
  15.     the 2.0 version of the Apache HTTP Server. Some of the
  16.     information may still be relevant, but please use it with care.
  17.     </note>
  18.  
  19.   </summary>
  20.  
  21.   <section id="overview">
  22.  
  23.     <title>Overview of the Apache EBCDIC Port</title>
  24.  
  25.     <p>Version 1.3 of the Apache HTTP Server is the first version
  26.     which includes a port to a (non-ASCII) mainframe machine which
  27.     uses the EBCDIC character set as its native codeset.</p>
  28.  
  29.     <p>(It is the SIEMENS family of mainframes running the <a
  30.     href="http://www.siemens.de/servers/bs2osd/osdbc_us.htm">BS2000/OSD
  31.     operating system</a>. This mainframe OS nowadays features a
  32.     SVR4-derived POSIX subsystem).</p>
  33.  
  34.     <p>The port was started initially to</p>
  35.  
  36.     <ul>
  37.       <li>prove the feasibility of porting <a
  38.       href="http://dev.apache.org/">the Apache HTTP server</a> to
  39.       this platform</li>
  40.  
  41.       <li>find a "worthy and capable" successor for the venerable
  42.       <a href="http://www.w3.org/Daemon/">CERN-3.0</a> daemon
  43.       (which was ported a couple of years ago), and to</li>
  44.  
  45.       <li>prove that Apache's preforking process model can on this
  46.       platform easily outperform the accept-fork-serve model used
  47.       by CERN by a factor of 5 or more.</li>
  48.     </ul>
  49.  
  50.     <p>This document serves as a rationale to describe some of the
  51.     design decisions of the port to this machine.</p>
  52.  
  53.   </section>
  54.  
  55.   <section id="design">
  56.  
  57.     <title>Design Goals</title>
  58.  
  59.     <p>One objective of the EBCDIC port was to maintain enough
  60.     backwards compatibility with the (EBCDIC) CERN server to make
  61.     the transition to the new server attractive and easy. This
  62.     required the addition of a configurable method to define
  63.     whether a HTML document was stored in ASCII (the only format
  64.     accepted by the old server) or in EBCDIC (the native document
  65.     format in the POSIX subsystem, and therefore the only realistic
  66.     format in which the other POSIX tools like <code>grep</code> or
  67.     <code>sed</code> could operate on the documents). The current
  68.     solution to this is a "pseudo-MIME-format" which is intercepted
  69.     and interpreted by the Apache server (see below). Future versions
  70.     might solve the problem by defining an "ebcdic-handler" for all
  71.     documents which must be converted.</p>
  72.  
  73.   </section>
  74.  
  75.   <section id="technical">
  76.  
  77.     <title>Technical Solution</title>
  78.  
  79.     <p>Since all Apache input and output is based upon the BUFF
  80.     data type and its methods, the easiest solution was to add the
  81.     conversion to the BUFF handling routines. The conversion must
  82.     be settable at any time, so a BUFF flag was added which defines
  83.     whether a BUFF object has currently enabled conversion or not.
  84.     This flag is modified at several points in the HTTP
  85.     protocol:</p>
  86.  
  87.     <ul>
  88.       <li><strong>set</strong> before a request is received
  89.       (because the request and the request header lines are always
  90.       in ASCII format)</li>
  91.  
  92.       <li><strong>set/unset</strong> when the request body is
  93.       received - depending on the content type of the request body
  94.       (because the request body may contain ASCII text or a binary
  95.       file)</li>
  96.  
  97.       <li><strong>set</strong> before a reply header is sent
  98.       (because the response header lines are always in ASCII
  99.       format)</li>
  100.  
  101.       <li><strong>set/unset</strong> when the response body is sent
  102.       - depending on the content type of the response body (because
  103.       the response body may contain text or a binary file)</li>
  104.     </ul>
  105.  
  106.   </section>
  107.  
  108.   <section id="porting">
  109.  
  110.     <title>Porting Notes</title>
  111.  
  112.     <ol>
  113.       <li>
  114.         <p>The relevant changes in the source are <code>#ifdef</code>'ed
  115.         into two categories:</p>
  116.  
  117.         <dl>
  118.           <dt><code><strong>#ifdef
  119.           CHARSET_EBCDIC</strong></code></dt>
  120.  
  121.           <dd>
  122.             <p>Code which is needed for any EBCDIC based machine.
  123.             This includes character translations, differences in
  124.             contiguity of the two character sets, flags which
  125.             indicate which part of the HTTP protocol has to be
  126.             converted and which part doesn't <em>etc.</em></p>
  127.           </dd>
  128.  
  129.           <dt><code><strong>#ifdef _OSD_POSIX</strong></code></dt>
  130.  
  131.           <dd>
  132.             <p>Code which is needed for the SIEMENS BS2000/OSD
  133.             mainframe platform only. This deals with include file
  134.             differences and socket implementation topics which are
  135.             only required on the BS2000/OSD platform.</p>
  136.           </dd>
  137.         </dl>
  138.       </li>
  139.  
  140.       <li>
  141.         <p>The possibility to translate between ASCII and EBCDIC at
  142.         the socket level (on BS2000 POSIX, there is a socket option
  143.         which supports this) was intentionally <em>not</em> chosen,
  144.         because the byte stream at the HTTP protocol level consists
  145.         of a mixture of protocol related strings and non-protocol
  146.         related raw file data. HTTP protocol strings are always
  147.         encoded in ASCII (the <code>GET</code> request, any Header: lines,
  148.         the chunking information <em>etc.</em>) whereas the file transfer
  149.         parts (<em>i.e.</em>, GIF images, CGI output <em>etc.</em>)
  150.         should usually be just "passed through" by the server. This
  151.         separation between "protocol string" and "raw data" is
  152.         reflected in the server code by functions like <code>bgets()</code>
  153.         or <code>rvputs()</code> for strings, and functions like
  154.         <code>bwrite()</code> for binary data. A global translation
  155.         of everything would therefore be inadequate.</p>
  156.  
  157.         <p>(In the case of text files of course, provisions must be
  158.         made so that EBCDIC documents are always served in
  159.         ASCII)</p>
  160.       </li>
  161.  
  162.       <li>
  163.         <p>This port therefore features a built-in protocol level
  164.         conversion for the server-internal strings (which the
  165.         compiler translated to EBCDIC strings) and thus for all
  166.         server-generated documents. The hard coded ASCII escapes
  167.         <code>\012</code> and <code>\015</code> which are ubiquitous
  168.         in the server code are an exception: they are already the binary
  169.         encoding of the ASCII <code>\n</code> and <code>\r</code> and
  170.         must not be converted to ASCII a second time.
  171.         This exception is only relevant for server-generated strings;
  172.         and <em>external</em> EBCDIC documents are not expected to
  173.         contain ASCII newline characters.</p>
  174.       </li>
  175.  
  176.       <li>
  177.         <p>By examining the call hierarchy for the BUFF management
  178.         routines, I added an "ebcdic/ascii conversion layer" which
  179.         would be crossed on every puts/write/get/gets, and a
  180.         conversion flag which allowed enabling/disabling the
  181.         conversions on-the-fly. Usually, a document crosses this
  182.         layer twice from its origin source (a file or CGI output) to
  183.         its destination (the requesting client): <code>file ->
  184.         Apache</code>, and <code>Apache -> client</code>.</p>
  185.  
  186.         <p>The server can now read the header lines of a CGI-script
  187.         output in EBCDIC format, and then find out that the remainder
  188.         of the script's output is in ASCII (like in the case of the
  189.         output of a WWW Counter program: the document body contains a
  190.         GIF image). All header processing is done in the native
  191.         EBCDIC format; the server then determines, based on the type
  192.         of document being served, whether the document body (except
  193.         for the chunking information, of course) is in ASCII already
  194.         or must be converted from EBCDIC.</p>
  195.       </li>
  196.  
  197.       <li>
  198.         <p>For Text documents (MIME types text/plain, text/html
  199.         <em>etc.</em>), an implicit translation to ASCII can be
  200.         used, or (if the users prefer to store some documents in
  201.         raw ASCII form for faster serving, or because the files
  202.         reside on a NFS-mounted directory tree) can be served
  203.         without conversion.</p>
  204.  
  205.         <p><strong>Example:</strong></p>
  206.  
  207.         <p>to serve files with the suffix <code>.ahtml</code> as a
  208.         raw ASCII <code>text/html</code> document without implicit
  209.         conversion (and suffix <code>.ascii</code> as ASCII
  210.         <code>text/plain</code>), use the directives:</p>
  211.  
  212.         <example>
  213.           AddType  text/x-ascii-html  .ahtml <br />
  214.           AddType  text/x-ascii-plain .ascii
  215.         </example>
  216.  
  217.         <p>Similarly, any <code>text/foo</code> MIME type can be
  218.         served as "raw ASCII" by configuring a MIME type
  219.         "<code>text/x-ascii-foo</code>" for it using
  220.         <code>AddType</code>.</p>
  221.       </li>
  222.  
  223.       <li>
  224.         <p>Non-text documents are always served "binary" without
  225.         conversion. This seems to be the most sensible choice for,
  226.         .<em>e.g.</em>, GIF/ZIP/AU file types. This of course
  227.         requires the user to copy them to the mainframe host using
  228.         the "<code>rcp -b</code>" binary switch.</p>
  229.       </li>
  230.  
  231.       <li>
  232.         <p>Server parsed files are always assumed to be in native
  233.         (<em>i.e.</em>, EBCDIC) format as used on the machine, and
  234.         are converted after processing.</p>
  235.       </li>
  236.  
  237.       <li>
  238.         <p>For CGI output, the CGI script determines whether a
  239.         conversion is needed or not: by setting the appropriate
  240.         Content-Type, text files can be converted, or GIF output can
  241.         be passed through unmodified. An example for the latter case
  242.         is the wwwcount program which we ported as well.</p>
  243.       </li>
  244.  
  245.     </ol>
  246.  
  247.   </section>
  248.  
  249.   <section id="document">
  250.  
  251.     <title>Document Storage Notes</title>
  252.  
  253.     <section id="binary">
  254.  
  255.       <title>Binary Files</title>
  256.  
  257.       <p>All files with a <code>Content-Type:</code> which does not
  258.       start with <code>text/</code> are regarded as <em>binary
  259.       files</em> by the server and are not subject to any conversion.
  260.       Examples for binary files are GIF images, gzip-compressed files
  261.       and the like.</p>
  262.  
  263.       <p>When exchanging binary files between the mainframe host and
  264.       a Unix machine or Windows PC, be sure to use the ftp "binary"
  265.       (<code>TYPE I</code>) command, or use the
  266.       <code>rcp -b</code> command from the mainframe host (the
  267.       <code>-b</code> switch is not supported in unix
  268.       <code>rcp</code>'s).</p>
  269.  
  270.     </section>
  271.  
  272.     <section id="text">
  273.  
  274.       <title>Text Documents</title>
  275.  
  276.       <p>The default assumption of the server is that Text Files
  277.       (<em>i.e.</em>, all files whose <code>Content-Type:</code>
  278.       starts with <code>text/</code>) are stored in the native
  279.       character set of the host, EBCDIC.</p>
  280.  
  281.     </section>
  282.  
  283.     <section id="ssi">
  284.  
  285.       <title>Server Side Included Documents</title>
  286.  
  287.       <p>SSI documents must currently be stored in EBCDIC only.
  288.       No provision is made to convert it from ASCII before
  289.       processing.</p>
  290.  
  291.     </section>
  292.  
  293.   </section>
  294.  
  295.   <section id="modules">
  296.  
  297.     <title>Apache Modules' Status</title>
  298.  
  299.     <table border="1">
  300.       <tr>
  301.         <th>Module</th>
  302.         <th>Status</th>
  303.         <th>Notes</th>
  304.       </tr>
  305.  
  306.       <tr>
  307.         <td><module>core</module></td>
  308.         <td class="centered">+</td>
  309.         <td></td>
  310.       </tr>
  311.  
  312.       <tr>
  313.         <td><module>mod_access</module></td>
  314.         <td class="centered">+</td>
  315.         <td></td>
  316.       </tr>
  317.  
  318.       <tr>
  319.         <td><module>mod_actions</module></td>
  320.         <td class="centered">+</td>
  321.         <td></td>
  322.       </tr>
  323.  
  324.       <tr>
  325.         <td><module>mod_alias</module></td>
  326.         <td class="centered">+</td>
  327.         <td></td>
  328.       </tr>
  329.  
  330.       <tr>
  331.         <td><module>mod_asis</module></td>
  332.         <td class="centered">+</td>
  333.         <td></td>
  334.       </tr>
  335.  
  336.       <tr>
  337.         <td><module>mod_auth</module></td>
  338.         <td class="centered">+</td>
  339.         <td></td>
  340.       </tr>
  341.  
  342.       <tr>
  343.         <td><module>mod_auth_anon</module></td>
  344.         <td class="centered">+</td>
  345.         <td></td>
  346.       </tr>
  347.  
  348.       <tr>
  349.         <td><module>mod_auth_dbm</module></td>
  350.         <td class="centered">?</td>
  351.         <td>with own <code>libdb.a</code></td>
  352.       </tr>
  353.  
  354.       <tr>
  355.         <td><module>mod_autoindex</module></td>
  356.         <td class="centered">+</td>
  357.         <td></td>
  358.       </tr>
  359.  
  360.       <tr>
  361.         <td><module>mod_cern_meta</module></td>
  362.         <td class="centered">?</td>
  363.         <td></td>
  364.       </tr>
  365.  
  366.       <tr>
  367.         <td><module>mod_cgi</module></td>
  368.         <td class="centered">+</td>
  369.         <td></td>
  370.       </tr>
  371.  
  372.       <tr>
  373.         <td><module>mod_digest</module></td>
  374.         <td class="centered">+</td>
  375.         <td></td>
  376.       </tr>
  377.  
  378.       <tr>
  379.         <td><module>mod_dir</module></td>
  380.         <td class="centered">+</td>
  381.         <td></td>
  382.       </tr>
  383.  
  384.       <tr>
  385.         <td><module>mod_so</module></td>
  386.         <td class="centered">-</td>
  387.         <td>no shared libs</td>
  388.       </tr>
  389.  
  390.       <tr>
  391.         <td><module>mod_env</module></td>
  392.         <td class="centered">+</td>
  393.         <td></td>
  394.       </tr>
  395.  
  396.       <tr>
  397.         <td><module>mod_example</module></td>
  398.         <td class="centered">-</td>
  399.         <td>(test bed only)</td>
  400.       </tr>
  401.  
  402.       <tr>
  403.         <td><module>mod_expires</module></td>
  404.         <td class="centered">+</td>
  405.         <td></td>
  406.       </tr>
  407.  
  408.       <tr>
  409.         <td><module>mod_headers</module></td>
  410.         <td class="centered">+</td>
  411.         <td></td>
  412.       </tr>
  413.  
  414.       <tr>
  415.         <td><module>mod_imap</module></td>
  416.         <td class="centered">+</td>
  417.         <td></td>
  418.       </tr>
  419.  
  420.       <tr>
  421.         <td><module>mod_include</module></td>
  422.         <td class="centered">+</td>
  423.         <td></td>
  424.       </tr>
  425.  
  426.       <tr>
  427.         <td><module>mod_info</module></td>
  428.         <td class="centered">+</td>
  429.         <td></td>
  430.       </tr>
  431.  
  432.       <tr>
  433.         <td><module>mod_log_agent</module></td>
  434.         <td class="centered">+</td>
  435.         <td></td>
  436.       </tr>
  437.  
  438.       <tr>
  439.         <td><module>mod_log_config</module></td>
  440.         <td class="centered">+</td>
  441.         <td></td>
  442.       </tr>
  443.  
  444.       <tr>
  445.         <td><module>mod_log_referer</module></td>
  446.         <td class="centered">+</td>
  447.         <td></td>
  448.       </tr>
  449.  
  450.       <tr>
  451.         <td><module>mod_mime</module></td>
  452.         <td class="centered">+</td>
  453.         <td></td>
  454.       </tr>
  455.  
  456.       <tr>
  457.         <td><module>mod_mime_magic</module></td>
  458.         <td class="centered">?</td>
  459.         <td>not ported yet</td>
  460.       </tr>
  461.  
  462.       <tr>
  463.         <td><module>mod_negotiation</module></td>
  464.         <td class="centered">+</td>
  465.         <td></td>
  466.       </tr>
  467.  
  468.       <tr>
  469.         <td><module>mod_proxy</module></td>
  470.         <td class="centered">+</td>
  471.         <td></td>
  472.       </tr>
  473.  
  474.       <tr>
  475.         <td><module>mod_rewrite</module></td>
  476.         <td class="centered">+</td>
  477.         <td>untested</td>
  478.       </tr>
  479.  
  480.       <tr>
  481.         <td><module>mod_setenvif</module></td>
  482.         <td class="centered">+</td>
  483.         <td></td>
  484.       </tr>
  485.  
  486.       <tr>
  487.         <td><module>mod_speling</module></td>
  488.         <td class="centered">+</td>
  489.         <td></td>
  490.       </tr>
  491.  
  492.       <tr>
  493.         <td><module>mod_status</module></td>
  494.         <td class="centered">+</td>
  495.         <td></td>
  496.       </tr>
  497.  
  498.       <tr>
  499.         <td><module>mod_unique_id</module></td>
  500.         <td class="centered">+</td>
  501.         <td></td>
  502.       </tr>
  503.  
  504.       <tr>
  505.         <td><module>mod_userdir</module></td>
  506.         <td class="centered">+</td>
  507.         <td></td>
  508.       </tr>
  509.  
  510.       <tr>
  511.         <td><module>mod_usertrack</module></td>
  512.         <td class="centered">?</td>
  513.         <td>untested</td>
  514.       </tr>
  515.     </table>
  516.  
  517.   </section>
  518.  
  519.   <section id="third-party">
  520.  
  521.     <title>Third Party Modules' Status</title>
  522.  
  523.     <table border="1">
  524.       <tr>
  525.         <th>Module</th>
  526.         <th>Status</th>
  527.         <th>Notes</th>
  528.       </tr>
  529.  
  530.       <tr>
  531.         <td><code><a href="http://java.apache.org/">mod_jserv</a>
  532.         </code></td>
  533.         <td class="centered">-</td>
  534.         <td>JAVA still being ported.</td>
  535.       </tr>
  536.  
  537.       <tr>
  538.         <td><code><a href="http://www.php.net/">mod_php3</a></code></td>
  539.         <td class="centered">+</td>
  540.         <td><code>mod_php3</code> runs fine, with LDAP and GD
  541.         and FreeType libraries.</td>
  542.       </tr>
  543.  
  544.       <tr>
  545.         <td><code><a
  546.         href="http://hpwww.ec-lyon.fr/~vincent/apache/mod_put.html"
  547.         >mod_put</a></code></td>
  548.         <td class="centered">?</td>
  549.         <td>untested</td>
  550.       </tr>
  551.  
  552.       <tr>
  553.         <td><code><a href="ftp://hachiman.vidya.com/pub/apache/"
  554.         >mod_session</a></code></td>
  555.         <td class="centered">-</td>
  556.         <td>untested</td>
  557.       </tr>
  558.     </table>
  559.  
  560.   </section>
  561.  
  562. </manualpage>
  563.