kldstat (2)

Leading comments

Copyright (c) 1999 Chris Costello
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
1. Redistributions of source code must retain the above copyright
   notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
   notice, this list of conditions and the following disclaimer in the
   documentation and/or oth...

(The comments found at the beginning of the groff file "man2/kldstat.2freebsd".)

NAME

kldstat - get status of kld file

LIBRARY

Lb libc

SYNOPSIS

In sys/param.h In sys/linker.h Ft int Fn kldstat int fileid struct kld_file_stat *stat

DESCRIPTION

The Fn kldstat system call writes the info for the file referred to by Fa fileid into Fa stat .

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];
};

version

This field is set to the size of the structure mentioned above by the code calling Fn kldstat , and not Fn kldstat itself.

name

The name of the file referred to by Fa fileid .

refs

The number of modules referenced by Fa fileid .

id

The id of the file specified in Fa 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 Fa fileid , including the path.

RETURN VALUES

Rv -std kldstat

ERRORS

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

Bq Er ENOENT

The file was not found (probably not loaded).

Bq Er EINVAL

The version specified in the Fa 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 Fa version field.

Bq Er EFAULT

There was a problem copying one, some, or all of the fields into Fa stat in the copyout(9) function.

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)

HISTORY

The kld interface first appeared in Fx 3.0 .

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.