Supporting prefix <sync> layer in commsdsl2wireshark.

Author: arobenko

app/commsdsl2comms/src/CommsSyncLayer.cpp

@@ -68,7 +68,7 @@ CommsSyncLayer::CommsIncludesList CommsSyncLayer::commsDefIncludesImpl() const
         "comms/frame/SyncPrefixLayer.h"
     };
 
-    auto parseObj = genSyncLayerDslObj();
+    auto parseObj = genSyncLayerParseObj();
 
     if (parseObj.parseIsAfterPayload()) {
         result.push_back("comms/frame/SyncSuffixLayer.h");
@@ -104,7 +104,7 @@ std::string CommsSyncLayer::commsDefBaseTypeImpl(const std::string& prevName) co
         "    #^#OPTS#$#\n"
         ">";
 
-    auto parseObj = genSyncLayerDslObj();
+    auto parseObj = genSyncLayerParseObj();
     std::string type = "Prefix";
     if (parseObj.parseIsAfterPayload()) {
         type = "Suffix";

app/commsdsl2comms/test/test36/Schema.xml

@@ -18,6 +18,7 @@
             <int name="F2" type="uint8" />
         </optional>
     </message>
+
     <frame name="Frame">
         <id name="ID" field="MsgId" />
         <payload name="Data" />

app/commsdsl2wireshark/src/WiresharkLayer.cpp

@@ -160,6 +160,9 @@ std::string WiresharkLayer::wiresharkDissectFieldCode() const
 
     static const std::string Templ =
         "#^#RESULT#$#, #^#NEXT_OFFSET#$# = #^#NAME#$#(#^#TVB#$#, #^#TREE#$#, #^#OFFSET#$#, #^#LIMIT#$#)\n"
+        "if #^#RESULT#$# == #^#INVALID_MSG_DATA#$# then\n"
+        "    return #^#MALFORMED#$#, #^#NEXT_OFFSET#$#\n"
+        "end\n"
         "if #^#RESULT#$# ~= #^#SUCCESS#$# then\n"
         "    return #^#RESULT#$#, #^#NEXT_OFFSET#$#\n"
         "end\n"
@@ -169,6 +172,8 @@ std::string WiresharkLayer::wiresharkDissectFieldCode() const
     util::GenReplacementMap repl = {
         {"NAME", field->wiresharkDissectName()},
         {"SUCCESS", Wireshark::wiresharkStatusCodeStr(wiresharkGenerator, Wireshark::WiresharkStatusCode::Success)},
+        {"INVALID_MSG_DATA", Wireshark::wiresharkStatusCodeStr(wiresharkGenerator, Wireshark::WiresharkStatusCode::InvalidMsgData)},
+        {"MALFORMED", Wireshark::wiresharkStatusCodeStr(wiresharkGenerator, Wireshark::WiresharkStatusCode::MalformedPacket)},
         {"RESULT", WiresharkField::wiresharkResultStr()},
         {"NEXT_OFFSET", WiresharkField::wiresharkNextOffsetStr()},
         {"TVB", WiresharkField::wiresharkTvbStr()},

app/commsdsl2wireshark/src/WiresharkSetField.cpp

@@ -238,6 +238,10 @@ std::string WiresharkSetField::wiresharkValueAccessStrImpl(const std::string& ac
         return WiresharkBase::wiresharkValueAccessStrImpl(std::string(), refField);
     }
 
+    if ((refField != nullptr) && (!refField->wiresharkIsBitfieldMember())) {
+        refField = nullptr;
+    }
+
     static const std::string Templ =
         "#^#VALUE_FUNC#$#(#^#NAME#$#)"
         ;

app/commsdsl2wireshark/src/WiresharkSyncLayer.cpp

@@ -15,8 +15,17 @@
 
 #include "WiresharkSyncLayer.h"
 
+#include "WiresharkField.h"
 #include "WiresharkGenerator.h"
 
+#include "commsdsl/gen/strings.h"
+#include "commsdsl/gen/util.h"
+
+#include <cassert>
+
+namespace strings = commsdsl::gen::strings;
+namespace util = commsdsl::gen::util;
+
 namespace commsdsl2wireshark
 {
 
@@ -26,4 +35,44 @@ WiresharkSyncLayer::WiresharkSyncLayer(WiresharkGenerator& generator, ParseLayer
 {
 }
 
+std::string WiresharkSyncLayer::wiresharkDissectBodyImpl() const
+{
+    auto parseObj = genSyncLayerParseObj();
+    if (parseObj.parseIsAfterPayload()) {
+        return wiresharkSuffixDissectCodeInternal();
+    }
+
+    static const std::string Templ =
+        "#^#FIELD#$#\n"
+        "#^#OFFSET#$# = #^#NEXT_OFFSET#$#\n"
+        "#^#NEXT#$#\n"
+        ;
+
+    util::GenReplacementMap repl = {
+        {"FIELD", wiresharkDissectFieldCodeInternal()},
+        {"NEXT", wiresharkNextFuncCode()},
+        {"OFFSET", WiresharkField::wiresharkOffsetStr()},
+        {"NEXT_OFFSET", WiresharkField::wiresharkNextOffsetStr()},
+    };
+
+    return util::genProcessTemplate(Templ, repl);
+}
+
+std::string WiresharkSyncLayer::wiresharkSuffixDissectCodeInternal() const
+{
+    // TODO
+    return "-- TODO: implement sync suffix";
+}
+
+std::string WiresharkSyncLayer::wiresharkDissectFieldCodeInternal() const
+{
+    auto parseObj = genSyncLayerParseObj();
+    if (!parseObj.parseSeekField()) {
+        return WiresharkLayer::wiresharkDissectFieldCode();
+    }
+
+    // TODO
+    return "-- TODO: implement seeked sync suffix";
+}
+
 } // namespace commsdsl2wireshark

app/commsdsl2wireshark/src/WiresharkSyncLayer.h

@@ -33,6 +33,13 @@ class WiresharkSyncLayer final : public commsdsl::gen::GenSyncLayer, public Wire
     using GenElem = commsdsl::gen::GenElem;
 
     WiresharkSyncLayer(WiresharkGenerator& generator, ParseLayer parseObj, GenElem* parent);
+
+protected:
+    virtual std::string wiresharkDissectBodyImpl() const override;
+
+private:
+    std::string wiresharkSuffixDissectCodeInternal() const;
+    std::string wiresharkDissectFieldCodeInternal() const;
 };
 
 } // namespace commsdsl2wireshark

app/commsdsl2wireshark/test/test36/test36.py

@@ -0,0 +1,30 @@
+import sys
+
+from commsdsl_pcap_gen import *
+
+def do_frame(id, payload):
+    prefix = struct.pack('>B', id)
+    return prefix + payload
+
+def pcap1(f):
+    seq = 1000
+    msg1_payload = struct.pack('>B', 0)
+    msg1 = do_frame(1, msg1_payload)
+    header = commsdsl_create_ethernet_ip_tcp_headers(len(msg1), seq)
+    commsdsl_write_packet(f, header + msg1, time.time())
+
+def pcap2(f):
+    seq = 2000
+    msg1_payload = struct.pack('>BB', 3, 5)
+    msg1 = do_frame(1, msg1_payload)
+    header = commsdsl_create_ethernet_ip_tcp_headers(len(msg1), seq)
+    commsdsl_write_packet(f, header + msg1, time.time())
+
+def main():
+    with open(sys.argv[1], 'wb') as f:
+        commsdsl_write_pcap_header(f)
+        pcap1(f)
+        pcap2(f)
+
+if __name__ == '__main__':
+    main()

lib/include/commsdsl/gen/GenSyncLayer.h

@@ -51,7 +51,7 @@ class COMMSDSL_API GenSyncLayer : public GenLayer
     virtual bool genPrepareImpl() override;
     virtual bool genForceCommsOrderImpl(GenLayersAccessList& layers, bool& success) const override final;
 
-    ParseSyncLayer genSyncLayerDslObj() const;
+    ParseSyncLayer genSyncLayerParseObj() const;
 
 private:
     std::unique_ptr<GenSyncLayerImpl> m_impl;

lib/src/gen/GenSyncLayer.cpp

@@ -95,7 +95,7 @@ class GenSyncLayerImpl
 
 GenSyncLayer::GenSyncLayer(GenGenerator& generator, ParseLayer parseObj, GenElem* parent) :
     Base(generator, parseObj, parent),
-    m_impl(std::make_unique<GenSyncLayerImpl>(generator, genSyncLayerDslObj(), this))
+    m_impl(std::make_unique<GenSyncLayerImpl>(generator, genSyncLayerParseObj(), this))
 {
     assert(parseObj.parseKind() == ParseLayer::ParseKind::Sync);
 }
@@ -129,7 +129,7 @@ bool GenSyncLayer::genPrepareImpl()
 
 bool GenSyncLayer::genForceCommsOrderImpl(GenLayersAccessList& layers, bool& success) const
 {
-    auto parseObj = genSyncLayerDslObj();
+    auto parseObj = genSyncLayerParseObj();
     if (!parseObj.parseIsAfterPayload()) {
         return Base::genForceCommsOrderImpl(layers, success);
     }
@@ -194,7 +194,7 @@ bool GenSyncLayer::genForceCommsOrderImpl(GenLayersAccessList& layers, bool& suc
     return genAdjustSuffixLayersOrder(layers, success);
 }
 
-GenSyncLayer::ParseSyncLayer GenSyncLayer::genSyncLayerDslObj() const
+GenSyncLayer::ParseSyncLayer GenSyncLayer::genSyncLayerParseObj() const
 {
     return ParseSyncLayer(genParseObj());
 }