pbs_stagein(3B)

🎀 pbs_stagein(3B) — NAME 🎀

okay so bestie, welcome to pbs_stagein(3B) from the PBS manual. Here’s the whole vibe: pbs_stagein is the function that requests files for a PBS batch job be staged in. Slay. It’s giving “please get my files into position before the job runs,” no cap. 💖

✨ SYNOPSIS ✨

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

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

🦋 DESCRIPTION 🦋

okay so what does it actually do? It issues a batch request to start the stage in of files specified in the stagein attribute of a batch job. Iconic behavior only.

A stage in batch request is generated and sent to the server over the connection specified by connect, which is literally the return value of pbs_connect().

This request directs the server to begin the stage in of files specified in the job’s stage in attribute. Highkey important: this request requires that the issuing user have operator or administrator privilege. Not me showing up without permissions, bestie. 💅

bestie, the privilege check is real: only an operator or administrator can issue this request. Don’t skip the vibe check.

Now the arguments, one by one, because we’re thorough like that:

• job_id — identifies which job for which file staging is to begin. It is specified in the form sequence_number.server.
• location — if it’s not the null pointer or null string, it specifies the location where the job will be run and hence to where the files will be staged. This location is the name of a host in the cluster managed by the server. If the job is then directed to run at a different location, the run request will be rejected. So yeah, choose the location carefully, bestie.
• extend — reserved for implementation defined extensions. That’s the whole note, periodt.

🌈 SEE ALSO 🌈

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

💖 DIAGNOSTICS 💖

When the batch request generated by pbs_stagein() has been completed successfully by a batch server, the routine will return 0 (zero). Otherwise, a non zero error is returned. The error number is also set in pbs_errno.

success = zero, not-success = non-zero, and pbs_errno gets the receipt. The way that’s literally the whole diagnostic vibe. 😭

Signed off with love from the Local source/version stamp on the pbs_stagein(3B) manual page — there’s no date printed in the footer, so we are not inventing one, bestie. 💅✨