Merge pull request #848 from bollhals/reduce.allocation

michaelklishin · michaelklishin · commit ce9b0396f16e · 2020-05-25T17:19:45.000+03:00
eliminate allocations from InboundFrame (cherry picked from commit 2bf5849)
diff --git a/projects/RabbitMQ.Client/client/impl/CommandAssembler.cs b/projects/RabbitMQ.Client/client/impl/CommandAssembler.cs
@@ -72,7 +72,7 @@ public CommandAssembler(ProtocolBase protocol)
             Reset();
         }
 
-        public Command HandleFrame(InboundFrame f)
+        public Command HandleFrame(in InboundFrame f)
         {
             switch (m_state)
             {
diff --git a/projects/RabbitMQ.Client/client/impl/Connection.cs b/projects/RabbitMQ.Client/client/impl/Connection.cs
@@ -586,7 +586,7 @@ public void MainLoopIteration()
                     // quiescing situation, even though technically we
                     // should be ignoring everything except
                     // connection.close-ok.
-                    _session0.HandleFrame(frame);
+                    _session0.HandleFrame(in frame);
                 }
                 else
                 {
@@ -608,7 +608,7 @@ public void MainLoopIteration()
                         }
                         else
                         {
-                            session.HandleFrame(frame);
+                            session.HandleFrame(in frame);
                         }
                     }
                 }
diff --git a/projects/RabbitMQ.Client/client/impl/Frame.cs b/projects/RabbitMQ.Client/client/impl/Frame.cs
@@ -165,10 +165,17 @@ internal int GetMinimumBufferSize()
         }
     }
 
-    class InboundFrame : Frame, IDisposable
+    internal readonly struct InboundFrame : IDisposable
     {
-        private InboundFrame(FrameType type, int channel, ReadOnlyMemory<byte> payload) : base(type, channel, payload)
+        public readonly ReadOnlyMemory<byte> Payload;
+        public readonly int Channel;
+        public readonly FrameType Type;
+
+        private InboundFrame(FrameType type, int channel, ReadOnlyMemory<byte> payload)
         {
+            Payload = payload;
+            Type = type;
+            Channel = channel;
         }
 
         public bool IsMethod()
@@ -289,6 +296,11 @@ public void Dispose()
                 ArrayPool<byte>.Shared.Return(segment.Array);
             }
         }
+        
+        public override string ToString()
+        {
+            return $"(type={Type}, channel={Channel}, {Payload.Length} bytes of payload)";
+        }
     }
 
     class Frame
diff --git a/projects/RabbitMQ.Client/client/impl/ISession.cs b/projects/RabbitMQ.Client/client/impl/ISession.cs
@@ -78,7 +78,7 @@ interface ISession
 
         void Close(ShutdownEventArgs reason);
         void Close(ShutdownEventArgs reason, bool notify);
-        void HandleFrame(InboundFrame frame);
+        void HandleFrame(in InboundFrame frame);
         void Notify();
         void Transmit(Command cmd);
         void Transmit(IList<Command> cmd);
diff --git a/projects/RabbitMQ.Client/client/impl/MainSession.cs b/projects/RabbitMQ.Client/client/impl/MainSession.cs
@@ -71,13 +71,13 @@ public MainSession(Connection connection) : base(connection, 0)
 
         public Action Handler { get; set; }
 
