1*ec63e07aSXin Li // Copyright 2019 Google LLC 2*ec63e07aSXin Li // 3*ec63e07aSXin Li // Licensed under the Apache License, Version 2.0 (the "License"); 4*ec63e07aSXin Li // you may not use this file except in compliance with the License. 5*ec63e07aSXin Li // You may obtain a copy of the License at 6*ec63e07aSXin Li // 7*ec63e07aSXin Li // https://www.apache.org/licenses/LICENSE-2.0 8*ec63e07aSXin Li // 9*ec63e07aSXin Li // Unless required by applicable law or agreed to in writing, software 10*ec63e07aSXin Li // distributed under the License is distributed on an "AS IS" BASIS, 11*ec63e07aSXin Li // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12*ec63e07aSXin Li // See the License for the specific language governing permissions and 13*ec63e07aSXin Li // limitations under the License. 14*ec63e07aSXin Li 15*ec63e07aSXin Li // The sandbox2::StackTrace class provides static methods useful when analyzing 16*ec63e07aSXin Li // call-stack of the process. It uses libunwind-ptrace, so the process must be 17*ec63e07aSXin Li // in a stopped state to call those methods. 18*ec63e07aSXin Li 19*ec63e07aSXin Li #ifndef SANDBOXED_API_SANDBOX2_STACK_TRACE_H_ 20*ec63e07aSXin Li #define SANDBOXED_API_SANDBOX2_STACK_TRACE_H_ 21*ec63e07aSXin Li 22*ec63e07aSXin Li #include <cstddef> 23*ec63e07aSXin Li #include <memory> 24*ec63e07aSXin Li #include <string> 25*ec63e07aSXin Li #include <utility> 26*ec63e07aSXin Li #include <vector> 27*ec63e07aSXin Li 28*ec63e07aSXin Li #include "absl/log/check.h" 29*ec63e07aSXin Li #include "absl/status/statusor.h" 30*ec63e07aSXin Li #include "sandboxed_api/sandbox2/comms.h" 31*ec63e07aSXin Li #include "sandboxed_api/sandbox2/executor.h" 32*ec63e07aSXin Li #include "sandboxed_api/sandbox2/namespace.h" 33*ec63e07aSXin Li #include "sandboxed_api/sandbox2/policy.h" 34*ec63e07aSXin Li #include "sandboxed_api/sandbox2/regs.h" 35*ec63e07aSXin Li #include "sandboxed_api/sandbox2/result.h" 36*ec63e07aSXin Li 37*ec63e07aSXin Li namespace sandbox2 { 38*ec63e07aSXin Li 39*ec63e07aSXin Li class Sandbox2; 40*ec63e07aSXin Li class StackTraceTestPeer; 41*ec63e07aSXin Li 42*ec63e07aSXin Li namespace internal { 43*ec63e07aSXin Li 44*ec63e07aSXin Li class SandboxPeer { 45*ec63e07aSXin Li public: Spawn(std::unique_ptr<Executor> executor,std::unique_ptr<Policy> policy)46*ec63e07aSXin Li static std::unique_ptr<SandboxPeer> Spawn(std::unique_ptr<Executor> executor, 47*ec63e07aSXin Li std::unique_ptr<Policy> policy) { 48*ec63e07aSXin Li CHECK_NE(spawn_fn_, nullptr); 49*ec63e07aSXin Li return spawn_fn_(std::move(executor), std::move(policy)); 50*ec63e07aSXin Li } 51*ec63e07aSXin Li 52*ec63e07aSXin Li virtual ~SandboxPeer() = default; 53*ec63e07aSXin Li 54*ec63e07aSXin Li virtual Comms* comms() = 0; 55*ec63e07aSXin Li virtual void Kill() = 0; 56*ec63e07aSXin Li virtual Result AwaitResult() = 0; 57*ec63e07aSXin Li 58*ec63e07aSXin Li private: 59*ec63e07aSXin Li friend class ::sandbox2::Sandbox2; 60*ec63e07aSXin Li friend class ::sandbox2::StackTraceTestPeer; 61*ec63e07aSXin Li using SpawnFn = std::unique_ptr<SandboxPeer> (*)(std::unique_ptr<Executor>, 62*ec63e07aSXin Li std::unique_ptr<Policy>); 63*ec63e07aSXin Li static SpawnFn spawn_fn_; 64*ec63e07aSXin Li }; 65*ec63e07aSXin Li 66*ec63e07aSXin Li } // namespace internal 67*ec63e07aSXin Li 68*ec63e07aSXin Li // Maximum depth of analyzed call stack. 69*ec63e07aSXin Li constexpr size_t kDefaultMaxFrames = 200; 70*ec63e07aSXin Li 71*ec63e07aSXin Li // Returns the stack-trace of the PID=pid, one line per frame. 72*ec63e07aSXin Li absl::StatusOr<std::vector<std::string>> GetStackTrace( 73*ec63e07aSXin Li const Regs* regs, const Namespace* ns, bool uses_custom_forkserver, 74*ec63e07aSXin Li int recursion_depth); 75*ec63e07aSXin Li 76*ec63e07aSXin Li // Returns a stack trace that collapses duplicate stack frames and annotates 77*ec63e07aSXin Li // them with a repetition count. 78*ec63e07aSXin Li // Example: 79*ec63e07aSXin Li // _start _start 80*ec63e07aSXin Li // main main 81*ec63e07aSXin Li // recursive_call recursive_call 82*ec63e07aSXin Li // recursive_call (previous frame repeated 2 times) 83*ec63e07aSXin Li // recursive_call tail_call 84*ec63e07aSXin Li // tail_call 85*ec63e07aSXin Li std::vector<std::string> CompactStackTrace( 86*ec63e07aSXin Li const std::vector<std::string>& stack_trace); 87*ec63e07aSXin Li 88*ec63e07aSXin Li } // namespace sandbox2 89*ec63e07aSXin Li 90*ec63e07aSXin Li #endif // SANDBOXED_API_SANDBOX2_STACK_TRACE_H_ 91