Update documentation with replacement of driver with nif

4 files changed, 41 insertions, 109 deletions

diff --git a/lib/asn1/doc/src/asn1_spec.xmlsrc b/lib/asn1/doc/src/asn1_spec.xmlsrc
index 8d61834da8..07cba17816 100644
--- a/lib/asn1/doc/src/asn1_spec.xmlsrc
+++ b/lib/asn1/doc/src/asn1_spec.xmlsrc
@@ -4,7 +4,7 @@
 <chapter>
   <header>
     <copyright>
-      <year>2003</year><year>2009</year>
+      <year>2003</year><year>2011</year>
       <holder>Ericsson AB. All Rights Reserved.</holder>
     </copyright>
     <legalnotice>
@@ -43,7 +43,7 @@
   <p>So far this functionality is only provided when using the
     optimized BER_BIN version, that is when compiling with the
     options <c>ber_bin</c> and <c>optimize</c>. It does also work
-    using the <c>driver</c> option. We have no intent to make this
+    using the <c>nif</c> option. We have no intent to make this
     available on the default BER version, but maybe in the PER_BIN
     version (<c>per_bin</c>).
     </p>
@@ -661,7 +661,9 @@ ValAction = {'Action',17,{'Button',4711,false}}.
       <p>The ASN.1 specs in the test are compiled with the options
         <c>ber_bin, optimize, driver</c> and <c>asn1config</c>. If the
         <c>driver</c> option had been omitted there should have been
-        higher values for <c>decode</c> and <c>decode_part</c>.
+        higher values for <c>decode</c> and <c>decode_part</c>. These tests have
+	not been re-run using nifs, but are expected to perform about 5% better
+	than the linked-in driver.
         </p>
       <p>The test program runs 10000 decodes on the value, resulting
         in a printout with the elapsed time in microseconds for the
diff --git a/lib/asn1/doc/src/asn1_ug.xml b/lib/asn1/doc/src/asn1_ug.xml
index 6d9532a475..f5ff4dc2f2 100644
--- a/lib/asn1/doc/src/asn1_ug.xml
+++ b/lib/asn1/doc/src/asn1_ug.xml
@@ -347,7 +347,7 @@ erlc -o ../asnfiles -I ../asnfiles -I /usr/local/standards/asn1 Person.asn
           <p>This flag has effect only when used together with one of
             <c>per_bin</c> or <c>ber_bin</c> flags. It gives time optimized
             code in the generated modules and it uses another runtime module.
-            In the <c>per_bin</c> case a linked-in driver is used. The
+            In the <c>per_bin</c> case a nif is used. The
             result from an encode is a binary.</p>
           <p><em>When this flag is used you cannot use the old format</em><c>{TypeName,Value}</c> when you encode values. Since it is
             an unnecessary construct it has been removed in favor of
@@ -362,15 +362,14 @@ erlc -o ../asnfiles -I ../asnfiles -I /usr/local/standards/asn1 Person.asn
         </item>
         <tag><c>+driver</c></tag>
         <item>
-          <p>Together with the flags <c>ber_bin</c> and <c>optimize</c>
-            you choose to use a linked in driver for considerable faster
-            decode.</p>
+           <p>As of R15B this means the same as the <c>nif</c> option. Kept for
+	    backwards compatability reasons.</p>
         </item>
 	<tag><c>+nif</c></tag>
         <item>
-          <p>Together with the flags <c>per_bin</c> or <c>ber_bin</c>
+          <p>Together with the flags <c>ber_bin</c>
 	  and <c>optimize</c> you choose to use a nif for considerable
-	  faster per encode and ber decode. </p>
+	  faster decode. </p>
         </item>
         <tag><c>+asn1config</c></tag>
         <item>
@@ -498,7 +497,7 @@ asn1ct:decode('H323-MESSAGES','SomeChoiceType',Bytes).      </pre>
       </row>
       <row>
         <cell align="left" valign="middle">BER</cell>
-        <cell align="left" valign="middle"><em>[ber_bin, optimize, driver]</em></cell>
+        <cell align="left" valign="middle"><em>[ber_bin, optimize, nif]</em></cell>
         <cell align="left" valign="middle">EAVF</cell>
         <cell align="left" valign="middle">iolist</cell>
         <cell align="left" valign="middle">iolist / binary</cell>
