blob: 3a70c86413bef8e27d6d05604e2164f8a7fefad4 [file] [log] [blame]
/*
* Copyright (C) 2019 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#ifndef SRC_TRACE_PROCESSOR_FUCHSIA_TRACE_UTILS_H_
#define SRC_TRACE_PROCESSOR_FUCHSIA_TRACE_UTILS_H_
#include <stddef.h>
#include <stdint.h>
#include <functional>
#include "perfetto/ext/base/string_view.h"
#include "src/trace_processor/trace_blob_view.h"
#include "src/trace_processor/trace_storage.h"
namespace perfetto {
namespace trace_processor {
namespace fuchsia_trace_utils {
struct ThreadInfo {
uint64_t pid;
uint64_t tid;
};
template <class T>
T ReadField(uint64_t word, size_t begin, size_t end) {
return static_cast<T>((word >> begin) &
((uint64_t(1) << (end - begin + 1)) - 1));
}
bool IsInlineString(uint32_t);
bool IsInlineThread(uint32_t);
int64_t TicksToNs(uint64_t ticks, uint64_t ticks_per_second);
class ArgValue {
public:
enum ArgType {
kNull,
kInt32,
kUint32,
kInt64,
kUint64,
kDouble,
kString,
kPointer,
kKoid,
kUnknown,
};
static ArgValue Null() {
ArgValue v;
v.type_ = ArgType::kNull;
v.int32_ = 0;
return v;
}
static ArgValue Int32(int32_t value) {
ArgValue v;
v.type_ = ArgType::kInt32;
v.int32_ = value;
return v;
}
static ArgValue Uint32(uint32_t value) {
ArgValue v;
v.type_ = ArgType::kUint32;
v.uint32_ = value;
return v;
}
static ArgValue Int64(int64_t value) {
ArgValue v;
v.type_ = ArgType::kInt64;
v.int64_ = value;
return v;
}
static ArgValue Uint64(uint64_t value) {
ArgValue v;
v.type_ = ArgType::kUint64;
v.uint64_ = value;
return v;
}
static ArgValue Double(double value) {
ArgValue v;
v.type_ = ArgType::kDouble;
v.double_ = value;
return v;
}
static ArgValue String(StringId value) {
ArgValue v;
v.type_ = ArgType::kString;
v.string_ = value;
return v;
}
static ArgValue Pointer(uint64_t value) {
ArgValue v;
v.type_ = ArgType::kPointer;
v.pointer_ = value;
return v;
}
static ArgValue Koid(uint64_t value) {
ArgValue v;
v.type_ = ArgType::kKoid;
v.koid_ = value;
return v;
}
static ArgValue Unknown() {
ArgValue v;
v.type_ = ArgType::kUnknown;
v.int32_ = 0;
return v;
}
ArgType Type() const { return type_; }
int32_t Int32() const {
PERFETTO_DCHECK(type_ == ArgType::kInt32);
return int32_;
}
uint32_t Uint32() const {
PERFETTO_DCHECK(type_ == ArgType::kUint32);
return uint32_;
}
int64_t Int64() const {
PERFETTO_DCHECK(type_ == ArgType::kInt64);
return int64_;
}
uint64_t Uint64() const {
PERFETTO_DCHECK(type_ == ArgType::kUint64);
return uint64_;
}
double Double() const {
PERFETTO_DCHECK(type_ == ArgType::kDouble);
return double_;
}
StringId String() const {
PERFETTO_DCHECK(type_ == ArgType::kString);
return string_;
}
uint64_t Pointer() const {
PERFETTO_DCHECK(type_ == ArgType::kPointer);
return pointer_;
}
uint64_t Koid() const {
PERFETTO_DCHECK(type_ == ArgType::kKoid);
return koid_;
}
Variadic ToStorageVariadic(TraceStorage*) const;
private:
ArgType type_;
union {
int32_t int32_;
uint32_t uint32_;
int64_t int64_;
uint64_t uint64_;
double double_;
StringId string_;
uint64_t pointer_;
uint64_t koid_;
};
};
// This class maintains a location into the record, with helper functions to
// read various trace data from the current location in a safe manner.
//
// In the context of Fuchsia trace records, a "word" is defined as 64 bits
// regardless of platform. For more information, see
// https://fuchsia.googlesource.com/fuchsia/+/refs/heads/master/docs/development/tracing/trace-format/
class RecordCursor {
public:
RecordCursor(const TraceBlobView* tbv) : tbv_(*tbv), word_index_(0) {}
size_t WordIndex();
void SetWordIndex(size_t index);
bool ReadTimestamp(uint64_t ticks_per_second, int64_t* ts_out);
bool ReadInlineString(uint32_t string_ref_or_len,
base::StringView* string_out);
bool ReadInlineThread(ThreadInfo* thread_out);
bool ReadInt64(int64_t* out);
bool ReadUint64(uint64_t* out);
bool ReadDouble(double* out);
private:
bool ReadWords(size_t num_words, const uint64_t** data_out);
const TraceBlobView& tbv_;
size_t word_index_;
};
} // namespace fuchsia_trace_utils
} // namespace trace_processor
} // namespace perfetto
#endif // SRC_TRACE_PROCESSOR_FUCHSIA_TRACE_UTILS_H_