java-debugging-jdwp-client 0.20.0

// ThreadReference command implementations
//
// Commands for working with threads (frames, status, suspend/resume)

use crate::commands::{command_sets, thread_commands};
use crate::connection::JdwpConnection;
use crate::protocol::{CommandPacket, JdwpResult};
use crate::reader::{read_i32, read_string, read_u64};
use crate::types::{FrameId, Location, ObjectId, ThreadId};
use bytes::BufMut;
use serde::{Deserialize, Serialize};

/// Stack frame information
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Frame {
    pub frame_id: FrameId,
    pub location: Location,
}

/// One monitor (lock) object, as JDWP reports it in a tagged-objectID.
///
/// The `object_id` is the identity that matters: correlating "thread A holds this" with "thread B is
/// waiting for this" is a comparison of these ids, and that comparison is the whole of deadlock
/// detection by eye.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
pub struct Monitor {
    /// JDWP type tag of the monitor object (`'L'` for a plain object, `'['` for an array, …).
    pub tag: u8,
    pub object_id: ObjectId,
}

impl JdwpConnection {
    /// Get stack frames for a thread (ThreadReference.Frames command)
    ///
    /// # Errors
    /// Returns a [`JdwpError`](crate::JdwpError) if the JDWP request fails or the reply cannot be parsed.
    pub async fn get_frames(
        &mut self,
        thread_id: ThreadId,
        start_frame: i32,
        length: i32,
    ) -> JdwpResult<Vec<Frame>> {
        let id = self.next_id();
        let mut packet = CommandPacket::new(id, command_sets::THREAD_REFERENCE, thread_commands::FRAMES);

        // Write thread ID
        packet.data.put_u64(thread_id);
        // Start frame (0 = current/top frame)
        packet.data.put_i32(start_frame);
        // Length (-1 = all frames)
        packet.data.put_i32(length);

        let reply = self.send_command(packet).await?;
        reply.check_error()?;

        let mut data = reply.data();

        // Read number of frames
        let frames_count = read_i32(&mut data)?;
        let mut frames = Vec::with_capacity(usize::try_from(frames_count).unwrap_or(0));

        for _ in 0..frames_count {
            let frame_id = read_u64(&mut data)?;

            // Read location
            let type_tag = crate::reader::read_u8(&mut data)?;
            let class_id = read_u64(&mut data)?;
            let method_id = read_u64(&mut data)?;
            let index = read_u64(&mut data)?;

            frames.push(Frame { frame_id, location: Location { type_tag, class_id, method_id, index } });
        }

        Ok(frames)
    }

    /// The monitors this thread currently **holds** (ThreadReference.OwnedMonitors, command 8).
    ///
    /// Half of what a deadlock investigation consists of; the other half is
    /// [`current_contended_monitor`](Self::current_contended_monitor). Cross-referencing the two across
    /// threads — A holds what B waits for, and vice versa — is what makes a lock cycle visible, which is
    /// otherwise unanswerable through this tool.
    ///
    /// **The thread must be suspended.** A running thread's lock set is not a well-defined thing to
    /// read, so the JVM answers `THREAD_NOT_SUSPENDED` (13) rather than a snapshot that was never true.
    /// Requires the JVM's `canGetOwnedMonitorInfo` (see [`capabilities`](Self::capabilities)); without it
    /// the answer is `NOT_IMPLEMENTED` (99).
    ///
    /// # Errors
    /// Returns a [`JdwpError`](crate::JdwpError) if the JDWP request fails or the reply cannot be parsed.
    pub async fn owned_monitors(&mut self, thread_id: ThreadId) -> JdwpResult<Vec<Monitor>> {
        let id = self.next_id();
        let mut packet =
            CommandPacket::new(id, command_sets::THREAD_REFERENCE, thread_commands::OWNED_MONITORS);
        packet.data.put_u64(thread_id);

        let reply = self.send_command(packet).await?;
        reply.check_error()?;

        let mut data = reply.data();
        let count = read_i32(&mut data)?;
        let mut monitors = Vec::with_capacity(usize::try_from(count).unwrap_or(0));
        for _ in 0..count {
            // Each entry is a tagged-objectID: one tag byte then the object id.
            let tag = crate::reader::read_u8(&mut data)?;
            let object_id = read_u64(&mut data)?;
            monitors.push(Monitor { tag, object_id });
        }
        Ok(monitors)
    }

