share/man/man3devinfo/di_devlink_walk.3devinfo

   1 '\" te
   2 .\" Copyright (c) 2008, Sun Microsystems, Inc.  All Rights Reserved.
   3 .\" 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.
   4 .\" 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.
   5 .\" 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]
   6 .TH DI_DEVLINK_WALK 3DEVINFO "May 15, 2008"
   7 .SH NAME
   8 di_devlink_walk \- walk through links in a devlink snapshot
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-ldevinfo\fR [ \fIlibrary\fR... ]
  13 #include <libdevinfo.h>
  14
  15 \fBint\fR \fBdi_devlink_walk\fR(\fBdi_devlink_handle_t\fR \fIhdl\fR,\fBconst char *\fR\fIre\fR,
  16      \fBconst char *\fR\fImpath\fR, \fBuint_t\fR \fIflags\fR, \fBvoid *\fR\fIarg\fR,
  17      \fBint\fR (*\fIdevlink_callback\fR)(\fBdi_devlink_t\fR \fIdevlink\fR, \fBvoid *\fR\fIarg\fR));
  18 .fi
  19
  20 .SH PARAMETERS
  21 .sp
  22 .ne 2
  23 .na
  24 \fB\fIhdl\fR\fR
  25 .ad
  26 .RS 11n
  27 A handle to a snapshot of devlinks in "\fB/dev\fR".
  28 .RE
  29
  30 .sp
  31 .ne 2
  32 .na
  33 \fB\fIre\fR\fR
  34 .ad
  35 .RS 11n
  36 An extended regular expression as specified in \fBregex\fR(5) describing the
  37 paths of devlinks to visit. A null value matches all devlinks.  The expression
  38 should not involve the "\fB/dev\fR" prefix. For example, the "^\fBdsk/\fR" will
  39 invoke \fIdevlink_callback\fR() for all "\fB/dev/dsk/\fR" links.
  40 .RE
  41
  42 .sp
  43 .ne 2
  44 .na
  45 \fB\fImpath\fR\fR
  46 .ad
  47 .RS 11n
  48 A path to a minor node below "\fB/devices\fR" for which "\fB/dev\fR" links are
  49 to be looked up. A null value selects all devlinks.  This path should not have
  50 a "\fB/devices\fR" prefix.
  51 .RE
  52
  53 .sp
  54 .ne 2
  55 .na
  56 \fB\fIflags\fR\fR
  57 .ad
  58 .RS 11n
  59 Specify the type of devlinks to be selected.  If \fBDI_PRIMARY_LINK\fR is used,
  60 only primary links (for instance, links which point only to "\fB/devices\fR"
  61 entries) are selected. If \fBDI_SECONDARY_LINK\fR is specified, only secondary
  62 links (for instance, devlinks which point to other devlinks) are selected. If
  63 neither flag is specified, all devlinks are selected.
  64 .RE
  65
  66 .sp
  67 .ne 2
  68 .na
  69 \fB\fIarg\fR\fR
  70 .ad
  71 .RS 11n
  72 A pointer to caller private data.
  73 .RE
  74
  75 .sp
  76 .ne 2
  77 .na
  78 \fB\fIdevlink\fR\fR
  79 .ad
  80 .RS 11n
  81 The devlink being visited.
  82 .RE
  83
  84 .SH DESCRIPTION
  85 .sp
  86 .LP
  87 The \fBdi_devlink_walk()\fR function visits every link in the snapshot that
  88 meets the criteria specified by the caller. For each such devlink, the
  89 caller-supplied function \fIdevlink_callback\fR() is invoked. The return value
  90 of \fIdevlink_callback\fR() determines subsequent walk behavior.
  91 .SH RETURN VALUES
  92 .sp
  93 .LP
  94 Upon success, the \fBdi_devlink_walk()\fR function returns 0. Otherwise, -1 is
  95 returned and \fBerrno\fR is set to indicate the error.
  96 .sp
  97 .LP
  98 The \fIdevlink_callback\fR() function can return the following values:
  99 .sp
 100 .ne 2
 101 .na
 102 \fB\fBDI_WALK_CONTINUE\fR\fR
 103 .ad
 104 .RS 21n
 105 Continue walking.
 106 .RE
 107
 108 .sp
 109 .ne 2
 110 .na
 111 \fB\fBDI_WALK_TERMINATE\fR\fR
 112 .ad
 113 .RS 21n
 114 Terminate the walk immediately.
 115 .RE
 116
 117 .SH ERRORS
 118 .sp
 119 .LP
 120 The \fBdevlink_callback()\fR function will fail if:
 121 .sp
 122 .ne 2
 123 .na
 124 \fB\fBEINVAL\fR\fR
 125 .ad
 126 .RS 10n
 127 One or more arguments is invalid.
 128 .RE
 129
 130 .sp
 131 .ne 2
 132 .na
 133 \fB\fBENOMEM\fR\fR
 134 .ad
 135 .RS 10n
 136 Insufficient memory is available.
 137 .RE
 138
 139 .SH ATTRIBUTES
 140 .sp
 141 .LP
 142 See \fBattributes\fR(5)  for descriptions of the following attributes:
 143 .sp
 144
 145 .sp
 146 .TS
 147 box;
 148 c | c
 149 l | l .
 150 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 151 _
 152 Interface Stability     Committed
 153 _
 154 MT-Level        Safe
 155 .TE
 156
 157 .SH SEE ALSO
 158 .sp
 159 .LP
 160 \fBdi_devlink_init\fR(3DEVINFO), \fBdi_devlink_path\fR(3DEVINFO),
 161 \fBlibdevinfo\fR(3LIB), \fBmalloc\fR(3C), \fBattributes\fR(5), \fBregex\fR(5)