Extend assembler with ability to produce comments for the generated code.

runtime/vm/object.h

 // Copyright (c) 2012, the Dart project authors.  Please see the AUTHORS file
 // for details. All rights reserved. Use of this source code is governed by a
 // BSD-style license that can be found in the LICENSE file.
 
 #ifndef VM_OBJECT_H_
 #define VM_OBJECT_H_
 
 #include "include/dart_api.h"
 #include "platform/assert.h"
 #include "platform/utils.h"
@@ skipping 2125 matching lines @@
     ASSERT((index >=0) && (index < Length()));
     intptr_t data_index = (index * kNumberOfEntries) + entry_offset;
     return &raw_ptr()->data_[data_index];
   }
 
   HEAP_OBJECT_IMPLEMENTATION(ExceptionHandlers, Object);
   friend class Class;
 };
 
 
+class CodeComments : public ValueObject {

[srdjan, 2012/05/17 17:22:08]

Please move CodeComments inside class Code.

[Vyacheslav Egorov (Google), 2012/05/17 21:16:27]

Done.

+ public:
+  enum {
+    kPCEntry = 0,
+    kCommentEntry,
+    kNumberOfEntries
+  };

[srdjan, 2012/05/17 17:22:08]

name the enum, and why do you need it?

[srdjan, 2012/05/17 17:22:08]

name the enum, and why do you need it?

[Vyacheslav Egorov (Google), 2012/05/17 21:16:27]

Discussed offline. Moved enum to private section. Added comments.

+
+  static CodeComments New(int count);

[srdjan, 2012/05/17 17:22:08]

Memory sizes are in intptr_t.

[Vyacheslav Egorov (Google), 2012/05/17 21:16:27]

Done.

+
+  intptr_t Length();
+
+  intptr_t PCAt(int idx);

[srdjan, 2012/05/17 17:22:08]

Is it PC or PCOffset?

[Vyacheslav Egorov (Google), 2012/05/17 21:16:27]

Done.

+  void SetPCAt(int idx, intptr_t pc);

[srdjan, 2012/05/17 17:22:08]

pc_offset?

[Vyacheslav Egorov (Google), 2012/05/17 21:16:27]

Done.

+
+  const String& CommentAt(int idx);

[srdjan, 2012/05/17 17:22:08]

const?

[Vyacheslav Egorov (Google), 2012/05/17 21:16:27]

Done.

[Vyacheslav Egorov (Google), 2012/05/17 21:16:27]

Done.

+  void SetCommentAt(int idx, const String& comment);
+
+ private:
+  explicit CodeComments(RawArray* comments);
+  CodeComments();

[srdjan, 2012/05/17 17:22:08]

Remove this constructor once it becomes ZoneObject

[Vyacheslav Egorov (Google), 2012/05/17 21:16:27]

Done.

+
+  const Array& comments_;
+
+  friend class Code;

[srdjan, 2012/05/17 17:22:08]

Remove this once moved inside class Code, I guess.

[Vyacheslav Egorov (Google), 2012/05/17 21:16:27]

Moving one class into another does not make these classes friends automatically.

+};
+
+
 class Code : public Object {
  public:
   RawInstructions* instructions() const { return raw_ptr()->instructions_; }
   static intptr_t instructions_offset() {
     return OFFSET_OF(RawCode, instructions_);
   }
   intptr_t pointer_offsets_length() const {
     return raw_ptr()->pointer_offsets_length_;
   }
   bool is_optimized() const {
@@ skipping 17 matching lines @@
   void set_pc_descriptors(const PcDescriptors& descriptors) const {
     StorePointer(&raw_ptr()->pc_descriptors_, descriptors.raw());
   }
 
   RawArray* stackmaps() const {
     return raw_ptr()->stackmaps_;
   }
   void set_stackmaps(const Array& maps) const;
   RawStackmap* GetStackmap(uword pc, Array* stackmaps, Stackmap* map) const;
 
+  CodeComments comments() const;

[srdjan, 2012/05/17 17:22:08]

const CodeComments&

[Vyacheslav Egorov (Google), 2012/05/17 21:16:27]

Done. However both Code::Comments::New and Code::comments started to look mighty
ugly in my opinion.

[Ivan Posva, 2012/05/22 22:40:02]

Maybe the real solution should be that the code comment handling does not have
anything to do with objects (except that the data is stored in an ObjectArray).
In reality code comments are something that is used to communicate between the
assembler and disassembler. How about moving it there?

+  void set_comments(const CodeComments& comments) const;
+
   RawLocalVarDescriptors* var_descriptors() const {
     return raw_ptr()->var_descriptors_;
   }
   void set_var_descriptors(const LocalVarDescriptors& value) const {
     StorePointer(&raw_ptr()->var_descriptors_, value.raw());
   }
 
   RawExceptionHandlers* exception_handlers() const {
     return raw_ptr()->exception_handlers_;
   }
@@ skipping 2723 matching lines @@
 }
 
 
 intptr_t Stackmap::SizeInBits() const {
   return (Smi::Value(raw_ptr()->bitmap_size_in_bytes_) * kBitsPerByte);
 }
 
 }  // namespace dart
 
 #endif  // VM_OBJECT_H_