[snmp/compiler] More information with augmented tables

The information the MIB compiler provides with augmented
tables has been extended with nbr_of_cols, first_accessible and
not_accessible.

OTP-9969

5 files changed, 214 insertions, 21 deletions

diff --git a/lib/snmp/include/snmp_types.hrl b/lib/snmp/include/snmp_types.hrl
index 4adb24361c..fce087347f 100644
--- a/lib/snmp/include/snmp_types.hrl
+++ b/lib/snmp/include/snmp_types.hrl
@@ -78,23 +78,36 @@
 
 %%-----------------------------------------------------------------
 %% TableInfo - stored in snmp_symbolic_store for use by the
-%% generic table functions.
+%% generic table functions. For an ordinary table, the
+%% types will be the following: 
 %%   nbr_of_cols      is an integer
+%%                    pos_integer()
 %%   defvals          is a list of {Col, Defval}, ordered by column
 %%                    number
+%%                    [{Col :: integer(), Defval :: term()}]
 %%   status_col       is an integer
+%%                    pos_integer()
 %%   not_accessible   a sorted list of columns (> first_accessible) 
 %%                    that are 'not-accessible'
-%%   indextypes       is a list of #asn1_type for the index-columns,
-%%                    ordered by column number
-%%   first_accessible is an integer, the first non-accessible
-%%                    column
+%%                    [pos_integer()]
+%%   index_types      is a list of #asn1_type for the index-columns,
+%%                    ordered by column number or an "augment"-tuple
+%%                    [asn1_type()]
+%%   first_accessible is an integer, the first accessible column
+%%                    pos_integer()
 %%   first_own_index  is an integer. 0 if there is no such index for 
 %%                    this table.
 %%                    This is not the same as the last integer in the oid!
 %%                    Example: If a table has one own index (oid.1), one 
 %%                    column (oid.2) and one imported index then 
 %%                    first_own_index will be 2.
