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 ///   dataLength The length of the message body in bytes
 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,           // Packet family
 297                                       0,           // Packet class
 298                                       1,           // Packet type
 299                                       0,           // Stream id
 300                                       0,           // Sequence number
 301                                       dataLength); // Data length
 302 }
 303
 304 TimelinePacketStatus WriteTimelineLabelBinaryPacket(uint64_t profilingGuid,
 305                                                     const std::string& label,
 306                                                     unsigned char* buffer,
 307                                                     unsigned int bufferSize,
 308                                                     unsigned int& numberOfBytesWritten)
 309 {
 310     // Initialize the output value
 311     numberOfBytesWritten = 0;
 312
 313     // Check that the given buffer is valid
 314     if (buffer == nullptr || bufferSize == 0)
 315     {
 316         return TimelinePacketStatus::BufferExhaustion;
 317     }
 318
 319     // Utils
 320     unsigned int uint32_t_size = sizeof(uint32_t);
 321     unsigned int uint64_t_size = sizeof(uint64_t);
 322
 323     // Convert the label into a SWTrace string
 324     std::vector<uint32_t> swTraceLabel;
 325     bool result = StringToSwTraceString<SwTraceCharPolicy>(label, swTraceLabel);
 326     if (!result)
 327     {
 328         return TimelinePacketStatus::Error;
 329     }
 330
 331     // Calculate the size of the SWTrace string label (in bytes)
 332     unsigned int swTraceLabelSize = boost::numeric_cast<unsigned int>(swTraceLabel.size()) * uint32_t_size;
 333
 334     // Calculate the length of the data (in bytes)
 335     unsigned int timelineLabelPacketDataLength = uint32_t_size +   // decl_Id
 336                                                  uint64_t_size +   // Profiling GUID
 337                                                  swTraceLabelSize; // Label
 338
 339     // Calculate the timeline binary packet size (in bytes)
 340     unsigned int timelineLabelPacketSize = 2 * uint32_t_size +            // Header (2 words)
 341                                            timelineLabelPacketDataLength; // decl_Id + Profiling GUID + label
 342
 343     // Check whether the timeline binary packet fits in the given buffer
 344     if (timelineLabelPacketSize > bufferSize)
 345     {
 346         return TimelinePacketStatus::BufferExhaustion;
 347     }
 348
 349     // Create packet header
 350     std::pair<uint32_t, uint32_t> packetHeader = CreateTimelineMessagePacketHeader(timelineLabelPacketDataLength);
 351
 352     // Initialize the offset for writing in the buffer
 353     unsigned int offset = 0;
 354
 355     // Write the timeline binary packet header to the buffer
 356     WriteUint32(buffer, offset, packetHeader.first);
 357     offset += uint32_t_size;
 358     WriteUint32(buffer, offset, packetHeader.second);
 359     offset += uint32_t_size;
 360
 361     // Write decl_Id to the buffer
 362     WriteUint32(buffer, offset, 0u);
 363     offset += uint32_t_size;
 364
 365     // Write the timeline binary packet payload to the buffer
 366     WriteUint64(buffer, offset, profilingGuid); // Profiling GUID
 367     offset += uint64_t_size;
 368     for (uint32_t swTraceLabelWord : swTraceLabel)
 369     {
 370         WriteUint32(buffer, offset, swTraceLabelWord); // Label
 371         offset += uint32_t_size;
 372     }
 373
 374     // Update the number of bytes written
 375     numberOfBytesWritten = timelineLabelPacketSize;
 376
 377     return TimelinePacketStatus::Ok;
 378 }
 379
 380 TimelinePacketStatus WriteTimelineEntityBinaryPacket(uint64_t profilingGuid,
 381                                                      unsigned char* buffer,
 382                                                      unsigned int bufferSize,
 383                                                      unsigned int& numberOfBytesWritten)
 384 {
 385     // Initialize the output value
 386     numberOfBytesWritten = 0;
 387
 388     // Check that the given buffer is valid
 389     if (buffer == nullptr || bufferSize == 0)
 390     {
 391         return TimelinePacketStatus::BufferExhaustion;
 392     }
 393
 394     // Utils
 395     unsigned int uint32_t_size = sizeof(uint32_t);
 396     unsigned int uint64_t_size = sizeof(uint64_t);
 397
 398     // Calculate the length of the data (in bytes)
 399     unsigned int timelineEntityPacketDataLength = uint64_t_size;   // Profiling GUID
 400
 401
 402     // Calculate the timeline binary packet size (in bytes)
 403     unsigned int timelineEntityPacketSize = 2 * uint32_t_size +             // Header (2 words)
 404                                             uint32_t_size +                 // decl_Id
 405                                             timelineEntityPacketDataLength; // Profiling GUID
 406
 407     // Check whether the timeline binary packet fits in the given buffer
 408     if (timelineEntityPacketSize > bufferSize)
 409     {
 410         return TimelinePacketStatus::BufferExhaustion;
 411     }
 412
 413     // Create packet header
 414     std::pair<uint32_t, uint32_t> packetHeader = CreateTimelineMessagePacketHeader(timelineEntityPacketDataLength);
 415
 416     // Initialize the offset for writing in the buffer
 417     unsigned int offset = 0;
 418
 419     // Write the timeline binary packet header to the buffer
 420     WriteUint32(buffer, offset, packetHeader.first);
 421     offset += uint32_t_size;
 422     WriteUint32(buffer, offset, packetHeader.second);
 423     offset += uint32_t_size;
 424
 425     // Write the decl_Id to the buffer
 426     WriteUint32(buffer, offset, 1u);
 427     offset += uint32_t_size;
 428
 429     // Write the timeline binary packet payload to the buffer
 430     WriteUint64(buffer, offset, profilingGuid); // Profiling GUID
 431
 432     // Update the number of bytes written
 433     numberOfBytesWritten = timelineEntityPacketSize;
 434
 435     return TimelinePacketStatus::Ok;
 436 }
 437
 438 TimelinePacketStatus WriteTimelineMessageDirectoryPackage(unsigned char* buffer,
 439                                                           unsigned int bufferSize,
 440                                                           unsigned int& numberOfBytesWritten)
 441 {
 442     // Initialize the output value
 443     numberOfBytesWritten = 0;
 444
 445     // Check that the given buffer is valid
 446     if (buffer == nullptr || bufferSize == 0)
 447     {
 448         return TimelinePacketStatus::BufferExhaustion;
 449     }
 450
 451     // Utils
 452     unsigned int uint32_t_size = sizeof(uint32_t);
 453
 454     // The payload/data of the packet consists of swtrace event definitions encoded according
 455     // to the swtrace directory specification. The messages being the five defined below:
 456     // |  decl_id  |  decl_name          |    ui_name            |  arg_types  |  arg_names                          |
 457     // |-----------|---------------------|-----------------------|-------------|-------------------------------------|
 458     // |    0      |   declareLabel      |   declare label       |    ps       |  guid,value                         |
 459     // |    1      |   declareEntity     |   declare entity      |    p        |  guid                               |
 460     // |    2      | declareEventClass   |  declare event class  |    p        |  guid                               |
 461     // |    3      | declareRelationship | declare relationship  |    Ippp     |  relationshipType,relationshipGuid, |
 462     // |           |                     |                       |             |  headGuid,tailGuid                  |
 463     // |    4      |   declareEvent      |   declare event       |    @tp      |  timestamp,threadId,eventGuid       |
 464
 465     std::vector<std::vector<std::string>> timelineDirectoryMessages
 466     {
 467         {"declareLabel", "declare label", "ps", "guid,value"},
 468         {"declareEntity", "declare entity", "p", "guid"},
 469         {"declareEventClass", "declare event class", "p", "guid"},
 470         {"declareRelationship", "declare relationship", "Ippp", "relationshipType,relationshipGuid,headGuid,tailGuid"},
 471         {"declareEvent", "declare event", "@tp", "timestamp,threadId,eventGuid"}
 472     };
 473
 474     unsigned int messagesDataLength = 0u;
 475     std::vector<std::vector<std::vector<uint32_t>>> swTraceTimelineDirectoryMessages;
 476
 477     for (const auto& timelineDirectoryMessage : timelineDirectoryMessages)
 478     {
 479         messagesDataLength += uint32_t_size; // decl_id
 480
 481         std::vector<std::vector<uint32_t>> swTraceStringsVector;
 482         for (const auto& label : timelineDirectoryMessage)
 483         {
 484             std::vector<uint32_t> swTraceString;
 485             bool result = StringToSwTraceString<SwTraceCharPolicy>(label, swTraceString);
 486             if (!result)
 487             {
 488                 return TimelinePacketStatus::Error;
 489             }
 490
 491             messagesDataLength += boost::numeric_cast<unsigned int>(swTraceString.size()) * uint32_t_size;
 492             swTraceStringsVector.push_back(swTraceString);
 493         }
 494         swTraceTimelineDirectoryMessages.push_back(swTraceStringsVector);
 495     }
 496
 497     // Calculate the timeline directory binary packet size (in bytes)
 498     unsigned int timelineDirectoryPacketSize = 2 * uint32_t_size + // Header (2 words)
 499                                                messagesDataLength; // 5 messages length
 500
 501     // Check whether the timeline directory binary packet fits in the given buffer
 502     if (timelineDirectoryPacketSize > bufferSize)
 503     {
 504         return TimelinePacketStatus::BufferExhaustion;
 505     }
 506
 507     // Create packet header
 508     uint32_t dataLength = boost::numeric_cast<uint32_t>(messagesDataLength);
 509     std::pair<uint32_t, uint32_t> packetHeader = CreateTimelinePacketHeader(1, 0, 0, 0, 0, dataLength);
 510
 511     // Initialize the offset for writing in the buffer
 512     unsigned int offset = 0;
 513
 514     // Write the timeline binary packet header to the buffer
 515     WriteUint32(buffer, offset, packetHeader.first);
 516     offset += uint32_t_size;
 517     WriteUint32(buffer, offset, packetHeader.second);
 518     offset += uint32_t_size;
 519
 520     for (unsigned int i = 0u; i < swTraceTimelineDirectoryMessages.size(); ++i)
 521     {
 522         // Write the timeline binary packet payload to the buffer
 523         WriteUint32(buffer, offset, i); // decl_id
 524         offset += uint32_t_size;
 525
 526         for (std::vector<uint32_t> swTraceString : swTraceTimelineDirectoryMessages[i])
 527         {
 528             for (uint32_t swTraceDeclStringWord : swTraceString)
 529             {
 530                 WriteUint32(buffer, offset, swTraceDeclStringWord);
 531                 offset += uint32_t_size;
 532             }
 533         }
 534     }
 535
 536     // Update the number of bytes written
 537     numberOfBytesWritten = timelineDirectoryPacketSize;
 538
 539     return TimelinePacketStatus::Ok;
 540 }
 541
 542 TimelinePacketStatus WriteTimelineEventClassBinaryPacket(uint64_t profilingGuid,
 543                                                          unsigned char* buffer,
 544                                                          unsigned int bufferSize,
 545                                                          unsigned int& numberOfBytesWritten)
 546 {
 547     // Initialize the output value
 548     numberOfBytesWritten = 0;
 549
 550     // Check that the given buffer is valid
 551     if (buffer == nullptr || bufferSize == 0)
 552     {
 553         return TimelinePacketStatus::BufferExhaustion;
 554     }
 555
 556     // Utils
 557     unsigned int uint32_t_size = sizeof(uint32_t);
 558     unsigned int uint64_t_size = sizeof(uint64_t);
 559
 560     // decl_id of the timeline message
 561     uint32_t declId = 2;
 562
 563     // Calculate the length of the data (in bytes)
 564     unsigned int packetBodySize = uint32_t_size + uint64_t_size; // decl_id + Profiling GUID
 565
 566     // Calculate the timeline binary packet size (in bytes)
 567     unsigned int packetSize = 2 * uint32_t_size + // Header (2 words)
 568                               packetBodySize;     // Body
 569
 570     // Check whether the timeline binary packet fits in the given buffer
 571     if (packetSize > bufferSize)
 572     {
 573         return TimelinePacketStatus::BufferExhaustion;
 574     }
 575
 576     // Create packet header
 577     std::pair<uint32_t, uint32_t> packetHeader = CreateTimelineMessagePacketHeader(packetBodySize);
 578
 579     // Initialize the offset for writing in the buffer
 580     unsigned int offset = 0;
 581
 582     // Write the timeline binary packet header to the buffer
 583     WriteUint32(buffer, offset, packetHeader.first);
 584     offset += uint32_t_size;
 585     WriteUint32(buffer, offset, packetHeader.second);
 586     offset += uint32_t_size;
 587
 588     // Write the timeline binary packet payload to the buffer
 589     WriteUint32(buffer, offset, declId);        // decl_id
 590     offset += uint32_t_size;
 591     WriteUint64(buffer, offset, profilingGuid); // Profiling GUID
 592
 593     // Update the number of bytes written
 594     numberOfBytesWritten = packetSize;
 595
 596     return TimelinePacketStatus::Ok;
 597 }
 598
 599 TimelinePacketStatus WriteTimelineEventBinaryPacket(uint64_t timestamp,
 600                                                     uint32_t threadId,
 601                                                     uint64_t profilingGuid,
 602                                                     unsigned char* buffer,
 603                                                     unsigned int bufferSize,
 604                                                     unsigned int& numberOfBytesWritten)
 605 {
 606     // Initialize the output value
 607     numberOfBytesWritten = 0;
 608
 609     // Check that the given buffer is valid
 610     if (buffer == nullptr || bufferSize == 0)
 611     {
 612         return TimelinePacketStatus::BufferExhaustion;
 613     }
 614
 615     // Utils
 616     unsigned int uint32_t_size = sizeof(uint32_t);
 617     unsigned int uint64_t_size = sizeof(uint64_t);
 618
 619     // decl_id of the timeline message
 620     uint32_t declId = 4;
 621
 622     // Calculate the length of the data (in bytes)
 623     unsigned int timelineEventPacketDataLength = uint32_t_size + // decl_id
 624                                                  uint64_t_size + // Timestamp
 625                                                  uint32_t_size + // Thread id
 626                                                  uint64_t_size;  // Profiling GUID
 627
 628     // Calculate the timeline binary packet size (in bytes)
 629     unsigned int timelineEventPacketSize = 2 * uint32_t_size +            // Header (2 words)
 630                                            timelineEventPacketDataLength; // Timestamp + thread id + profiling GUID
 631
 632     // Check whether the timeline binary packet fits in the given buffer
 633     if (timelineEventPacketSize > bufferSize)
 634     {
 635         return TimelinePacketStatus::BufferExhaustion;
 636     }
 637
 638     // Create packet header
 639     std::pair<uint32_t, uint32_t> packetHeader = CreateTimelineMessagePacketHeader(timelineEventPacketDataLength);
 640
 641     // Initialize the offset for writing in the buffer
 642     unsigned int offset = 0;
 643
 644     // Write the timeline binary packet header to the buffer
 645     WriteUint32(buffer, offset, packetHeader.first);
 646     offset += uint32_t_size;
 647     WriteUint32(buffer, offset, packetHeader.second);
 648     offset += uint32_t_size;
 649
 650     // Write the timeline binary packet payload to the buffer
 651     WriteUint32(buffer, offset, declId); // decl_id
 652     offset += uint32_t_size;
 653     WriteUint64(buffer, offset, timestamp); // Timestamp
 654     offset += uint64_t_size;
 655     WriteUint32(buffer, offset, threadId); // Thread id
 656     offset += uint32_t_size;
 657     WriteUint64(buffer, offset, profilingGuid); // Profiling GUID
 658     offset += uint64_t_size;
 659
 660     // Update the number of bytes written
 661     numberOfBytesWritten = timelineEventPacketSize;
 662
 663     return TimelinePacketStatus::Ok;
 664 }
 665
 666 } // namespace profiling
 667
 668 } // namespace armnn