@@ -563,7 +562,7 @@ asn1ct:decode('H323-MESSAGES','SomeChoiceType',Bytes).      </pre>
       </row>
       <row>
         <cell align="left" valign="middle">DER</cell>
-        <cell align="left" valign="middle"><em>[ber_bin, optimize, driver, der]</em></cell>
+        <cell align="left" valign="middle"><em>[ber_bin, optimize, nif, der]</em></cell>
         <cell align="left" valign="middle">EAVF</cell>
         <cell align="left" valign="middle">iolist</cell>
         <cell align="left" valign="middle">binary</cell>
@@ -632,23 +631,24 @@ asn1ct:decode('H323-MESSAGES','SomeChoiceType',Bytes).      </pre>
     </table>
 
     <p>
-      The sole compile options <c>ber</c>, <c>ber_bin</c> and <c>per</c>
-      are kept for backwards compatibility and should not be used in
-      new code.
+      The sole compile options <c>ber</c>, <c>ber_bin</c>, <c>per</c> and
+      <c>driver</c> are kept for backwards compatibility and should not be 
+      used in new code. The nif implementation which replaces the linked-in
+      driver has been shown to be about 5-15% faster.
     </p>
     <p>
       You are strongly recommended to use the appropriate alternative
       of the bold typed options. The <c>optimize</c> and
-      <c>driver</c> options does not affect the encode or decode
+      <c>nif</c> options does not affect the encode or decode
       result, just the time spent in run-time. When <c>ber_bin</c> and
-      <c>driver</c> or <c>per_bin, optimize</c> and <c>driver</c> is
-      combined the C-code driver is used in chosen parts of encode /
+      <c>nif</c> or <c>per_bin</c> and <c>optimize</c> is
+      combined the C-code nif is used in chosen parts of encode /
       decode procedure.
     </p>
     <table>
       <row>
         <cell align="left" valign="middle"><em>Compile options, allowed combinations</em></cell>
-        <cell align="left" valign="middle"><em>use of linked-in driver</em></cell>
+        <cell align="left" valign="middle"><em>use of nif</em></cell>
       </row>
       <row>
         <cell align="left" valign="middle">[ber]</cell>
@@ -663,7 +663,7 @@ asn1ct:decode('H323-MESSAGES','SomeChoiceType',Bytes).      </pre>
         <cell align="left" valign="middle">no</cell>
       </row>
       <row>
-        <cell align="left" valign="middle"><em>[ber_bin, optimize, driver]</em></cell>
+        <cell align="left" valign="middle"><em>[ber_bin, optimize, nif]</em></cell>
         <cell align="left" valign="middle">yes</cell>
       </row>
       <row>
@@ -675,7 +675,7 @@ asn1ct:decode('H323-MESSAGES','SomeChoiceType',Bytes).      </pre>
         <cell align="left" valign="middle">no</cell>
       </row>
       <row>
-        <cell align="left" valign="middle"><em>[per_bin, optimize]</em></cell>
+        <cell align="left" valign="middle"><em>[per_bin, nif]</em></cell>
         <cell align="left" valign="middle">yes</cell>
       </row>
       <row>
@@ -696,12 +696,12 @@ asn1ct:decode('H323-MESSAGES','SomeChoiceType',Bytes).      </pre>
         <cell align="left" valign="middle">no</cell>
       </row>
       <row>
-        <cell align="left" valign="middle"><em>[ber_bin, optimize, driver, der]</em></cell>
+        <cell align="left" valign="middle"><em>[ber_bin, optimize, nif, der]</em></cell>
         <cell align="left" valign="middle">yes</cell>
       </row>
 
 
-      <tcaption>When the ASN1 linked-in driver is used.</tcaption>
+      <tcaption>When the ASN1 nif is used.</tcaption>
     </table>
 
     </section>
@@ -718,14 +718,14 @@ asn1rt:decode('H323-MESSAGES','SomeChoiceType',Bytes).      </pre>
       <pre>
 'H323-MESSAGES':encode('SomeChoiceType',{call,"octetstring"}).
 'H323-MESSAGES':decode('SomeChoiceType',Bytes).      </pre>