-        public override void HandleFrame(InboundFrame frame)
+        public override void HandleFrame(in InboundFrame frame)
         {
             lock (_closingLock)
             {
                 if (!_closing)
                 {
-                    base.HandleFrame(frame);
+                    base.HandleFrame(in frame);
                     return;
                 }
             }
@@ -88,7 +88,7 @@ public override void HandleFrame(InboundFrame frame)
                 if ((method.ProtocolClassId == _closeClassId)
                     && (method.ProtocolMethodId == _closeMethodId))
                 {
-                    base.HandleFrame(frame);
+                    base.HandleFrame(in frame);
                     return;
                 }
 
diff --git a/projects/RabbitMQ.Client/client/impl/QuiescingSession.cs b/projects/RabbitMQ.Client/client/impl/QuiescingSession.cs
@@ -55,7 +55,7 @@ public QuiescingSession(Connection connection,
             m_reason = reason;
         }
 
-        public override void HandleFrame(InboundFrame frame)
+        public override void HandleFrame(in InboundFrame frame)
         {
             if (frame.IsMethod())
             {
diff --git a/projects/RabbitMQ.Client/client/impl/Session.cs b/projects/RabbitMQ.Client/client/impl/Session.cs
@@ -53,9 +53,9 @@ public Session(Connection connection, int channelNumber)
             _assembler = new CommandAssembler(connection.Protocol);
         }
 
-        public override void HandleFrame(InboundFrame frame)
+        public override void HandleFrame(in InboundFrame frame)
         {
-            using (Command cmd = _assembler.HandleFrame(frame))
+            using (Command cmd = _assembler.HandleFrame(in frame))
             {
                 if (cmd != null)
                 {
diff --git a/projects/RabbitMQ.Client/client/impl/SessionBase.cs b/projects/RabbitMQ.Client/client/impl/SessionBase.cs
@@ -153,7 +153,7 @@ public void Close(ShutdownEventArgs reason, bool notify)
             }
         }
 
-        public abstract void HandleFrame(InboundFrame frame);
+        public abstract void HandleFrame(in InboundFrame frame);
 
         public void Notify()
         {

Original file line number	Diff line number	Diff line change
`@@ -72,7 +72,7 @@ public CommandAssembler(ProtocolBase protocol)`
`72`	`72`	`Reset();`
`73`	`73`	`}`
`74`	`74`
`75`		`- public Command HandleFrame(InboundFrame f)`
	`75`	`+ public Command HandleFrame(in InboundFrame f)`
`76`	`76`	`{`
`77`	`77`	`switch (m_state)`
`78`	`78`	`{`
Original file line number	Diff line number	Diff line change
`@@ -586,7 +586,7 @@ public void MainLoopIteration()`
`586`	`586`	`// quiescing situation, even though technically we`
`587`	`587`	`// should be ignoring everything except`
`588`	`588`	`// connection.close-ok.`
`589`		`- _session0.HandleFrame(frame);`
	`589`	`+ _session0.HandleFrame(in frame);`
`590`	`590`	`}`
`591`	`591`	`else`
`592`	`592`	`{`
`@@ -608,7 +608,7 @@ public void MainLoopIteration()`
`608`	`608`	`}`
`609`	`609`	`else`
`610`	`610`	`{`
`611`		`- session.HandleFrame(frame);`
	`611`	`+ session.HandleFrame(in frame);`
`612`	`612`	`}`
`613`	`613`	`}`
`614`	`614`	`}`
Original file line number	Diff line number	Diff line change
`@@ -165,10 +165,17 @@ internal int GetMinimumBufferSize()`
`165`	`165`	`}`
`166`	`166`	`}`
`167`	`167`
`168`		`- class InboundFrame : Frame, IDisposable`
	`168`	`+ internal readonly struct InboundFrame : IDisposable`
`169`	`169`	`{`
`170`		`- private InboundFrame(FrameType type, int channel, ReadOnlyMemory<byte> payload) : base(type, channel, payload)`
	`170`	`+ public readonly ReadOnlyMemory<byte> Payload;`
	`171`	`+ public readonly int Channel;`
	`172`	`+ public readonly FrameType Type;`
	`173`	`+`
	`174`	`+ private InboundFrame(FrameType type, int channel, ReadOnlyMemory<byte> payload)`
`171`	`175`	`{`
	`176`	`+ Payload = payload;`
	`177`	`+ Type = type;`
	`178`	`+ Channel = channel;`
`172`	`179`	`}`
`173`	`180`
`174`	`181`	`public bool IsMethod()`
`@@ -289,6 +296,11 @@ public void Dispose()`
`289`	`296`	`ArrayPool<byte>.Shared.Return(segment.Array);`
`290`	`297`	`}`
`291`	`298`	`}`
	`299`	`+`
	`300`	`+ public override string ToString()`
	`301`	`+ {`
	`302`	`+ return $"(type={Type}, channel={Channel}, {Payload.Length} bytes of payload)";`
	`303`	`+ }`
`292`	`304`	`}`
`293`	`305`
`294`	`306`	`class Frame`
Original file line number	Diff line number	Diff line change
`@@ -71,13 +71,13 @@ public MainSession(Connection connection) : base(connection, 0)`
`71`	`71`
`72`	`72`	`public Action Handler { get; set; }`
`73`	`73`
`74`		`- public override void HandleFrame(InboundFrame frame)`
	`74`	`+ public override void HandleFrame(in InboundFrame frame)`
`75`	`75`	`{`
`76`	`76`	`lock (_closingLock)`
`77`	`77`	`{`
`78`	`78`	`if (!_closing)`
`79`	`79`	`{`
`80`		`- base.HandleFrame(frame);`
	`80`	`+ base.HandleFrame(in frame);`
`81`	`81`	`return;`
`82`	`82`	`}`
`83`	`83`	`}`
`@@ -88,7 +88,7 @@ public override void HandleFrame(InboundFrame frame)`
`88`	`88`	`if ((method.ProtocolClassId == _closeClassId)`
`89`	`89`	`&& (method.ProtocolMethodId == _closeMethodId))`
`90`	`90`	`{`
`91`		`- base.HandleFrame(frame);`
	`91`	`+ base.HandleFrame(in frame);`
`92`	`92`	`return;`
`93`	`93`	`}`
`94`	`94`
Original file line number	Diff line number	Diff line change
`@@ -55,7 +55,7 @@ public QuiescingSession(Connection connection,`
`55`	`55`	`m_reason = reason;`
`56`	`56`	`}`
`57`	`57`
`58`		`- public override void HandleFrame(InboundFrame frame)`
	`58`	`+ public override void HandleFrame(in InboundFrame frame)`
`59`	`59`	`{`
`60`	`60`	`if (frame.IsMethod())`
`61`	`61`	`{`
Original file line number	Diff line number	Diff line change
`@@ -53,9 +53,9 @@ public Session(Connection connection, int channelNumber)`
`53`	`53`	`_assembler = new CommandAssembler(connection.Protocol);`
`54`	`54`	`}`
`55`	`55`
`56`		`- public override void HandleFrame(InboundFrame frame)`
	`56`	`+ public override void HandleFrame(in InboundFrame frame)`
`57`	`57`	`{`
`58`		`- using (Command cmd = _assembler.HandleFrame(frame))`
	`58`	`+ using (Command cmd = _assembler.HandleFrame(in frame))`
`59`	`59`	`{`
`60`	`60`	`if (cmd != null)`
`61`	`61`	`{`
Original file line number	Diff line number	Diff line change
`@@ -153,7 +153,7 @@ public void Close(ShutdownEventArgs reason, bool notify)`
`153`	`153`	`}`
`154`	`154`	`}`
`155`	`155`
`156`		`- public abstract void HandleFrame(InboundFrame frame);`
	`156`	`+ public abstract void HandleFrame(in InboundFrame frame);`
`157`	`157`
`158`	`158`	`public void Notify()`
`159`	`159`	`{`