+%%                    non_neg_integer()
+%% For a augmented table, it will instead look like this:
+%%   index_types      {augments, {atom(), asn1_type()}}
+%%   nbr_of_cols      pos_integer()
+%%   not_accessible   [pos_integer()]
+%%   first_accessible pos_integer()
+%%   
 %%-----------------------------------------------------------------
 
 -record(table_info, 
@@ -192,7 +205,7 @@
 %%----------------------------------------------------------------------
 -record(mib, 
 	{misc = [], 
-	 mib_format_version = "3.2", 
+	 mib_format_version = "3.3", 
 	 name = "",
 	 module_identity,  %% Not in SMIv1, and only with +module_identity
 	 mes = [], 
diff --git a/lib/snmp/src/compile/snmpc_lib.erl b/lib/snmp/src/compile/snmpc_lib.erl
index 38bb8f3ac6..6e833b6c44 100644
--- a/lib/snmp/src/compile/snmpc_lib.erl
+++ b/lib/snmp/src/compile/snmpc_lib.erl
@@ -704,23 +704,29 @@ check_trap_name(EnterpriseName, Line, MEs) ->
 %% This information is needed to be able to create default instrumentation
 %% functions for tables.
 %%----------------------------------------------------------------------
-make_table_info(Line, _TableName, {augments,SrcTableEntry}, ColumnMEs) ->
+make_table_info(Line, TableName, {augments, SrcTableEntry}, ColumnMEs) ->
     ColMEs = lists:keysort(#me.oid, ColumnMEs),
-    %% Nbr_of_Cols = length(ColMEs), 
+    Nbr_of_Cols = length(ColMEs), 
     MEs = ColMEs ++ (get(cdata))#cdata.mes,
-    Aug = case lookup(SrcTableEntry,MEs) of
+    Aug = case lookup(SrcTableEntry, MEs) of
 	      false ->
 		  print_error("Cannot AUGMENT the non-existing table entry ~p",
-			      [SrcTableEntry],Line),
+			      [SrcTableEntry], Line),
 		  {augments, error};
-	      {value,ME} ->
-		  {augments, {SrcTableEntry,translate_type(ME#me.asn1_type)}}
+	      {value, ME} ->
+		  {augments, {SrcTableEntry, translate_type(ME#me.asn1_type)}}
 	  end,
-    #table_info{index_types = Aug};
-make_table_info(Line, TableName, {indexes,[]}, _ColumnMEs) ->
+    FirstNonIdxCol = augments_first_non_index_column(ColMEs), 
+    NoAccs         = list_not_accessible(FirstNonIdxCol, ColMEs),
+    FirstAcc       = first_accessible(TableName, ColMEs),
+    #table_info{nbr_of_cols      = Nbr_of_Cols,
+		first_accessible = FirstAcc, 
+		not_accessible   = NoAccs, 
+		index_types      = Aug}; 
+make_table_info(Line, TableName, {indexes, []}, _ColumnMEs) ->
     print_error("Table ~w lacks indexes.", [TableName],Line),
     #table_info{};
-make_table_info(Line, TableName, {indexes,Indexes}, ColumnMEs) ->
+make_table_info(Line, TableName, {indexes, Indexes}, ColumnMEs) ->
     ColMEs = lists:keysort(#me.oid, ColumnMEs),
     NonImpliedIndexes = lists:map(fun non_implied_name/1, Indexes),
     test_read_create_access(ColMEs, Line, dummy),
@@ -860,11 +866,17 @@ get_asn1_type(ColumnName, MEs, Line) ->
     end.
 
 test_index_positions(Line, Indexes, ColMEs) ->
-    TLI = lists:filter(fun (IndexName) ->
-			       is_table_local_index(IndexName,ColMEs) end,
-		       Indexes),
+    IsTLI = fun(IndexName) -> is_table_local_index(IndexName, ColMEs) end, 
+    TLI   = lists:filter(IsTLI, Indexes),
     test_index_positions_impl(Line, TLI, ColMEs).
 
+%% An table that augments another cannot conatin any index, 
+%% so the first non-index column is always the first column.
+augments_first_non_index_column([]) ->
+    none;
+augments_first_non_index_column([#me{oid=Col}|_ColMEs]) ->
+    Col.
+
 %% Returns the first non-index column | none
 test_index_positions_impl(_Line, [], []) -> none;
 test_index_positions_impl(_Line, [], [#me{oid=Col}|_ColMEs]) ->
diff --git a/lib/snmp/test/modules.mk b/lib/snmp/test/modules.mk
index eacc749b53..7b0bdc5b8f 100644
--- a/lib/snmp/test/modules.mk
+++ b/lib/snmp/test/modules.mk
@@ -76,7 +76,8 @@ MIB_FILES = \
 	TestTrap.mib \
 	TestTrapv2.mib \
 	Test1.mib \
-	Test2.mib
+	Test2.mib \
+	Test3.mib
 
 SPECS = snmp.spec snmp.spec.vxworks 
 
diff --git a/lib/snmp/test/snmp_compiler_test.erl b/lib/snmp/test/snmp_compiler_test.erl
index f3a1e77322..257fc47952 100644
--- a/lib/snmp/test/snmp_compiler_test.erl
+++ b/lib/snmp/test/snmp_compiler_test.erl
@@ -49,6 +49,7 @@
 	 agent_capabilities/1,
 	 module_compliance/1, 
 	 warnings_as_errors/1,
+	 augments_extra_info/1,
 
 	 otp_6150/1,
 	 otp_8574/1, 
@@ -59,6 +60,7 @@
 %%----------------------------------------------------------------------
 %% Internal exports
 %%----------------------------------------------------------------------
+
 -export([
         ]).
 
@@ -125,6 +127,7 @@ all() ->
      agent_capabilities, 
      module_compliance, 
      warnings_as_errors,
+     augments_extra_info, 
      {group, tickets}
     ].
 
@@ -387,6 +390,47 @@ otp_8595(Config) when is_list(Config) ->
 
 
 %%======================================================================
+
+augments_extra_info(suite) ->
+    [];
+augments_extra_info(Config) when is_list(Config) ->
+    put(tname, augments_extra_info),
+    p("starting with Config: ~p~n", [Config]),
+
+    Dir       = ?config(case_top_dir, Config),
+    MibDir    = ?config(mib_dir,      Config),
+    Test2File = join(MibDir, "Test2.mib"),
+    Test3File = join(MibDir, "Test3.mib"),
+    ?line {ok, Test2BinFile} = 
+	snmpc:compile(Test2File, [{outdir,      Dir}, 
+				  {verbosity,   silence}, 
+				  {group_check, false}]),
+    io:format("Test2BinFile: ~n~p~n", [Test2BinFile]),
+    ?line {ok, Test3BinFile} = 
+	snmpc:compile(Test3File, [{i,           [MibDir]}, 
+				  {outdir,      Dir}, 
+				  {verbosity,   silence}, 
+				  {group_check, true}]),
+    io:format("Test3BinFile: ~n~p~n", [Test3BinFile]),
+    {ok, Test3Mib} = snmp_misc:read_mib(Test3BinFile), 
+    io:format("Test3Mib: ~n~p~n", [Test3Mib]),
+    %% There is only one table in this mib
+    #mib{table_infos = [{TableName, TI}]} = Test3Mib, 
+    io:format("TableName: ~p"
+	      "~n   Table Info: ~p"
+	      "~n", [TableName, TI]), 
+    #table_info{nbr_of_cols      = 4, 
+		defvals          = DefVals, 
+		not_accessible   = [2,4], 
+		index_types      = {augments, {tEntry, undefined}},
+		first_accessible = 1} = TI,
+    io:format("Table info:   ~p"
+	      "~n   DefVals: ~p"
+	      "~n", [TableName, DefVals]), 
+    ok.
+
+
+%%======================================================================
 %% Internal functions
 %%======================================================================
 
@@ -540,11 +584,11 @@ DESCRIPTION	\"" ++ Desc ++ "\"
     ::= { test 1 }
 
 END",
-    Message = file:write_file(Filename ,Binary),
+    Message = file:write_file(Filename, Binary),
 case Message of
     ok -> ok;
     {error, Reason} ->
-	exit({failed_writing_mib,Reason})
+	exit({failed_writing_mib, Reason})
 end.
 
 
diff --git a/lib/snmp/test/snmp_test_data/Test3.mib b/lib/snmp/test/snmp_test_data/Test3.mib
new file mode 100644
index 0000000000..7f76e4dba4
--- /dev/null
+++ b/lib/snmp/test/snmp_test_data/Test3.mib
@@ -0,0 +1,123 @@
+Test3 DEFINITIONS ::= BEGIN
+
+IMPORTS
+    MODULE-IDENTITY, OBJECT-TYPE, Integer32, snmpModules, mib-2
+        FROM SNMPv2-SMI
+    MODULE-COMPLIANCE, OBJECT-GROUP
+        FROM SNMPv2-CONF
+    tEntry
+        FROM Test2;
+
+t3MIB MODULE-IDENTITY
+    LAST-UPDATED "1203090000Z"
+    ORGANIZATION ""
+    CONTACT-INFO
+	""
+    DESCRIPTION
+            "Test mib, used to test processing of requests."
+    ::= { snmpModules 42 }
+
+
+-- Administrative assignments ****************************************
+
+t3MIBObjects     OBJECT IDENTIFIER ::= { t3MIB 1 }
+t3MIBConformance OBJECT IDENTIFIER ::= { t3MIB 2 }
+
+
+-- test4 OBJECT IDENTIFIER ::= { mib-2 18 }
+
+tAugTable OBJECT-TYPE
+    SYNTAX     SEQUENCE OF TAugEntry
+    MAX-ACCESS not-accessible
+    STATUS     current
+    DESCRIPTION
+            "This table AUGMENTS tTable of the Test2 MIB."
+    ::= { t3MIBObjects 1 }
+
+tAugEntry OBJECT-TYPE
+    SYNTAX     TAugEntry
+    MAX-ACCESS not-accessible
+    STATUS     current
+    DESCRIPTION
+            "An entry (conceptual row) in the sysORTable."
+    AUGMENTS      { tEntry }
+    ::= { tAugTable 1 }
+
+TAugEntry ::= SEQUENCE {
+    tFoo1     OCTET STRING,
+    tFoo2     OCTET STRING,
+    tBar1     Integer32,
+    tBar2     Integer32
+}
+
+tFoo1 OBJECT-TYPE
+    SYNTAX      OCTET STRING (SIZE (0..255))
+    MAX-ACCESS  read-create
+    STATUS      current
+    DESCRIPTION
+        "A string."
+    DEFVAL { "foo 1" }
+    ::= { tAugEntry 1 }
+
+tFoo2 OBJECT-TYPE
+    SYNTAX      OCTET STRING (SIZE (0..255))
+    MAX-ACCESS  not-accessible
+    STATUS      current
+    DESCRIPTION
+        "A string."
+    DEFVAL { "foo 2" }
+    ::= { tAugEntry 2 }
+
+tBar1 OBJECT-TYPE
+    SYNTAX      Integer32
+    MAX-ACCESS  read-create
+    STATUS      current
+    DESCRIPTION
+        "An integer."
+    DEFVAL { 42 }
+    ::= { tAugEntry 3 }
+
+tBar2 OBJECT-TYPE
+    SYNTAX      Integer32
+    MAX-ACCESS  not-accessible
+    STATUS      current
+    DESCRIPTION
+        "An integer."
+    DEFVAL { 42 }
+    ::= { tAugEntry 4 }
+
+
+-- Conformance Information *******************************************
+
+t3MIBCompliances OBJECT IDENTIFIER
+                            ::= { t3MIBConformance 1 }
+t3MIBGroups      OBJECT IDENTIFIER
+                            ::= { t3MIBConformance 2 }
+
+-- Compliance statements
+
+t3MIBCompliance MODULE-COMPLIANCE
+    STATUS       current
+    DESCRIPTION
+        "The compliance statement for SNMP engines which
+         implement the SNMP-COMMUNITY-MIB."
+
+    MODULE       -- this module
+        MANDATORY-GROUPS { t3Group }
+
+    ::= { t3MIBCompliances 1 }
+
+t3Group OBJECT-GROUP
+    OBJECTS {
+        tFoo1,
+        tFoo2,
+        tBar1,
+        tBar2
+    }
+    STATUS       current
+    DESCRIPTION
+        "A group."
+    ::= { t3MIBGroups 1 }
+
+
+END