-      <p>The asn1 linked-in driver is enabled in two occasions: encoding of
+      <p>The asn1 nif is enabled in two occasions: encoding of
         asn1 values when the asn1 spec is compiled with <c>per_bin</c> and
         <c>optimize</c> or decode of encoded asn1 values when the asn1 spec is
-        compiled with <c>ber_bin</c>, <c>optimize</c> and <c>driver</c>. In
-        those cases the driver will be loaded automatically at the first call
+        compiled with <c>ber_bin</c>, <c>optimize</c> and <c>nif</c>. In
+        those cases the nif will be loaded automatically at the first call
         to <c>encode</c>/<c>decode</c>. If one doesn't want the performance
-        overhead of the driver being loaded at the first call it is possible
-        to load the driver separately by <c>asn1rt:load_driver()</c>.  </p>
+        overhead of the nif being loaded at the first call it is possible
+        to load the nif separately by loading the <c>asn1rt_nif</c> module.</p>
       <p>By invoking the function <c>info/0</c> in a generated module, one
         gets information about which compiler options were used.</p>
     </section>
diff --git a/lib/asn1/doc/src/asn1ct.xml b/lib/asn1/doc/src/asn1ct.xml
index 2c8bef5dd8..d7c2572dc8 100644
--- a/lib/asn1/doc/src/asn1ct.xml
+++ b/lib/asn1/doc/src/asn1ct.xml
@@ -52,7 +52,7 @@
         <v>Options = [Option| OldOption]</v>
         <v>Option = ber_bin | per_bin | uper_bin | der | compact_bit_string | 
 	noobj | {n2n,EnumTypeName} |{outdir,Dir} | {i,IncludeDir} | optimize | 
-	driver | asn1config | undec_rest | {inline,OutputName} | inline |
+	nif | asn1config | undec_rest | {inline,OutputName} | inline |
 	{macro_name_prefix, Prefix} | {record_name_prefix, Prefix} | verbose</v>
         <v>OldOption = ber | per</v> 
         <v>Reason = term()</v>
@@ -212,24 +212,21 @@ Binary = binary()
               <c>per_bin</c> 
               or <c>ber_bin</c> option. It gives time optimized code 
               generated and it uses another runtime module and 
-              in the <c>per_bin</c> case a linked-in driver. The result 
+              in the <c>per_bin</c> case a nif. The result 
               in the <c>per_bin</c> case from an encode when compiled
               with this option will be a binary.</p>
           </item>
           <tag><c>driver</c></tag>
           <item>
-            <p>Option valid together with <c>ber_bin</c> and <c>optimize</c>
-              options. It enables the use of a linked-in driver that gives
-              considerable faster decode. In <c>ber_bin</c> the driver is
-              enabled only by explicit use of the option <c>driver</c>.</p>
+            <p>As of R15B this means the same as the <c>nif</c> option. Kept for
+	    backwards compatability reasons.</p>
           </item>
 	  <tag><c>nif</c></tag>
           <item>
             <p>Option valid together with <c>ber_bin</c> and <c>optimize</c>
-	      or <c>per_bin</c> and <c>optimize</c> options. It enables the
-	      use of several nifs that gives faster decode for
-	      ber and encode for per than the driver options gives. Nifs are
-	      only enabled by the explicit use of the option <c>nif</c></p>
+	      options. It enables the use of several nifs that gives faster 
+	      decode. Nifs are only enabled by the explicit use of the option 
+	    <c>nif</c></p>
           </item>
           <tag><c>asn1config</c></tag>
           <item>
@@ -351,18 +348,6 @@ Binary = binary()
       </desc>
     </func>
     <func>
-      <name>validate(Module,Type,Value) ->  ok | {error,Reason}</name>
-      <fsummary>Validate an ASN.1 value.</fsummary>
-      <type>
-        <v>Module = Type = atom()</v>
-        <v>Value = term()</v>
-      </type>
-      <desc>
-        <p>Validates that <c>Value</c> conforms  to <c>Type</c> 
-          from <c>Module</c>. <em>Not implemented in this version of the ASN.1 application.</em></p>
-      </desc>
-    </func>
-    <func>
       <name>value(Module ,Type) -> {ok,Value} | {error,Reason}</name>
       <fsummary>Create an ASN.1 value for test purposes.</fsummary>
       <type>
