pbs_submit(3B)

💅 pbs_submit(3B) — like, the PBS Professional girlies' guide

okay so bestie, welcome to pbs_submit(3B) from the PBS Professional manual set ✨ this is the little C routine that slides your brand-new batch job into the queue, and honestly? it's giving main character energy. let's get into it 🎀

✨ NAME ✨

pbs_submit — submit a PBS batch job 🚀

🌸 SYNOPSIS 🌸

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

char *pbs_submit(int connect, struct attropl *attrib_list,
                 char *jobscript, char *destqueue, char *extend)

🦋 DESCRIPTION 🦋

So what does it do? It issues a batch request to submit a new batch job, periodt 💅

It generates a Queue Job (1) batch request and sends it over to the server through the connection you handed it in connect.

It submits the job to the queue you picked at the connected server — or, if you didn't specify a queue, it lowkey just goes to the default queue at the connected server. no cap 🫶

💖 ARGUMENTS 💖

• connect — the return value of pbs_connect(). it's the connection handle that says "hey, send this batch request to the server through this". yep, that's the vibe check 🔥
• attrib_list — pointer to a list of attributes you explicitly want for the job. each attribute is described in an attropl structure, which pbs_ifl.h defines like this:

struct attropl {
        struct attropl *next;
        char           *name;
        char           *resource;
        char           *value;
        enum batch_op  op;
};

k so for any attribute you don't specify, or that's a null pointer, PBS does its default thing for that attribute. what's the default thing? it depends on the attribute, bestie — either it assigns the default value, or it just doesn't pass the attribute along with the job 🙈

• jobscript — pointer to the path of the job script. it can be absolute or relative. a relative path starts from the directory where the user submits the job 📁

if it's a null pointer, or a pointer to a null string, then no script gets passed with the job. iconic little shortcut ngl.

• destqueue — pointer to the name of the destination queue at the connected server. if it's a null pointer or points to a null string, the job gets submitted to the default queue at the connected server 🌈
• extend — a character string for extensions to the command. not currently used. she's there, she's just chillin' 💀

🎀 members of the attropl structure 🎀

• next — points to the next attribute in the list. a null pointer terminates the list. that's your finish line, bestie ⭐
• name — points to a string holding the name of the attribute.
• resource — points to a string holding the name of a resource. this is only used when the attribute you specified actually contains resource info — otherwise resource should be a null pointer. don't be messy about it 🙈
• value — points to a string holding the value of the attribute or resource.
• op — the operation to perform on the attribute or resource. in this command, the only allowed operator is SET. that's it. that's the whole menu. periodt 👑

👑 RETURN VALUE 👑

On the slay side: it returns a pointer to a character string containing the job ID that the server assigned 💖

On the not-so-slay side: if an error happened, the routine returns a null pointer, and the error number is available in the global integer pbs_errno. go check her, she'll tell you what went down 😭

🧚 CLEANUP 🧚

Okay this part matters, bestie — the space for the job ID that pbs_submit() returns is allocated by pbs_submit(). so when you don't need it anymore, free it with a call to free(). no memory leaks in this group chat, we don't do that here 🫶✨

🌟 SEE ALSO 🌟

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

💀 reminder to my lovely reader: when the manpage says the only allowed operator is SET, she means it. don't come crying to me with your other operators.

and that's the whole page, gorgeous 🌸 this cutie dropped from the Local corner of the docs on 15 November 2019, still serving pbs_submit(3B) realness. mwah 💋 go submit something iconic 💜