mirror of
https://fuchsia.googlesource.com/third_party/pigweed.googlesource.com/pigweed/pigweed
synced 2024-09-20 13:51:05 +00:00
179aa8eab0
Initial commit for the pw_snapshot module that introduces the proto format for device snapshots, and documentation that introduces the pw_snapshot module and how to use it. Change-Id: I63e12d245073e82de03be995a001a0ee0cc1f443 Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/38103 Commit-Queue: Armando Montanez <amontanez@google.com> Reviewed-by: Ewout van Bekkum <ewout@google.com> Reviewed-by: Keir Mierle <keir@google.com> Reviewed-by: David Rogers <davidrogers@google.com>
88 lines
3.5 KiB
Protocol Buffer
88 lines
3.5 KiB
Protocol Buffer
// Copyright 2021 The Pigweed Authors
|
||
//
|
||
// 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
|
||
//
|
||
// https://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.
|
||
syntax = "proto3";
|
||
|
||
package pw.thread;
|
||
|
||
option java_package = "pw.thread.proto";
|
||
option java_outer_classname = "Thread";
|
||
|
||
message ThreadState {
|
||
enum Enum {
|
||
// Thread state is invalid or cannot be expressed by this enum.
|
||
UNKNOWN = 0;
|
||
// Interrupt handling is often done on a stack that isn't associated with a
|
||
// true RTOS thread. This state indicates the provided thread info is for an
|
||
// interrupt handler.
|
||
INTERRUPT_HANDLER = 1;
|
||
// This is the currently active thread as marked by the RTOS. In crashes in
|
||
// interrupt contexts, this isn’t necessarily the thread that crashed.
|
||
RUNNING = 2;
|
||
// Thread is ready to run, but isn’t currently running.
|
||
READY = 3;
|
||
// The thread is not ready to run, and will not be ready to run until it is
|
||
// explicitly resumed.
|
||
SUSPENDED = 4;
|
||
// The thread is waiting on something before it can run again.
|
||
BLOCKED = 5;
|
||
// The thread is either not yet initialized, or has terminated. In other
|
||
// words, this thread is a suspended thread that cannot be unsuspended.
|
||
INACTIVE = 6;
|
||
}
|
||
}
|
||
|
||
message Thread {
|
||
// Thread names must be unique; this allows extensions of Snapshot to augment
|
||
// threads with additional data. This should either be human readable text, or
|
||
// tokenized data (e.g. base-64 encoded or binary data).
|
||
bytes name = 1;
|
||
|
||
// Whether or not this thread is the thread is the currently active context
|
||
// at the time of capture. For multi-thread dumps, this field should only be
|
||
// set on ONE thread.
|
||
//
|
||
// Note: in interrupt contexts, the active thread may not be the thread that
|
||
// is in the THREAD_STATE_RUNNING state.
|
||
bool active = 2;
|
||
|
||
// A summarized thread state. RTOS-specific extensions of the Thread message
|
||
// may provide more specific thread state information.
|
||
ThreadState.Enum state = 3;
|
||
|
||
// Contents of a stack trace. It is expected that this stack is pre-walked,
|
||
// and contains addresses. Most recent stack events are at the beginning of
|
||
// the captured stack trace.
|
||
repeated uint64 raw_backtrace = 4;
|
||
|
||
// Results of symbolizing stack_entries. This is usually not provided by the
|
||
// device, but instead by server/host side processing.
|
||
repeated string symbolized_backtrace = 5;
|
||
|
||
// This should contain the raw contents of the thread's stack. This might not
|
||
// match stack_size. It can be larger due to a stack overflow, or smaller due
|
||
// to the implementation deciding to only capture a portion of the stack.
|
||
// Partial stack captures are typically a result of storage/memory
|
||
// limitations.
|
||
bytes raw_stack = 6;
|
||
|
||
// Thread stack related information. Helpful for identifying stack overflows.
|
||
uint64 stack_size = 7;
|
||
uint64 stack_start_pointer = 8;
|
||
uint64 stack_pointer = 9;
|
||
|
||
// CPU usage info. This is the percentage of CPU time the thread has been
|
||
// active in hundredths of a percent. (e.g. 5.00% = 500u)
|
||
uint32 cpu_usage_hundredths = 10;
|
||
}
|