Debian Codegraph @

doc/SystemTap_Tapset_Reference/man3/function::remote_id.3stap

raw
1 '\" t
2 .\" Title: function::remote_id
3 .\" Author:
4 .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
5 .\" Date: October 2025
6 .\" Manual: Context Functions
7 .\" Source: SystemTap Tapset Reference
8 .\" Language: English
9 .\"
10 .TH "FUNCTION::REMOTE_ID" "3stap" "October 2025" "SystemTap Tapset Reference" "Context Functions"
11 .\" -----------------------------------------------------------------
12 .\" * Define some portability stuff
13 .\" -----------------------------------------------------------------
14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15 .\" http://bugs.debian.org/507673
16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
18 .ie \n(.g .ds Aq \(aq
19 .el .ds Aq '
20 .\" -----------------------------------------------------------------
21 .\" * set default formatting
22 .\" -----------------------------------------------------------------
23 .\" disable hyphenation
24 .nh
25 .\" disable justification (adjust text to left margin only)
26 .ad l
27 .\" -----------------------------------------------------------------
28 .\" * MAIN CONTENT STARTS HERE *
29 .\" -----------------------------------------------------------------
30 .SH "NAME"
31 function::remote_id \- The index of this instance in a remote execution\&.
32 .SH "SYNOPSIS"
33 .sp
34 .nf
35 remote_id:long()
36 .fi
37 .SH "ARGUMENTS"
38 .PP
39 None
40 .SH "DESCRIPTION"
41 .PP
42 This function returns a number 0\&.\&.N, which is the unique index of this particular script execution from a swarm of
43 \(lqstap \-\-remote A \-\-remote B \&.\&.\&.\(rq
44 runs, and is the same number
45 \(lqstap \-\-remote\-prefix\(rq
46 would print\&. The function returns \-1 if the script was not launched with
47 \(lqstap \-\-remote\(rq, or if the remote staprun/stapsh are older than version 1\&.7\&.
48 .SH SEE ALSO\n
49 .IR tapset::context (3stap)