xref: /illumos-gate/usr/src/man/man9s/module_info.9s (revision 7ab4e62e3b5c454f248a38bec0d489e8f5543324)
te
Copyright (c) 2002, Sun Microsystems, Inc. All Rights Reserved.
Copyright 1989 AT&T
The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
MODULE_INFO 9S "Nov 26, 2002"
NAME
module_info - STREAMS driver identification and limit value structure
SYNOPSIS

#include <sys/stream.h>
INTERFACE LEVEL

Architecture independent level 1 (DDI/DKI).

DESCRIPTION

When a module or driver is declared, several identification and limit values can be set. These values are stored in the module_info structure.

The module_info structure is intended to be read-only. However, the flow control limits (mi_hiwat and mi_lowat) and the packet size limits (mi_minpsz and mi_maxpsz) are copied to the QUEUE structure, where they can be modified.

For a driver, mi_idname must match the name of the driver binary file. For a module, mi_idname must match the fname field of the fmodsw structure. See fmodsw(9S) for details.

STRUCTURE MEMBERS
ushort_t mi_idnum; /* module ID number */
char *mi_idname; /* module name */
ssize_t mi_minpsz; /* minimum packet size */
ssize_t mi_maxpsz; /* maximum packet size */
size_t mi_hiwat; /* high water mark */
size_t mi_lowat; /* low water mark */

The constant FMNAMESZ, limiting the length of a module's name, is set to eight in this release.

SEE ALSO

fmodsw(9S), queue(9S)

STREAMS Programming Guide