    /// The monitor this thread is **blocked waiting to enter**, if any
    /// (ThreadReference.CurrentContendedMonitor, command 9).
    ///
    /// `None` means the thread is not contending for a lock — the common case, and not an error. A
    /// thread parked in `Object.wait()` reports the monitor it will re-acquire.
    ///
    /// **The thread must be suspended**, and the JVM must report `canGetCurrentContendedMonitor`; see
    /// [`owned_monitors`](Self::owned_monitors) for why both hold.
    ///
    /// # Errors
    /// Returns a [`JdwpError`](crate::JdwpError) if the JDWP request fails or the reply cannot be parsed.
    pub async fn current_contended_monitor(&mut self, thread_id: ThreadId) -> JdwpResult<Option<Monitor>> {
        let id = self.next_id();
        let mut packet = CommandPacket::new(
            id,
            command_sets::THREAD_REFERENCE,
            thread_commands::CURRENT_CONTENDED_MONITOR,
        );
        packet.data.put_u64(thread_id);

        let reply = self.send_command(packet).await?;
        reply.check_error()?;

        let mut data = reply.data();
        let tag = crate::reader::read_u8(&mut data)?;
        let object_id = read_u64(&mut data)?;
        // A null objectID (0) is how "not waiting on anything" comes back, whatever the tag says.
        Ok((object_id != 0).then_some(Monitor { tag, object_id }))
    }

    /// Get all threads (VirtualMachine.AllThreads)
    ///
    /// # Errors
    /// Returns a [`JdwpError`](crate::JdwpError) if the JDWP request fails or the reply cannot be parsed.
    pub async fn get_all_threads(&mut self) -> JdwpResult<Vec<ThreadId>> {
        let id = self.next_id();
        let packet =
            CommandPacket::new(id, command_sets::VIRTUAL_MACHINE, crate::commands::vm_commands::ALL_THREADS);

        let reply = self.send_command(packet).await?;
        reply.check_error()?;

        let mut data = reply.data();

        let threads_count = read_i32(&mut data)?;
        let mut threads = Vec::with_capacity(usize::try_from(threads_count).unwrap_or(0));

        for _ in 0..threads_count {
            threads.push(read_u64(&mut data)?);
        }

        Ok(threads)
    }

    /// Get a thread's name (ThreadReference.Name).
    ///
    /// # Errors
    /// Returns a [`JdwpError`](crate::JdwpError) if the JDWP request fails or the reply cannot be parsed.
    pub async fn get_thread_name(&mut self, thread_id: ThreadId) -> JdwpResult<String> {
        let packet = self.thread_read_request(thread_id, thread_commands::NAME);
        let reply = self.send_command(packet).await?;
        Self::decode_thread_name(&reply)
    }

    /// The name of each of `thread_ids`, read as **independent reads** (PERF-1, #100).
    ///
    /// **The widest fan-out in the tool.** A dump's triage asks this of every thread the VM has — 306 on a
    /// production-shaped instance — and used to ask one at a time, under the suspension. A thread's name is
    /// nothing to do with any other thread's, so this is a wave.
    ///
    /// **Chunk by [`MAX_READS_IN_FLIGHT`](crate::MAX_READS_IN_FLIGHT) if you have a deadline to
    /// honour.** Passing all 306 ids is correct and bounded, but nothing can interrupt the call once it
    /// starts, and a dump's suspension budget is checked between threads. Chunking hands the budget back
    /// every window — which costs it nothing in time, because a window of sixteen takes about as long as one
    /// sequential read.
    pub async fn read_thread_names_independently(&self, thread_ids: &[ThreadId]) -> Vec<JdwpResult<String>> {
        let packets =
            thread_ids.iter().map(|&t| self.thread_read_request(t, thread_commands::NAME)).collect();
        self.read_independently(packets)
            .await
            .into_iter()
            .map(|reply| reply.and_then(|r| Self::decode_thread_name(&r)))
            .collect()
    }

