explain_getrlimit(3)

✨ explain_getrlimit ✨

okay bestie, gather round — this is a page from the Library Functions Manual (section 3, the library calls girlies), and it's all about explain_getrlimit(3) 💅

---

🌸 NAME 🌸

explain_getrlimit — explain getrlimit(2) errors 🫶

---

🎀 SYNOPSIS 🎀

#include <libexplain/getrlimit.h>
const char *explain_getrlimit(int resource, struct rlimit *rlim);
const char *explain_errno_getrlimit(int errnum, int resource, struct
rlimit *rlim);
void explain_message_getrlimit(char *message, int message_size, int
resource, struct rlimit *rlim);
void explain_message_errno_getrlimit(char *message, int message_size,
int errnum, int resource, struct rlimit *rlim);

---

💖 DESCRIPTION 💖

So like. These functions? They're the ones you call to get actual explanations for errors that came back from the getrlimit(2) system call. No more squinting at a bare errno wondering what happened — these give you the whole story 💀✨

🦋 explain_getrlimit

const char *explain_getrlimit(int resource, struct rlimit *rlim);

The explain_getrlimit function is how you get an explanation of an error returned by the getrlimit(2) system call. The bare minimum you'll get is the value of strerror(errno), but honestly? Usually it goes way harder than that and tells you the actual underlying cause in more detail. iconic behaviour, truly 🌈

The errno global variable will be used to obtain the error value to be decoded. that's the whole vibe 👑

This function is intended to be used in a fashion similar to the following example:

if (getrlimit(resource, rlim) < 0)
{
    fprintf(stderr, "%s\n", explain_getrlimit(resource, rlim));
    exit(EXIT_FAILURE);
}

The above code example is available pre‐packaged as the explain_getrlimit_or_die(3) function. she comes pre-dressed, no cap 💚

• resource — The original resource, exactly as passed to the getrlimit(2) system call. like, EXACTLY exactly
• rlim — The original rlim, exactly as passed to the getrlimit(2) system call.

Returns: The message explaining the error. ⚠️ heads up bestie ⚠️ This message buffer is shared by all libexplain functions which do not supply a buffer in their argument list. This will be overwritten by the next call to any libexplain function which shares this buffer, including other threads. so do NOT hold onto it like it's yours, because it is not 💅

Note: This function is not thread safe, because it shares a return buffer across all threads, and many other functions in this library. she's a shared queen, she cannot commit 🙈

🧚 explain_errno_getrlimit

const char *explain_errno_getrlimit(int errnum, int resource, struct
rlimit *rlim);

The explain_errno_getrlimit function is used to obtain an explanation of an error returned by the getrlimit(2) system call. The least the message will contain is the value of strerror(errnum), but usually it will do much better, and indicate the underlying cause in more detail. she ate and left no crumbs 🔥

This function is intended to be used in a fashion similar to the following example:

if (getrlimit(resource, rlim) < 0)
{
    int err = errno;
    fprintf(stderr, "%s\n", explain_errno_getrlimit(err, resource, rlim));
    exit(EXIT_FAILURE);
}

The above code example is available pre‐packaged as the explain_getrlimit_or_die(3) function.

• errnum — The error value to be decoded, usually obtained from the errno global variable just before this function is called. This is necessary if you need to call any code between the system call to be explained and this function, because many libc functions will alter the value of errno. fr fr, errno is feral and will change on you 💀
• resource — The original resource, exactly as passed to the getrlimit(2) system call.
• rlim — The original rlim, exactly as passed to the getrlimit(2) system call.

Returns: The message explaining the error. This message buffer is shared by all libexplain functions which do not supply a buffer in their argument list. This will be overwritten by the next call to any libexplain function which shares this buffer, including other threads. same shared-buffer situation as before, iykyk

Note: This function is not thread safe, because it shares a return buffer across all threads, and many other functions in this library.

🌸 explain_message_getrlimit

void explain_message_getrlimit(char *message, int message_size, int
resource, struct rlimit *rlim);

The explain_message_getrlimit function may be used to obtain an explanation of an error returned by the getrlimit(2) system call. The least the message will contain is the value of strerror(errno), but usually it will do much better, and indicate the underlying cause in more detail. she's giving main character energy fr 🎀

The errno global variable will be used to obtain the error value to be decoded.

This function is intended to be used in a fashion similar to the following example:

if (getrlimit(resource, rlim) < 0)
{
    char message[3000];
    explain_message_getrlimit(message, sizeof(message), resource, rlim);
    fprintf(stderr, "%s\n", message);
    exit(EXIT_FAILURE);
}

The above code example is available pre‐packaged as the explain_getrlimit_or_die(3) function.

• message — The location in which to store the returned message. If a suitable message return buffer is supplied, this function is thread safe. YES you read that right, she CAN be thread safe when you bring your own buffer 💖
• message_size — The size in bytes of the location in which to store the returned message.
• resource — The original resource, exactly as passed to the getrlimit(2) system call.
• rlim — The original rlim, exactly as passed to the getrlimit(2) system call.

🦋 explain_message_errno_getrlimit

void explain_message_errno_getrlimit(char *message, int message_size,
int errnum, int resource, struct rlimit *rlim);

The explain_message_errno_getrlimit function may be used to obtain an explanation of an error returned by the getrlimit(2) system call. The least the message will contain is the value of strerror(errnum), but usually it will do much better, and indicate the underlying cause in more detail. obsessed with her honestly ✨

This function is intended to be used in a fashion similar to the following example:

if (getrlimit(resource, rlim) < 0)
{
    int err = errno;
    char message[3000];
    explain_message_errno_getrlimit(message, sizeof(message),
        err, resource, rlim);
    fprintf(stderr, "%s\n", message);
    exit(EXIT_FAILURE);
}

The above code example is available pre‐packaged as the explain_getrlimit_or_die(3) function.

• message — The location in which to store the returned message. If a suitable message return buffer is supplied, this function is thread safe.
• message_size — The size in bytes of the location in which to store the returned message.
• errnum — The error value to be decoded, usually obtained from the errno global variable just before this function is called. This is necessary if you need to call any code between the system call to be explained and this function, because many libc functions will alter the value of errno. yes again, errno does not stay put bestie 😭
• resource — The original resource, exactly as passed to the getrlimit(2) system call.
• rlim — The original rlim, exactly as passed to the getrlimit(2) system call.

---

👑 SEE ALSO 👑

• getrlimit(2) — get resource limits
• explain_getrlimit_or_die(3) — get resource limits and report errors

---

💜 COPYRIGHT 💜

libexplain version 1.4 Copyright (C) 2008 Peter Miller

---

and that's the whole page bestie, we did it 🫶 stay safe out there with your shared buffers, and remember: pass your own message buffer if you want thread safety, otherwise she's not yours 💅

this lil writeup was brought to you by the <b>Library Functions Manual</b>, starring <b>explain_getrlimit(3)</b> — libexplain version 1.4, Copyright (C) 2008 Peter Miller. bye babes 🌸✨