modstat (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/modstat.2freebsd".)

NAME

modstat - get status of kernel module

LIBRARY

Lb libc

SYNOPSIS

In sys/param.h In sys/module.h Ft int Fn modstat int modid struct module_stat *stat

DESCRIPTION

The Fn modstat system call writes the info for the kernel module referred to by Fa modid into Fa stat .

struct module_stat {
        int         version;        /* set to sizeof(module_stat) */
        char        name[MAXMODNAME];
        int         refs;
        int         id;
        modspecific_t data;
};
typedef union modspecific {
        int         intval;
        u_int       uintval;
        long        longval;
        u_long      ulongval;
} modspecific_t;

version

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

name

The name of the module referred to by Fa modid .

refs

The number of modules referenced by Fa modid .

id

The id of the module specified in Fa modid .

data

Module specific data.

RETURN VALUES

Rv -std modstat

ERRORS

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

Bq Er ENOENT

The module 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), kldstat(2), kldsym(2), kldunload(2), modfind(2), modfnext(2), modnext(2), kld(4), kldstat(8)

HISTORY

The kld interface first appeared in Fx 3.0 .