    /// The `(thread_status, suspend_status)` of each of `thread_ids`, read as **independent reads**.
    ///
    /// The dump's second per-thread read, and the one that must go out **after** the name filter rather than
    /// beside it: a thread whose name is filtered out never has its status read on the sequential path, so a
    /// single wave over both would spend a packet the loop never spent. See `triage_dump_threads`.
    pub async fn read_thread_statuses_independently(
        &self,
        thread_ids: &[ThreadId],
    ) -> Vec<JdwpResult<(i32, i32)>> {
        let packets =
            thread_ids.iter().map(|&t| self.thread_read_request(t, thread_commands::STATUS)).collect();
        self.read_independently(packets)
            .await
            .into_iter()
            .map(|reply| reply.and_then(|r| Self::decode_thread_status(&r)))
            .collect()
    }

    /// The request half of any `ThreadReference` command whose whole payload is the thread id — `Name`,
    /// `Status`, `SuspendCount` and friends all share that shape.
    fn thread_read_request(&self, thread_id: ThreadId, command: u8) -> CommandPacket {
        let id = self.next_id();
        let mut packet = CommandPacket::new(id, command_sets::THREAD_REFERENCE, command);
        packet.data.put_u64(thread_id);
        packet
    }

    /// The decode half of `ThreadReference.Name`, error check included.
    fn decode_thread_name(reply: &crate::protocol::ReplyPacket) -> JdwpResult<String> {
        reply.check_error()?;
        let mut data = reply.data();
        read_string(&mut data)
    }

    /// The decode half of `ThreadReference.Status`, error check included.
    fn decode_thread_status(reply: &crate::protocol::ReplyPacket) -> JdwpResult<(i32, i32)> {
        reply.check_error()?;
        let mut data = reply.data();
        let thread_status = read_i32(&mut data)?;
        let suspend_status = read_i32(&mut data)?;
        Ok((thread_status, suspend_status))
    }

    /// Get a thread's (`thread_status`, `suspend_status`) (ThreadReference.Status).
    /// `suspend_status` != 0 means the thread is currently suspended.
    ///
    /// # Errors
    /// Returns a [`JdwpError`](crate::JdwpError) if the JDWP request fails or the reply cannot be parsed.
    pub async fn get_thread_status(&mut self, thread_id: ThreadId) -> JdwpResult<(i32, i32)> {
        let packet = self.thread_read_request(thread_id, thread_commands::STATUS);
        let reply = self.send_command(packet).await?;
        Self::decode_thread_status(&reply)
    }

    /// How many times this thread has been suspended (`ThreadReference.SuspendCount`).
    ///
    /// JDWP **counts** suspends: a thread suspended n times must be resumed n times before it runs
    /// again. That makes this the only way to answer "did my resume actually resume it?" — a single
    /// `resume_all` against a count of 2 leaves the thread stopped while every command still succeeds.
    /// Verified against a real JVM: two `Suspend`s then one `Resume` leaves the debuggee stopped.
    ///
    /// # Errors
    /// Returns a [`JdwpError`](crate::JdwpError) if the JDWP request fails or the reply cannot be parsed.
    pub async fn suspend_count(&mut self, thread_id: ThreadId) -> JdwpResult<i32> {
        let id = self.next_id();
        let mut packet = CommandPacket::new(
            id,
            command_sets::THREAD_REFERENCE,
            crate::commands::thread_commands::SUSPEND_COUNT,
        );
        packet.data.put_u64(thread_id);

        let reply = self.send_command(packet).await?;
        reply.check_error()?;

        let mut data = reply.data();
        read_i32(&mut data)
    }