diff --git a/lib/asn1/doc/src/asn1rt.xml b/lib/asn1/doc/src/asn1rt.xml
index 1217a07e9b..0c3c257189 100644
--- a/lib/asn1/doc/src/asn1rt.xml
+++ b/lib/asn1/doc/src/asn1rt.xml
@@ -4,7 +4,7 @@
 <erlref>
   <header>
     <copyright>
-      <year>1997</year><year>2009</year>
+      <year>1997</year><year>2011</year>
       <holder>Ericsson AB. All Rights Reserved.</holder>
     </copyright>
     <legalnotice>
@@ -42,36 +42,6 @@
   <funcs>
 
     <func>
-      <name>start() -> ok |{error,Reason}</name>
-      <fsummary>Starts the asn1 server.</fsummary>
-      <type>
-        <v>Reason = term()</v>
-      </type>
-      <desc>
-	<p>Starts the asn1 server that loads the drivers.</p> 
-	<p>The server schedules a driver that is not blocked by
-	another caller. The driver is used by the asn1 application if
-	specs are compiled with options <c>[per_bin, optimize]</c> or
-	<c>[ber_bin, optimize, driver]</c>. The server will be started
-	automatically at encode/decode if it isn't done explicitly. If
-	encode/decode with driver is used in test or industrial code
-	it is a performance gain to start it explicitly to avoid the
-	one time load in run-time.</p>
-      </desc>
-    </func>
-
-    <func>
-      <name>stop() -> ok |{error,Reason}</name>
-      <fsummary>Stops the asn1 server.</fsummary>
-      <type>
-        <v>Reason = term()</v>
-      </type>
-      <desc>
-	<p>Stops the asn1 server and unloads the drivers.</p>
-      </desc>
-    </func>
-
-    <func>
       <name>decode(Module,Type,Bytes) -> {ok,Value}|{error,Reason}</name>
       <fsummary>Decode from bytes into an ASN.1 value.</fsummary>
       <type>
@@ -126,35 +96,23 @@
 
     <func>
       <name>load_driver() ->  ok | {error,Reason}</name>
-      <fsummary>Loads the linked-in driver.</fsummary>
+      <fsummary>Loads the linked-in driver. (deprecated)</fsummary>
       <type>
         <v>Reason = term()</v>
       </type>
       <desc>
-        <p>This function loads the linked-in driver before the first call
-          to encode. If this function is not called the driver will be loaded
-          automatically at the first call to encode. If one doesn't want the
-          performance cost of a driver load when the application is running,
-          this function makes it possible to load the driver in an 
-          initialization.</p>
-        <p>The driver is only used when encoding/decoding ASN.1 files that
-          were compiled with the options <c>per_bin</c> and <c>optimize</c>.</p>
+	<p>This function is obsolete and will be removed in R16A</p>
       </desc>
     </func>
 
     <func>
       <name>unload_driver() ->  ok | {error,Reason}</name>
-      <fsummary>Unloads the linked-in driver.</fsummary>
+      <fsummary>Unloads the linked-in driver. (deprecated)</fsummary>
       <type>
         <v>Reason = term()</v>
       </type>
       <desc>
-        <p>This function unloads the linked-in driver.
-          When the driver has been loaded it remains in the environment until
-          it is unloaded. Normally the driver should remain loaded, it is
-          crucial for the performance of ASN.1 encoding. </p>
-        <p>The driver is only used when ASN.1 modules have been compiled
-          with the flags <c>per_bin</c> and <c>optimize</c>.</p>
+	<p>This function is obsolete and will be removed in R16A</p>
       </desc>
     </func>
 
@@ -188,19 +146,6 @@
           value, to a UTF8 encoded binary.</p>
       </desc>
     </func>
-  
-    <func>
-      <name>validate(Module,Type,Value) ->  ok | {error,Reason}</name>
-      <fsummary>Validate an ASN.1 value.</fsummary>
-      <type>
-        <v>Module = Type = atom()</v>
-        <v>Value = term()</v>
-      </type>
-      <desc>
-        <p>Validates that <c>Value</c> conforms  to <c>Type</c> 
-          from <c>Module</c>. <em>Not implemented in this version of the ASN.1 application.</em></p>
-      </desc>
-    </func>
 
   </funcs>