Refactor ProfilingUtils
[platform/upstream/armnn.git] / src / profiling / ProfilingUtils.cpp
1 //
2 // Copyright © 2017 Arm Ltd. All rights reserved.
3 // SPDX-License-Identifier: MIT
4 //
5
6 #include "ProfilingUtils.hpp"
7
8 #include <armnn/Version.hpp>
9 #include <armnn/Conversion.hpp>
10
11 #include <boost/assert.hpp>
12
13 #include <fstream>
14 #include <limits>
15
16 namespace armnn
17 {
18
19 namespace profiling
20 {
21
22 namespace
23 {
24
25 void ThrowIfCantGenerateNextUid(uint16_t uid, uint16_t cores = 0)
26 {
27     // Check that it is possible to generate the next UID without causing an overflow
28     switch (cores)
29     {
30     case 0:
31     case 1:
32         // Number of cores not specified or set to 1 (a value of zero indicates the device is not capable of
33         // running multiple parallel workloads and will not provide multiple streams of data for each event)
34         if (uid == std::numeric_limits<uint16_t>::max())
35         {
36             throw RuntimeException("Generating the next UID for profiling would result in an overflow");
37         }
38         break;
39     default: // cores > 1
40         // Multiple cores available, as max_counter_uid has to be set to: counter_uid + cores - 1, the maximum
41         // allowed value for a counter UID is consequently: uint16_t_max - cores + 1
42         if (uid >= std::numeric_limits<uint16_t>::max() - cores + 1)
43         {
44             throw RuntimeException("Generating the next UID for profiling would result in an overflow");
45         }
46         break;
47     }
48 }
49
50 } // Anonymous namespace
51
52 uint16_t GetNextUid(bool peekOnly)
53 {
54     // The UID used for profiling objects and events. The first valid UID is 1, as 0 is a reserved value
55     static uint16_t uid = 1;
56
57     // Check that it is possible to generate the next UID without causing an overflow (throws in case of error)
58     ThrowIfCantGenerateNextUid(uid);
59
60     if (peekOnly)
61     {
62         // Peek only
63         return uid;
64     }
65     else
66     {
67         // Get the next UID
68         return uid++;
69     }
70 }
71
72 std::vector<uint16_t> GetNextCounterUids(uint16_t cores)
73 {
74     // The UID used for counters only. The first valid UID is 0
75     static uint16_t counterUid = 0;
76
77     // Check that it is possible to generate the next counter UID without causing an overflow (throws in case of error)
78     ThrowIfCantGenerateNextUid(counterUid, cores);
79
80     // Get the next counter UIDs
81     size_t counterUidsSize = cores == 0 ? 1 : cores;
82     std::vector<uint16_t> counterUids(counterUidsSize, 0);
83     for (size_t i = 0; i < counterUidsSize; i++)
84     {
85         counterUids[i] = counterUid++;
86     }
87     return counterUids;
88 }
89
90 void WriteUint64(const std::unique_ptr<IPacketBuffer>& packetBuffer, unsigned int offset, uint64_t value)
91 {
92     BOOST_ASSERT(packetBuffer);
93
94     WriteUint64(packetBuffer->GetWritableData(), offset, value);
95 }
96
97 void WriteUint32(const std::unique_ptr<IPacketBuffer>& packetBuffer, unsigned int offset, uint32_t value)
98 {
99     BOOST_ASSERT(packetBuffer);
100
101     WriteUint32(packetBuffer->GetWritableData(), offset, value);
102 }
103
104 void WriteUint16(const std::unique_ptr<IPacketBuffer>& packetBuffer, unsigned int offset, uint16_t value)
105 {
106     BOOST_ASSERT(packetBuffer);
107
108     WriteUint16(packetBuffer->GetWritableData(), offset, value);
109 }
110
111 void WriteUint64(unsigned char* buffer, unsigned int offset, uint64_t value)
112 {
113     BOOST_ASSERT(buffer);
114
115     buffer[offset]     = static_cast<unsigned char>(value & 0xFF);
116     buffer[offset + 1] = static_cast<unsigned char>((value >> 8) & 0xFF);
117     buffer[offset + 2] = static_cast<unsigned char>((value >> 16) & 0xFF);
118     buffer[offset + 3] = static_cast<unsigned char>((value >> 24) & 0xFF);
119     buffer[offset + 4] = static_cast<unsigned char>((value >> 32) & 0xFF);
120     buffer[offset + 5] = static_cast<unsigned char>((value >> 40) & 0xFF);
121     buffer[offset + 6] = static_cast<unsigned char>((value >> 48) & 0xFF);
122     buffer[offset + 7] = static_cast<unsigned char>((value >> 56) & 0xFF);
123 }
124
125 void WriteUint32(unsigned char* buffer, unsigned int offset, uint32_t value)
126 {
127     BOOST_ASSERT(buffer);
128
129     buffer[offset]     = static_cast<unsigned char>(value & 0xFF);
130     buffer[offset + 1] = static_cast<unsigned char>((value >> 8) & 0xFF);
131     buffer[offset + 2] = static_cast<unsigned char>((value >> 16) & 0xFF);
132     buffer[offset + 3] = static_cast<unsigned char>((value >> 24) & 0xFF);
133 }
134
135 void WriteUint16(unsigned char* buffer, unsigned int offset, uint16_t value)
136 {
137     BOOST_ASSERT(buffer);
138
139     buffer[offset]     = static_cast<unsigned char>(value & 0xFF);
140     buffer[offset + 1] = static_cast<unsigned char>((value >> 8) & 0xFF);
141 }
142
143 uint64_t ReadUint64(const std::unique_ptr<IPacketBuffer>& packetBuffer, unsigned int offset)
144 {
145     BOOST_ASSERT(packetBuffer);
146
147     return ReadUint64(packetBuffer->GetReadableData(), offset);
148 }
149
150 uint32_t ReadUint32(const std::unique_ptr<IPacketBuffer>& packetBuffer, unsigned int offset)
151 {
152     BOOST_ASSERT(packetBuffer);
153
154     return ReadUint32(packetBuffer->GetReadableData(), offset);
155 }
156
157 uint16_t ReadUint16(const std::unique_ptr<IPacketBuffer>& packetBuffer, unsigned int offset)
158 {
159     BOOST_ASSERT(packetBuffer);
160
161     return ReadUint16(packetBuffer->GetReadableData(), offset);
162 }
163
164 uint8_t ReadUint8(const std::unique_ptr<IPacketBuffer>& packetBuffer, unsigned int offset)
165 {
166     BOOST_ASSERT(packetBuffer);
167
168     return ReadUint8(packetBuffer->GetReadableData(), offset);
169 }
170
171 uint64_t ReadUint64(const unsigned char* buffer, unsigned int offset)
172 {
173     BOOST_ASSERT(buffer);
174
175     uint64_t value = 0;
176     value  = static_cast<uint64_t>(buffer[offset]);
177     value |= static_cast<uint64_t>(buffer[offset + 1]) << 8;
178     value |= static_cast<uint64_t>(buffer[offset + 2]) << 16;
179     value |= static_cast<uint64_t>(buffer[offset + 3]) << 24;
180     value |= static_cast<uint64_t>(buffer[offset + 4]) << 32;
181     value |= static_cast<uint64_t>(buffer[offset + 5]) << 40;
182     value |= static_cast<uint64_t>(buffer[offset + 6]) << 48;
183     value |= static_cast<uint64_t>(buffer[offset + 7]) << 56;
184
185     return value;
186 }
187
188 uint32_t ReadUint32(const unsigned char* buffer, unsigned int offset)
189 {
190     BOOST_ASSERT(buffer);
191
192     uint32_t value = 0;
193     value  = static_cast<uint32_t>(buffer[offset]);
194     value |= static_cast<uint32_t>(buffer[offset + 1]) << 8;
195     value |= static_cast<uint32_t>(buffer[offset + 2]) << 16;
196     value |= static_cast<uint32_t>(buffer[offset + 3]) << 24;
197     return value;
198 }
199
200 uint16_t ReadUint16(const unsigned char* buffer, unsigned int offset)
201 {
202     BOOST_ASSERT(buffer);
203
204     uint32_t value = 0;
205     value  = static_cast<uint32_t>(buffer[offset]);
206     value |= static_cast<uint32_t>(buffer[offset + 1]) << 8;
207     return static_cast<uint16_t>(value);
208 }
209
210 uint8_t ReadUint8(const unsigned char* buffer, unsigned int offset)
211 {
212     BOOST_ASSERT(buffer);
213
214     return buffer[offset];
215 }
216
217 std::string GetSoftwareInfo()
218 {
219     return std::string("ArmNN");
220 }
221
222 std::string GetHardwareVersion()
223 {
224     return std::string();
225 }
226
227 std::string GetSoftwareVersion()
228 {
229     std::string armnnVersion(ARMNN_VERSION);
230     std::string result = "Armnn " + armnnVersion.substr(2,2) + "." + armnnVersion.substr(4,2);
231     return result;
232 }
233
234 std::string GetProcessName()
235 {
236     std::ifstream comm("/proc/self/comm");
237     std::string name;
238     getline(comm, name);
239     return name;
240 }
241
242 /// Creates a timeline packet header
243 ///
244 /// \params
245 ///   packetFamiliy     Timeline Packet Family
246 ///   packetClass       Timeline Packet Class
247 ///   packetType        Timeline Packet Type
248 ///   streamId          Stream identifier
249 ///   seqeunceNumbered  When non-zero the 4 bytes following the header is a u32 sequence number
250 ///   dataLength        Unsigned 24-bit integer. Length of data, in bytes. Zero is permitted.
251 ///
252 /// \returns
253 ///   Pair of uint32_t containing word0 and word1 of the header
254 std::pair<uint32_t, uint32_t> CreateTimelinePacketHeader(uint32_t packetFamily,
255                                                          uint32_t packetClass,
256                                                          uint32_t packetType,
257                                                          uint32_t streamId,
258                                                          uint32_t sequenceNumbered,
259                                                          uint32_t dataLength)
260 {
261     // Packet header word 0:
262     // 26:31 [6] packet_family: timeline Packet Family, value 0b000001
263     // 19:25 [7] packet_class: packet class
264     // 16:18 [3] packet_type: packet type
265     // 8:15  [8] reserved: all zeros
266     // 0:7   [8] stream_id: stream identifier
267     uint32_t packetHeaderWord0 = ((packetFamily & 0x0000003F) << 26) |
268                                  ((packetClass  & 0x0000007F) << 19) |
269                                  ((packetType   & 0x00000007) << 16) |
270                                  ((streamId     & 0x00000007) <<  0);
271
272     // Packet header word 1:
273     // 25:31 [7]  reserved: all zeros
274     // 24    [1]  sequence_numbered: when non-zero the 4 bytes following the header is a u32 sequence number
275     // 0:23  [24] data_length: unsigned 24-bit integer. Length of data, in bytes. Zero is permitted
276     uint32_t packetHeaderWord1 = ((sequenceNumbered & 0x00000001) << 24) |
277                                  ((dataLength       & 0x00FFFFFF) <<  0);
278
279     return std::make_pair(packetHeaderWord0, packetHeaderWord1);
280 }
281
282 /// Creates a packet header for the timeline messages:
283 /// * declareLabel
284 /// * declareEntity
285 /// * declareEventClass
286 /// * declareRelationship
287 /// * declareEvent
288 ///
289 /// \param
290 ///   Data lenght of the message body in byte
291 ///
292 /// \returns
293 ///   Pair of uint32_t containing word0 and word1 of the header
294 std::pair<uint32_t, uint32_t> CreateTimelineMessagePacketHeader(unsigned int dataLength)
295 {
296     return CreateTimelinePacketHeader(1,0,1,0,0,dataLength);
297 }
298
299 TimelinePacketStatus WriteTimelineLabelBinaryPacket(uint64_t profilingGuid,
300                                                     const std::string& label,
301                                                     unsigned char* buffer,
302                                                     unsigned int bufferSize,
303                                                     unsigned int& numberOfBytesWritten)
304 {
305     // Initialize the ouput value
306     numberOfBytesWritten = 0;
307
308     // Check that the given buffer is valid
309     if (buffer == nullptr || bufferSize == 0)
310     {
311         return TimelinePacketStatus::BufferExhaustion;
312     }
313
314     // Utils
315     unsigned int uint32_t_size = sizeof(uint32_t);
316     unsigned int uint64_t_size = sizeof(uint64_t);
317
318     // Convert the label into a SWTrace string
319     std::vector<uint32_t> swTraceLabel;
320     bool result = StringToSwTraceString<SwTraceCharPolicy>(label, swTraceLabel);
321     if (!result)
322     {
323         return TimelinePacketStatus::Error;
324     }
325
326     // Calculate the size of the SWTrace string label (in bytes)
327     unsigned int swTraceLabelSize = boost::numeric_cast<unsigned int>(swTraceLabel.size()) * uint32_t_size;
328
329     // Calculate the length of the data (in bytes)
330     unsigned int timelineLabelPacketDataLength = uint32_t_size +   // decl_Id
331                                                  uint64_t_size +   // Profiling GUID
332                                                  swTraceLabelSize; // Label
333
334     // Calculate the timeline binary packet size (in bytes)
335     unsigned int timelineLabelPacketSize = 2 * uint32_t_size +            // Header (2 words)
336                                            timelineLabelPacketDataLength; // decl_Id + Profiling GUID + label
337
338     // Check whether the timeline binary packet fits in the given buffer
339     if (timelineLabelPacketSize > bufferSize)
340     {
341         return TimelinePacketStatus::BufferExhaustion;
342     }
343
344     // Create packet header
345     uint32_t dataLength = boost::numeric_cast<uint32_t>(timelineLabelPacketDataLength); // decl_id + GUID + label
346     std::pair<uint32_t, uint32_t> packetHeader = CreateTimelineMessagePacketHeader(dataLength);
347
348     // Initialize the offset for writing in the buffer
349     unsigned int offset = 0;
350
351     // Write the timeline binary packet header to the buffer
352     WriteUint32(buffer, offset, packetHeader.first);
353     offset += uint32_t_size;
354     WriteUint32(buffer, offset, packetHeader.second);
355     offset += uint32_t_size;
356
357     // Write decl_Id to the buffer
358     WriteUint32(buffer, offset, 0u);
359     offset += uint32_t_size;
360
361     // Write the timeline binary packet payload to the buffer
362     WriteUint64(buffer, offset, profilingGuid); // Profiling GUID
363     offset += uint64_t_size;
364     for (uint32_t swTraceLabelWord : swTraceLabel)
365     {
366         WriteUint32(buffer, offset, swTraceLabelWord); // Label
367         offset += uint32_t_size;
368     }
369
370     // Update the number of bytes written
371     numberOfBytesWritten = timelineLabelPacketSize;
372
373     return TimelinePacketStatus::Ok;
374 }
375
376 TimelinePacketStatus WriteTimelineEntityBinaryPacket(uint64_t profilingGuid,
377                                                      unsigned char* buffer,
378                                                      unsigned int bufferSize,
379                                                      unsigned int& numberOfBytesWritten)
380 {
381     // Initialize the ouput value
382     numberOfBytesWritten = 0;
383
384     // Check that the given buffer is valid
385     if (buffer == nullptr || bufferSize == 0)
386     {
387         return TimelinePacketStatus::BufferExhaustion;
388     }
389
390     // Utils
391     unsigned int uint32_t_size = sizeof(uint32_t);
392     unsigned int uint64_t_size = sizeof(uint64_t);
393
394     // Calculate the length of the data (in bytes)
395     unsigned int timelineEntityPacketDataLength = uint64_t_size;   // Profiling GUID
396
397
398     // Calculate the timeline binary packet size (in bytes)
399     unsigned int timelineEntityPacketSize = 2 * uint32_t_size +             // Header (2 words)
400                                             uint32_t_size +                 // decl_Id
401                                             timelineEntityPacketDataLength; // Profiling GUID
402
403     // Check whether the timeline binary packet fits in the given buffer
404     if (timelineEntityPacketSize > bufferSize)
405     {
406         return TimelinePacketStatus::BufferExhaustion;
407     }
408
409     // Create packet header
410     uint32_t dataLength = boost::numeric_cast<uint32_t>(timelineEntityPacketDataLength);
411     std::pair<uint32_t, uint32_t> packetHeader = CreateTimelineMessagePacketHeader(dataLength);
412
413     // Initialize the offset for writing in the buffer
414     unsigned int offset = 0;
415
416     // Write the timeline binary packet header to the buffer
417     WriteUint32(buffer, offset, packetHeader.first);
418     offset += uint32_t_size;
419     WriteUint32(buffer, offset, packetHeader.second);
420     offset += uint32_t_size;
421
422     // Write the decl_Id to the buffer
423     WriteUint32(buffer, offset, 1u);
424     offset += uint32_t_size;
425
426     // Write the timeline binary packet payload to the buffer
427     WriteUint64(buffer, offset, profilingGuid); // Profiling GUID
428
429     // Update the number of bytes written
430     numberOfBytesWritten = timelineEntityPacketSize;
431
432     return TimelinePacketStatus::Ok;
433 }
434
435 TimelinePacketStatus WriteTimelineMessageDirectoryPackage(unsigned char* buffer,
436                                                           unsigned int bufferSize,
437                                                           unsigned int& numberOfBytesWritten)
438 {
439     // Initialize the output value
440     numberOfBytesWritten = 0;
441
442     // Check that the given buffer is valid
443     if (buffer == nullptr || bufferSize == 0)
444     {
445         return TimelinePacketStatus::BufferExhaustion;
446     }
447
448     // Utils
449     unsigned int uint32_t_size = sizeof(uint32_t);
450
451     // the payload/data of the packet consists of swtrace event definitions encoded according
452     // to the swtrace directory specification. The messages being the five defined below:
453     // |  decl_id  |  decl_name          |    ui_name            |  arg_types  |  arg_names                          |
454     // |-----------|---------------------|-----------------------|-------------|-------------------------------------|
455     // |    0      |   declareLabel      |   declare label       |    ps       |  guid,value                         |
456     // |    1      |   declareEntity     |   declare entity      |    p        |  guid                               |
457     // |    2      | declareEventClass   |  declare event class  |    p        |  guid                               |
458     // |    3      | declareRelationship | declare relationship  |    Ippp     |  relationshipType,relationshipGuid,
459     //                                                                            headGuid,tailGuid                  |
460     // |    4      |   declareEvent      |   declare event       |    @tp      |  timestamp,threadId,eventGuid       |
461
462     std::vector<std::vector<std::string>> timelineDirectoryMessages =
463         { {"declareLabel", "declare label", "ps", "guid,value"},
464           {"declareEntity", "declare entity", "p", "guid"},
465           {"declareEventClass", "declare event class", "p", "guid"},
466           {"declareRelationship", "declare relationship",
467               "Ippp", "relationshipType,relationshipGuid,headGuid,tailGuid"},
468           {"declareEvent", "declare event", "@tp", "timestamp,threadId,eventGuid"} };
469
470     unsigned int messagesDataLength = 0u;
471     std::vector<std::vector<std::vector<uint32_t>>> swTraceTimelineDirectoryMessages;
472
473     for (const auto& timelineDirectoryMessage : timelineDirectoryMessages)
474     {
475         messagesDataLength += uint32_t_size; // decl_id
476
477         std::vector<std::vector<uint32_t>> swTraceStringsVector;
478         for (const auto& label : timelineDirectoryMessage)
479         {
480             std::vector<uint32_t> swTraceString;
481             bool result = StringToSwTraceString<SwTraceCharPolicy>(label, swTraceString);
482             if (!result)
483             {
484                 return TimelinePacketStatus::Error;
485             }
486
487             messagesDataLength += boost::numeric_cast<unsigned int>(swTraceString.size()) * uint32_t_size;
488             swTraceStringsVector.push_back(swTraceString);
489         }
490         swTraceTimelineDirectoryMessages.push_back(swTraceStringsVector);
491     }
492
493     // Calculate the timeline directory binary packet size (in bytes)
494     unsigned int timelineDirectoryPacketSize = 2 * uint32_t_size + // Header (2 words)
495                                                messagesDataLength; // 5 messages length
496
497     // Check whether the timeline directory binary packet fits in the given buffer
498     if (timelineDirectoryPacketSize > bufferSize)
499     {
500         return TimelinePacketStatus::BufferExhaustion;
501     }
502
503     // Create packet header
504     uint32_t dataLength        = boost::numeric_cast<uint32_t>(messagesDataLength);
505     std::pair<uint32_t, uint32_t> packetHeader = CreateTimelinePacketHeader(1,0,0,0,0,dataLength);
506
507     // Initialize the offset for writing in the buffer
508     unsigned int offset = 0;
509
510     // Write the timeline binary packet header to the buffer
511     WriteUint32(buffer, offset, packetHeader.first);
512     offset += uint32_t_size;
513     WriteUint32(buffer, offset, packetHeader.second);
514     offset += uint32_t_size;
515
516     for (unsigned int i = 0u; i < swTraceTimelineDirectoryMessages.size(); ++i)
517     {
518         // Write the timeline binary packet payload to the buffer
519         WriteUint32(buffer, offset, i); // decl_id
520         offset += uint32_t_size;
521
522         for (std::vector<uint32_t> swTraceString : swTraceTimelineDirectoryMessages[i])
523         {
524             for (uint32_t swTraceDeclStringWord : swTraceString)
525             {
526                 WriteUint32(buffer, offset, swTraceDeclStringWord);
527                 offset += uint32_t_size;
528             }
529         }
530     }
531
532     // Update the number of bytes written
533     numberOfBytesWritten = timelineDirectoryPacketSize;
534
535     return TimelinePacketStatus::Ok;
536 }
537
538 TimelinePacketStatus WriteTimelineEventClassBinaryPacket(uint64_t profilingGuid,
539                                                          unsigned char* buffer,
540                                                          unsigned int bufferSize,
541                                                          unsigned int& numberOfBytesWritten)
542 {
543     // Initialize the ouput value
544     numberOfBytesWritten = 0;
545
546     // Check that the given buffer is valid
547     if (buffer == nullptr || bufferSize == 0)
548     {
549         return TimelinePacketStatus::BufferExhaustion;
550     }
551
552     // Utils
553     unsigned int uint32_t_size = sizeof(uint32_t);
554     unsigned int uint64_t_size = sizeof(uint64_t);
555
556     // dec_id of the timeline message
557     uint32_t decId = 2;
558
559     // Calculate the length of the data (in bytes)
560     unsigned int packetBodySize = uint32_t_size + uint64_t_size;   // decl_id + Profiling GUID
561
562     // Calculate the timeline binary packet size (in bytes)
563     unsigned int packetSize = 2 * uint32_t_size +   // Header (2 words)
564                               packetBodySize;       // Body
565
566     // Check whether the timeline binary packet fits in the given buffer
567     if (packetSize > bufferSize)
568     {
569         return TimelinePacketStatus::BufferExhaustion;
570     }
571
572     // Create packet header
573     uint32_t dataLength = boost::numeric_cast<uint32_t>(packetBodySize);
574     std::pair<uint32_t, uint32_t> packetHeader = CreateTimelineMessagePacketHeader(dataLength);
575
576     // Initialize the offset for writing in the buffer
577     unsigned int offset = 0;
578
579     // Write the timeline binary packet header to the buffer
580     WriteUint32(buffer, offset, packetHeader.first);
581     offset += uint32_t_size;
582     WriteUint32(buffer, offset, packetHeader.second);
583     offset += uint32_t_size;
584
585     // Write the timeline binary packet payload to the buffer
586     WriteUint32(buffer, offset, decId);         // dec_id
587     offset += uint32_t_size;
588     WriteUint64(buffer, offset, profilingGuid); // Profiling GUID
589
590     // Update the number of bytes written
591     numberOfBytesWritten = packetSize;
592
593     return TimelinePacketStatus::Ok;
594 }
595
596 } // namespace profiling
597
598 } // namespace armnn