    /// Suspend all threads (VirtualMachine.Suspend)
    ///
    /// Suspends are **counted** — calling this twice needs two resumes. Callers that mean "make sure it
    /// is stopped" should check [`suspend_count`](Self::suspend_count) first rather than suspending
    /// again, or they will build a depth that a single resume can't undo.
    ///
    /// # Errors
    /// Returns a [`JdwpError`](crate::JdwpError) if the JDWP request fails or the reply cannot be parsed.
    pub async fn suspend_all(&mut self) -> JdwpResult<()> {
        let id = self.next_id();
        let packet =
            CommandPacket::new(id, command_sets::VIRTUAL_MACHINE, crate::commands::vm_commands::SUSPEND);

        let reply = self.send_command(packet).await?;
        reply.check_error()?;

        Ok(())
    }

    /// Resume all threads (VirtualMachine.Resume) — **one** decrement of every thread's suspend count.
    ///
    /// Not the same as "make the VM run": if anything suspended it twice, this leaves it stopped and
    /// still reports success. Use [`resume_all_fully`](Self::resume_all_fully) when the intent is that
    /// the application actually continues.
    ///
    /// # Errors
    /// Returns a [`JdwpError`](crate::JdwpError) if the JDWP request fails or the reply cannot be parsed.
    pub async fn resume_all(&mut self) -> JdwpResult<()> {
        let id = self.next_id();
        let packet =
            CommandPacket::new(id, command_sets::VIRTUAL_MACHINE, crate::commands::vm_commands::RESUME);

        let reply = self.send_command(packet).await?;
        reply.check_error()?;

        Ok(())
    }

    /// Resume until the application is actually running, not just once.
    ///
    /// Returns `(resumes issued, remaining suspend count)` — a remaining count of 0 means the VM is
    /// genuinely going again. `probe_thread` is the thread whose count is checked; any live thread works
    /// for a VM-wide suspend, since `VirtualMachine.Suspend` increments all of them.
    ///
    /// This exists because "resume" and "is it running" are different questions in JDWP, and a caller
    /// whose job is to un-freeze a shared JVM (a watchdog, a panic button) must not report success on
    /// the strength of a command that returned OK while the debuggee stayed stopped.
    ///
    /// Bounded by `max_resumes` so a pathological count can't spin forever; a thread that is *also*
    /// suspended individually (an `EventThread`-policy event) may legitimately need more than one.
    ///
    /// # Errors
    /// Returns a [`JdwpError`](crate::JdwpError) if a JDWP request fails or a reply cannot be parsed.
    pub async fn resume_all_fully(
        &mut self,
        probe_thread: ThreadId,
        max_resumes: u32,
    ) -> JdwpResult<(u32, i32)> {
        let mut issued = 0;
        for _ in 0..max_resumes {
            self.resume_all().await?;
            issued += 1;
            // A dead/invalid thread can't report a count; treat that as "nothing left to resume"
            // rather than looping, since the thread we were watching has gone.
            let left = self.suspend_count(probe_thread).await.unwrap_or(0);
            if left <= 0 {
                return Ok((issued, 0));
            }
        }
        let left = self.suspend_count(probe_thread).await.unwrap_or(0);
        Ok((issued, left))
    }

