pbs_rescreserve(3B)

💅 pbs_rescreserve — bestie edition

okay so this is pbs_rescreserve(3B) from section 3B of the PBS Professional manual, and it's literally the page that teaches you how to reserve and free batch resources. two functions, one mission: grab resources, give them back. let's go 🎀

---

✨ NAME ✨

pbs_rescreserve, pbs_rescrelease — reserve/free batch resources. that's it, that's the whole vibe. 💖

---

🌸 SYNOPSIS 🌸

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

int pbs_rescreserve(int connect, char **resourcelist, int arraysize,
resource_t *resource_id)

int pbs_rescrelease(int connect, resource_t resource_id)

like, look at those signatures. gorgeous. no notes. 👑

---

🦋 DESCRIPTION 🦋

pbs_rescreserve — the "can i have that pls" function ✨

so what this does is it issues a request to the batch server to reserve the resources you specified. iconic behavior, honestly.

here's the cast of characters:

• connect — the connection that pbs_connect() gave you. your lil handshake with the server. 🤝
• resourcelist — an array of one or more strings specifying the resources to be queried. it's giving "shopping list."
• arraysize — the number of strings in resourcelist. yes, it's "is the is the" in the original and yes we're keeping that typo's meaning but not its chaos. it's the count. periodt. 🔢
• resource_id — a pointer to a resource handle. the pointer cannot be null. like, do not do that. 🙈

okay now the important branching logic, because this is where people get caught out:

• if the present value of the resource handle is RESOURCE_T_NULL, this request is for a new reservation, and if it's successful, a resource handle gets returned in resource_id. brand new, fresh out the box. 🎁
• if the value of resource_id as supplied by you (the caller) is not RESOURCE_T_NULL, then this is an existing (partial) reservation. the resources currently reserved for this handle will be released, and the full reservation will be attempted again. so it's a redo, but a deliberate redo, iykyk. 🔁

and if the caller wishes to release the resources allocated to a partial reservation, the caller should pass the resource handle to pbs_rescrelease(). don't just leave them hanging, bestie. 🫶

the tea on what you're allowed to ask for rn:

at the present time the only resources which may be specified are "nodes". that's it. one option. the rest? not yet. 😭

it should be specified as:

nodes=specification

where specification is what a user specifies in the -l option argument list for nodes, see qsub(1B). so basically, same energy as what you'd type to qsub. 💫

pbs_rescrelease — the "okay i'm done, ty bye" function 🧚

the pbs_rescrelease() call releases or frees resources reserved with the resource handle of resource_id returned from a prior pbs_rescreserve() call.

• connect — the connection returned by pbs_connect(). same handshake, same bestie. 🤝

⚠️ important for both of them:

both functions require that the issuing user have operator or administrator privilege. no privilege, no resources. it's giving velvet rope. 👑

---

⭐ SEE ALSO ⭐

go read these next, they're all part of the lore:

• qsub(1B)
• pbs_connect(3B)
• pbs_disconnect(3B)
• pbs_resources(7B)

---

💀 DIAGNOSTICS 💀

pbs_rescreserve() and pbs_rescrelease() return zero on success. otherwise, a non zero error is returned. and the error number is also set in pbs_errno. so check both, bestie. ✨

now the specific errors, and one of them is special:

• PBSE_RMPART — okay so this is a special case indicating that some but not all of the requested resources could be reserved; a partial reservation was made. 😭 the reservation request should either be rerequested with the returned handle, or the partial resources released. like, you don't get to just ignore this one, fr fr.
• PBSE_RMBADPARAM — a parameter is incorrect, such as a null for the pointer to the resource_id. girl. don't pass null. 🙈
• PBSE_RMNOPARAM — a parameter is missing, such as a null resource list. something straight up didn't show up to the function. 💀

---

lowkey reminder: null pointers, missing params, and partial reservations are the three little gremlins of this manpage. respect them. 🌈

---

and that's the whole thing! this page is from the Local source, dated 13 Sept 2011, and it's the pbs_rescreserve(3B) manual page — go reserve something iconic. 💅🎀🦋