KLDSTAT(2)

πŸ’– KLDSTAT(2) πŸ’–

okay so bestie, we're in the System Calls Manual section of the Debian man pages, and today's main character is kldstat β€” the syscall that gives you the tea on your kld files πŸ«–βœ¨


✨ NAME ✨

kldstat β€” get status of kld file πŸ‘€


πŸ“š LIBRARY πŸ“š

Standard C Library (libc, -lc) β€” she's built in, no extra credit needed πŸ’…


🌊 SYNOPSIS 🌊

#include <sys/param.h>
#include <sys/linker.h>

int
kldstat(int fileid, struct kld_file_stat *stat);

πŸ¦‹ DESCRIPTION πŸ¦‹

So the kldstat() system call writes the info for the file referred to by fileid into stat. Like, it literally fills in the whole glow-up report for you ✨

struct kld_file_stat {
        int         version;    /* set to sizeof(struct kld_file_stat) */
        char        name[MAXPATHLEN];
        int         refs;
        int         id;
        caddr_t     address;
        size_t      size;
        char        pathname[MAXPATHLEN];
};

okay let's go field by field, no skipping bestie:

  • version β€” this field is set to the size of the structure mentioned above by the code calling kldstat(), and not by kldstat() itself. so like, you fill this in, not her πŸ™ˆ
  • name β€” the name of the file referred to by fileid.
  • refs β€” the number of modules referenced by fileid.
  • id β€” the id of the file specified in fileid.
  • address β€” the load address of the kld file.
  • size β€” the amount of memory in bytes allocated by the file.
  • pathname β€” the full name of the file referred to by fileid, including the path. the whole thing, no crumbs πŸ“

πŸŽ€ RETURN VALUES πŸŽ€

The kldstat() function returns the value 0 if successful πŸŽ‰ otherwise the value -1 is returned and the global variable errno is set to indicate the error 😭 classic.


πŸ’€ ERRORS πŸ’€

The information for the file referred to by fileid is filled into the structure pointed to by stat unless:

  • [ENOENT] β€” The file was not found (probably not loaded). she's simply not there bestie πŸ’€
  • [EINVAL] β€” The version specified in the version field of stat is not the proper version. You would need to rebuild world, the kernel, or your application, if this error occurs, given that you did properly fill in the version field. like it's giving "time to rebuild everything" energy 😭
  • [EFAULT] β€” There was a problem copying one, some, or all of the fields into stat in the copyout(9) function. oops, copy didn't slay πŸ™ˆ

πŸ”— SEE ALSO πŸ”—

kldfind(2), kldfirstmod(2), kldload(2), kldnext(2), kldsym(2), kldunload(2), modfind(2), modfnext(2), modnext(2), modstat(2), kld(4), kldstat(8) β€” go read the whole friend group, they all ate πŸ’–


πŸ“œ HISTORY πŸ“œ

The kld interface first appeared in FreeBSD 3.0. vintage icon behavior, no cap πŸ‘‘


πŸ› BUGS πŸ›

⚠️ The pathname may not be accurate if the file system mounts have changed since the module was loaded, or if this function is called within a chrooted environment. so like, don't trust that path with your whole heart if things moved around bestie 😭

and that's the whole page!! mwah πŸ’‹ this one came from the Debian crew and is dated March 28, 2012 β€” stay hydrated, keep your structs zeroed, and slay the day away βœ¨πŸ«ΆπŸ’…

πŸ“¦ where this page comes from