    /// Suspend **one** thread (`ThreadReference.Suspend`, set 11 command 2) — the counterpart to
    /// [`resume_thread`](Self::resume_thread), and the cheap alternative to
    /// [`suspend_all`](Self::suspend_all) on a debuggee other people are using.
    ///
    /// This is the only way to obtain an evaluable frame without freezing every in-flight request:
    /// `VirtualMachine.Suspend` and a `SuspendPolicy::All` stop point both hold the whole VM, and on a
    /// shared application server that is a cost nobody agreed to pay.
    ///
    /// **Counted, exactly like every other suspend here.** This increments *this* thread's suspend count
    /// by one and nothing else's; a thread already held by a `VirtualMachine.Suspend`, or parked at an
    /// `EventThread`-policy event, ends up at 2 and needs two decrements before it runs. So a caller
    /// must read [`suspend_count`](Self::suspend_count) afterwards rather than assume a depth of 1 —
    /// which is ADR-0003's rule arriving at the per-thread door.
    ///
    /// **What the JVM answers for a thread that is not running.** A **finished** thread (`ZOMBIE`) can
    /// still be named and described while the debugger holds its `Thread` object, but it cannot be
    /// suspended: `HotSpot` answers `INVALID_THREAD` (10) — which reads as "you passed a bad id" and is
    /// not what happened. A **vanished** thread, whose id the JVM has already collected, answers
    /// `INVALID_OBJECT` (20). The two are different findings and callers must not collapse them
    /// (DUMP-4), so this returns the raw error rather than a sentence.
    ///
    /// # Errors
    /// Returns a [`JdwpError`](crate::JdwpError) if the JDWP request fails or the reply cannot be parsed.
    pub async fn suspend_thread(&mut self, thread_id: ThreadId) -> JdwpResult<()> {
        let id = self.next_id();
        let mut packet = CommandPacket::new(id, command_sets::THREAD_REFERENCE, thread_commands::SUSPEND);
        packet.data.put_u64(thread_id);

        let reply = self.send_command(packet).await?;
        reply.check_error()?;

        Ok(())
    }

    /// Resume a single thread (ThreadReference.Resume) — decrements just that thread's suspend
    /// count, leaving other suspended threads alone. Used after arming a deferred breakpoint on the
    /// thread that a `ClassPrepare` event suspended, so class init proceeds without disturbing any
    /// thread parked at a real breakpoint.
    ///
    /// **One decrement, not "make this thread run".** The distinction is the same one
    /// [`resume_all`](Self::resume_all) draws against [`resume_all_fully`](Self::resume_all_fully): the
    /// JVM acknowledges this command whether or not the thread is left suspended underneath, so a caller
    /// whose intent is that the thread proceeds must verify with
    /// [`suspend_count`](Self::suspend_count). `debug.resume_thread` does exactly that, and says so when
    /// the count did not reach zero.
    ///
    /// # Errors
    /// Returns a [`JdwpError`](crate::JdwpError) if the JDWP request fails or the reply cannot be parsed.
    pub async fn resume_thread(&mut self, thread_id: ThreadId) -> JdwpResult<()> {
        let id = self.next_id();
        let mut packet = CommandPacket::new(id, command_sets::THREAD_REFERENCE, thread_commands::RESUME);
        packet.data.put_u64(thread_id);

        let reply = self.send_command(packet).await?;
        reply.check_error()?;

        Ok(())
    }

    /// Force the topmost frame of a suspended thread to return `value` immediately
    /// (ThreadReference.ForceEarlyReturn). The thread must be suspended and the value's tag must be
    /// assignable to the method's declared return type — pass a `Void` value for a `void` method.
    /// Lets a caller short-circuit a method (e.g. make a rejecting `salvar` return `true`) without
    /// editing and redeploying code. Requires the JVM's `canForceEarlyReturn` capability.
    ///
    /// # Errors
    /// Returns a [`JdwpError`](crate::JdwpError) if the JDWP request fails or the reply cannot be parsed.
    pub async fn force_early_return(
        &mut self,
        thread_id: ThreadId,
        value: &crate::types::Value,
    ) -> JdwpResult<()> {
        self.guard_mutation("a forced early return")?;
        let id = self.next_id();
        let mut packet =
            CommandPacket::new(id, command_sets::THREAD_REFERENCE, thread_commands::FORCE_EARLY_RETURN);
        packet.data.put_u64(thread_id);
        crate::eval::write_tagged_value(&mut packet.data, value);

        let reply = self.send_command(packet).await?;
        reply.check_error()?;

        Ok(())
    }
}