Manpage of MOD_INSTALL

MOD_INSTALL

Section: OpenSS7 STREAMS Compatibility DDI/DKI (9)
Updated: 2008-10-31
Index Return to Main Contents

NAME

mod_install - installs a loadable kernel module in the STREAMS executive

SYNOPSIS

#define _SUN_SOURCE
#include <sys/modctl.h>

int mod_install(struct modlinkage *modlinkage);

ARGUMENTS

modlinkage

DESCRIPTION

mod_install() must be called from a module _init(9) routine.

RETURN

When mod_install() succeeds, it returns zero (0); when it fails, it returns non-zero.

ERRORS

mod_install() fails when

CONTEXT

mod_install() can be called from a non-blocking context. It is intended to be called from module initialization routine.

MP-STREAMS

mod_install() is MP-safe when called from the correct context.

NOTICES

mod_install() is a Solaris®-specific function: _SUN_SOURCE must be defined before including DDI/DKI include files to expose this symbol. OpenSS7 STREAMS Compatibility must also have been compiled with CONFIG_STREAMS_COMPAT_SUN or CONFIG_STREAMS_COMPAT_SUN_MODULE defined.

EXAMPLE

Following is a canonical example of an _init(9) function using mod_install():


int
_init(void)
{
    int result;
result =
        ddi_soft_state_init(&xxx_statep,
                            sizeof(xxx_state_t), 0);
    if (result != 0) {
        return (result);
    }
result = mod_install(&xxx_modlinkage);
    if (result != 0) {
        ddi_soft_state_fini(&xxx_statep);
        return (result);
    }
return (0);
}

BUGS

mod_install() has no known bugs.

COMPATIBILITY

mod_install() is compatible with Solaris® with the following portability considerations:

---
---
---
---: mod_install() is provided for source level compatibility with Solaris® for the purpose of porting Solaris® drivers to Linux. Because internal structures and definitions for OpenSS7 STREAMS Compatibility[1] differ from that of Solaris®, binaries are incompatible.
---: mod_install() only provides functionality comparable to Solaris® for use by STREAMS drivers and modules. Any and all functionality provided by mod_install() in support of non-STREAMS devices are not supported.

See STREAMS(9) for additional compatibility information.

CONFORMANCE

Solaris® SUNDDI documentation[2].

HISTORY

mod_install() first appeared in Solaris® 2.5.

REFERENCES

[1]: strcompat-0.9.2, STREAMS Compatibility Modules (strcompat) 0.9.2 Source Code, Brian Bidulock, ed., OpenSS7 Corporation. <http://www.openss7.org/>
[2]: Solaris® 8, Solaris 8 Docmentation, 2001, (Santa Clara, California), Sun Microsystems, Inc., Sun. <http://docs.sun.com/>

TRADEMARKS

OpenSS7tm: is a trademark of OpenSS7 Corporation.
Linux®: is a registered trademark of Linus Torvalds.
UNIX®: is a registered trademark of The Open Group.
Solaris®: is a registered trademark of Sun Microsystems.

Other trademarks are the property of their respective owners.

IDENTIFICATION

OpenSS7 STREAMS Compatibility: Package strcompat version 0.9.2.7 released 2008-10-31.

Index

NAME
SYNOPSIS
ARGUMENTS
DESCRIPTION
RETURN
ERRORS
CONTEXT
MP-STREAMS
NOTICES
EXAMPLE
SEE ALSO
BUGS
COMPATIBILITY
CONFORMANCE
HISTORY
REFERENCES
TRADEMARKS
IDENTIFICATION

This document was created by man2html, using the manual pages.
Time: 10:27:07 GMT, May 21, 2013