pbs_stagein(3B)

💅 pbs_stagein — like, the official PBS Professional 3B manual page, but make it make sense 🎀

okay bestie, buckle up, because this one is lowkey niche but kind of iconic. pbs_stagein is the function you call when you want a batch job's files to get pulled in (staged in) — like sending your bestie to go grab your stuff before the party. let's get into it. ✨

🌸 SYNOPSIS 🌸

first things first, you gotta include these two headers or nothing works, fr fr:

#include <pbs_error.h>
#include <pbs_ifl.h>

and here's the function signature, exactly as it lives, no cap:

int pbs_stagein(int connect, char *job_id, char *location, char *extend)

🦋 DESCRIPTION 🦋

so what does this thing do? it issues a batch request to start the stage in of the files listed in the stagein attribute of a batch job. that's the whole vibe. 💫

a stage-in batch request gets generated and sent to the server over the connection you pass as connect — and heads up, connect is literally the return value of pbs_connect(). so like, don't just make one up, okay? 🙈

this request tells the server to begin staging in the files named in the job's stage in attribute. and here's the catch, bestie: the user issuing this request needs operator or administrator privilege. no privilege, no stage in, periodt. 👑

now the arguments, one by one, because we respect the details in this house:

• job_id — tells the server which job file staging is starting for. it's specified in this form:

sequence_number.server

• location — if this isn't the null pointer or a null string, it specifies where the job will be run, and therefore where the files will be staged to. it's the name of a host in the cluster managed by the server. and ooh, important: if the job is then directed to run at a different location, the run request will be rejected. so don't be slick and change your mind later, it's not gonna fly. 💀
• extend — reserved for implementation-defined extensions. that's it. that's the whole note. it's the "we'll deal with it later" argument. 🫶

🔥 SEE ALSO 🔥

go read these too, iykyk:

• qrun(8B)
• qsub(1B)
• pbs_connect(3B)

⭐ DIAGNOSTICS ⭐

when the batch request that pbs_stagein() generated gets completed successfully by a batch server, the routine returns 0 (zero). slay. 💖

otherwise? a non-zero error comes back at you. and the error number is also set in pbs_errno — so check that too, bestie, that's where the tea is. 🍓

lowkey reminder: non-zero return = something went sideways. check pbs_errno before you spiral. 💅

and that's the whole page! this little number comes from the PBS Professional crew, it's the Local flavor of the page, dated 3 March 2015 — vintage but still serving. bye bestie, go stage some files 🧚💜