explain_acl_set_fd(3)

πŸ“¦
version 1.4.D001 Β· 2 versions
, in debian bookworm, debian trixie, ubuntu jammy, ubuntu noble, ubuntu resolute

πŸ’– explain_acl_set_fd(3) β€” Library Functions Manual πŸ’–

okay bestie, welcome to the libexplain corner of the manual, where we explain why acl_set_fd(3) said no. this whole page lives in the Library Functions Manual, and it's about one very specific kind of bestie behaviour: turning a cryptic error into an actual sentence. πŸŽ€


✨ NAME ✨

explain_acl_set_fd β€” explain acl_set_fd(3) errors

like, it literally exists to tell you why your ACL call flopped. no cap. πŸ¦‹


✨ SYNOPSIS ✨

#include <libexplain/acl_set_fd.h>
const char *explain_acl_set_fd(int fildes, acl_t acl);
const char *explain_errno_acl_set_fd(int errnum, int fildes, acl_t acl);
void explain_message_acl_set_fd(char *message, int message_size, int
fildes, acl_t acl);
void explain_message_errno_acl_set_fd(char *message, int message_size,
int errnum, int fildes, acl_t acl);

four little functions, four little vibes. πŸ’…


✨ DESCRIPTION ✨

These functions may be used to obtain explanations for errors returned by the acl_set_fd(3) system call. that's the whole assignment and they ate. 🌈


🌸 explain_acl_set_fd 🌸

const char *explain_acl_set_fd(int fildes, acl_t acl);

The explain_acl_set_fd function is used to obtain an explanation of an error returned by the acl_set_fd(3) 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. it's giving overachiever and we love that. πŸ˜­πŸ’–

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

  • fildes β€” The original fildes, exactly as passed to the acl_set_fd(3) system call.
  • acl β€” The original acl, exactly as passed to the acl_set_fd(3) 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.

Note: This function is not thread safe, because it shares a return buffer across all threads, and many other functions in this library. ⚠️ so like, be careful out there in multithreaded land, bestie.

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

if (acl_set_fd(fildes, acl) < 0)
{
    fprintf(stderr, "%s\n", explain_acl_set_fd(fildes, acl));
    exit(EXIT_FAILURE);
}

The above code example is available pre-packaged as the explain_acl_set_fd_or_die(3) function. pre-packaged?? she's convenient, she's ready to go, she's iconic. πŸ‘‘


🌸 explain_errno_acl_set_fd 🌸

const char *explain_errno_acl_set_fd(int errnum, int fildes, acl_t acl);

The explain_errno_acl_set_fd function is used to obtain an explanation of an error returned by the acl_set_fd(3) 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.

  • 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. 🫢 so grab that errno FAST, she will not wait for you.
  • fildes β€” The original fildes, exactly as passed to the acl_set_fd(3) system call.
  • acl β€” The original acl, exactly as passed to the acl_set_fd(3) 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.

Note: This function is not thread safe, because it shares a return buffer across all threads, and many other functions in this library. πŸ’€ yeah. same warning, same energy.

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

if (acl_set_fd(fildes, acl) < 0)
{
    int err = errno;
    fprintf(stderr, "%s\n", explain_errno_acl_set_fd(err, fildes,
    acl));
    exit(EXIT_FAILURE);
}

The above code example is available pre-packaged as the explain_acl_set_fd_or_die(3) function.


🌸 explain_message_acl_set_fd 🌸

void explain_message_acl_set_fd(char *message, int message_size, int
fildes, acl_t acl);

The explain_message_acl_set_fd function is used to obtain an explanation of an error returned by the acl_set_fd(3) 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.

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

  • message β€” The location in which to store the returned message. If a suitable message return buffer is supplied, this function is thread safe. πŸŽ€ bestie you bring your own buffer and suddenly we're safe!! growth!!
  • message_size β€” The size in bytes of the location in which to store the returned message.
  • fildes β€” The original fildes, exactly as passed to the acl_set_fd(3) system call.
  • acl β€” The original acl, exactly as passed to the acl_set_fd(3) system call.

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

if (acl_set_fd(fildes, acl) < 0)
{
    char message[3000];
    explain_message_acl_set_fd(message, sizeof(message), fildes,
    acl);
    fprintf(stderr, "%s\n", message);
    exit(EXIT_FAILURE);
}

The above code example is available pre-packaged as the explain_acl_set_fd_or_die(3) function.


🌸 explain_message_errno_acl_set_fd 🌸

void explain_message_errno_acl_set_fd(char *message, int message_size,
int errnum, int fildes, acl_t acl);

The explain_message_errno_acl_set_fd function is used to obtain an explanation of an error returned by the acl_set_fd(3) 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.

  • 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. 🫢
  • fildes β€” The original fildes, exactly as passed to the acl_set_fd(3) system call.
  • acl β€” The original acl, exactly as passed to the acl_set_fd(3) system call.

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

if (acl_set_fd(fildes, acl) < 0)
{
    int err = errno;
    char message[3000];
    explain_message_errno_acl_set_fd(message, sizeof(message),
    err, fildes, acl);
    fprintf(stderr, "%s\n", message);
    exit(EXIT_FAILURE);
}

The above code example is available pre-packaged as the explain_acl_set_fd_or_die(3) function. ✨


✨ SEE ALSO ✨

yes bestie, go read those too, they're the supporting cast and they understood the assignment. πŸ’œ


libexplain version 1.4 Copyright (C) 2013 Peter Miller


and that's the whole page, bestie!! πŸ¦‹πŸŒΈ libexplain version 1.4, copyright 2013, Peter Miller β€” the icon, the legend, the person who wrote this so we don't have to guess why acl_set_fd(3) ghosted us. mwah. πŸ’…πŸŽ€β­

πŸ“¦ where this page comes from