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