1 0 stevel /* 2 0 stevel * CDDL HEADER START 3 0 stevel * 4 0 stevel * The contents of this file are subject to the terms of the 5 2760 dg199075 * Common Development and Distribution License (the "License"). 6 2760 dg199075 * You may not use this file except in compliance with the License. 7 0 stevel * 8 0 stevel * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE 9 0 stevel * or http://www.opensolaris.org/os/licensing. 10 0 stevel * See the License for the specific language governing permissions 11 0 stevel * and limitations under the License. 12 0 stevel * 13 0 stevel * When distributing Covered Code, include this CDDL HEADER in each 14 0 stevel * file and include the License file at usr/src/OPENSOLARIS.LICENSE. 15 0 stevel * If applicable, add the following below this CDDL HEADER, with the 16 0 stevel * fields enclosed by brackets "[]" replaced with your own identifying 17 0 stevel * information: Portions Copyright [yyyy] [name of copyright owner] 18 0 stevel * 19 0 stevel * CDDL HEADER END 20 0 stevel */ 21 0 stevel /* 22 8778 Erik * Copyright 2009 Sun Microsystems, Inc. All rights reserved. 23 0 stevel * Use is subject to license terms. 24 0 stevel */ 25 0 stevel 26 0 stevel /* Copyright (c) 1984, 1986, 1987, 1988, 1989 AT&T */ 27 0 stevel /* All Rights Reserved */ 28 0 stevel 29 0 stevel 30 0 stevel #ifndef _SYS_STREAM_H 31 0 stevel #define _SYS_STREAM_H 32 0 stevel 33 0 stevel /* 34 0 stevel * For source compatibility 35 0 stevel */ 36 0 stevel #include <sys/isa_defs.h> 37 5006 ek110237 #ifdef _KERNEL 38 0 stevel #include <sys/vnode.h> 39 5006 ek110237 #endif 40 0 stevel #include <sys/poll.h> 41 0 stevel #include <sys/strmdep.h> 42 0 stevel #include <sys/cred.h> 43 0 stevel #include <sys/t_lock.h> 44 0 stevel #include <sys/model.h> 45 0 stevel 46 0 stevel #ifdef __cplusplus 47 0 stevel extern "C" { 48 0 stevel #endif 49 0 stevel 50 0 stevel /* 51 1110 meem * Data queue. 52 0 stevel * 53 1110 meem * NOTE: The *only* public fields are documented in queue(9S). 54 1110 meem * Everything else is implementation-private. 55 0 stevel * 56 1110 meem * The locking rules for the queue_t structure are extremely subtle and vary 57 1110 meem * widely depending on the field in question. As such, each field is 58 1110 meem * annotated according to the following legend: 59 0 stevel * 60 1110 meem * Q9S: The field is documented in queue(9S) and may be accessed without 61 1110 meem * locks by a STREAMS module when inside an entry point (e.g., put(9E)). 62 1110 meem * However, no fields can be directly modified unless q_lock is held 63 1110 meem * (which is not possible in a DDI compliant STREAMS module), with the 64 1110 meem * following exceptions: 65 0 stevel * 66 1110 meem * - q_ptr: can be modified as per the rules of the STREAMS module. 67 1110 meem * The STREAMS framework ignores q_ptr and thus imposes *no* 68 1110 meem * locking rules on it. 69 1110 meem * - q_qinfo: can be modified before qprocson(). 70 1110 meem * 71 1110 meem * - q_minpsz, q_maxpsz, q_hiwat, q_lowat: can be modified as per the 72 1110 meem * rules of the STREAMS module. The STREAMS framework never 73 1110 meem * modifies these fields, and is tolerant of temporarily 74 1110 meem * stale field values. 75 1110 meem * 76 1110 meem * In general, the STREAMS framework employs one of the following 77 1110 meem * techniques to ensure STREAMS modules can safely access Q9S fields: 78 1110 meem * 79 1110 meem * - The field is only modified by the framework when the stream is 80 1110 meem * locked with strlock() (q_next). 81 1110 meem * 82 1110 meem * - The field is modified by the framework, but the modifies are 83 1110 meem * atomic, and temporarily stale values are harmless (q_count, 84 1110 meem * q_first, q_last). 85 1110 meem * 86 1110 meem * - The field is modified by the framework, but the field's visible 87 1110 meem * values are either constant or directly under the control 88 1110 meem * of the STREAMS module itself (q_flag). 89 1110 meem * 90 1110 meem * QLK: The field must be accessed or modified under q_lock, except when 91 1110 meem * the stream has been locked with strlock(). If multiple q_locks must 92 1110 meem * be acquired, q_locks at higher addresses must be taken first. 93 1110 meem * 94 1110 meem * STR: The field can be accessed without a lock, but must be modified under 95 1110 meem * strlock(). 96 1110 meem * 97 1110 meem * SQLK: The field must be accessed or modified under SQLOCK(). 98 1110 meem * 99 1110 meem * NOLK: The field can be accessed without a lock, but can only be modified 100 1110 meem * when the queue_t is not known to any other threads. 101 1110 meem * 102 1110 meem * SVLK: The field must be accessed or modified under the service_queue lock. 103 1110 meem * Note that service_lock must be taken after any needed q_locks, 104 1110 meem * and that no other lock should be taken while service_lock is held. 105 1110 meem * 106 1110 meem * In addition, it is always acceptable to modify a field that is not yet 107 1110 meem * known to any other threads -- and other special case exceptions exist in 108 1110 meem * the code. Also, q_lock is used with q_wait to implement a stream head 109 1110 meem * monitor for reads and writes. 110 0 stevel */ 111 1110 meem typedef struct queue { 112 1110 meem struct qinit *q_qinfo; /* Q9S: Q processing procedure */ 113 1110 meem struct msgb *q_first; /* Q9S: first message in Q */ 114 1110 meem struct msgb *q_last; /* Q9S: last message in Q */ 115 1110 meem struct queue *q_next; /* Q9S: next Q in stream */ 116 1110 meem struct queue *q_link; /* SVLK: next Q for scheduling */ 117 1110 meem void *q_ptr; /* Q9S: module-specific data */ 118 1110 meem size_t q_count; /* Q9S: number of bytes on Q */ 119 1110 meem uint_t q_flag; /* Q9S: Q state */ 120 1110 meem ssize_t q_minpsz; /* Q9S: smallest packet OK on Q */ 121 1110 meem ssize_t q_maxpsz; /* Q9S: largest packet OK on Q */ 122 1110 meem size_t q_hiwat; /* Q9S: Q high water mark */ 123 1110 meem size_t q_lowat; /* Q9S: Q low water mark */ 124 1110 meem struct qband *q_bandp; /* QLK: band flow information */ 125 1110 meem kmutex_t q_lock; /* NOLK: structure lock */ 126 1110 meem struct stdata *q_stream; /* NOLK: stream backpointer */ 127 1110 meem struct syncq *q_syncq; /* NOLK: associated syncq */ 128 1110 meem unsigned char q_nband; /* QLK: number of bands */ 129 1110 meem kcondvar_t q_wait; /* NOLK: read/write sleep CV */ 130 1110 meem struct queue *q_nfsrv; /* STR: next Q with svc routine */ 131 1110 meem ushort_t q_draining; /* QLK: Q is draining */ 132 1110 meem short q_struiot; /* QLK: sync streams Q UIO mode */ 133 1110 meem clock_t q_qtstamp; /* QLK: when Q was enabled */ 134 1110 meem size_t q_mblkcnt; /* QLK: mblk count */ 135 1110 meem uint_t q_syncqmsgs; /* QLK: syncq message count */ 136 1110 meem size_t q_rwcnt; /* QLK: # threads in rwnext() */ 137 1110 meem pri_t q_spri; /* QLK: Q scheduling priority */ 138 0 stevel 139 0 stevel /* 140 1110 meem * Syncq scheduling 141 0 stevel */ 142 1110 meem struct msgb *q_sqhead; /* QLK: first syncq message */ 143 1110 meem struct msgb *q_sqtail; /* QLK: last syncq message */ 144 1110 meem struct queue *q_sqnext; /* SQLK: next Q on syncq list */ 145 1110 meem struct queue *q_sqprev; /* SQLK: prev Q on syncq list */ 146 1110 meem uint_t q_sqflags; /* SQLK: syncq flags */ 147 1110 meem clock_t q_sqtstamp; /* SQLK: when Q was scheduled for sq */ 148 0 stevel 149 0 stevel /* 150 1110 meem * NOLK: Reference to the queue's module's implementation 151 1110 meem * structure. This will be NULL for queues associated with drivers. 152 0 stevel */ 153 0 stevel struct fmodsw_impl *q_fp; 154 0 stevel } queue_t; 155 0 stevel 156 0 stevel /* 157 0 stevel * Queue flags; unused flags not documented in queue(9S) can be recycled. 158 0 stevel */ 159 0 stevel #define QENAB 0x00000001 /* Queue is already enabled to run */ 160 0 stevel #define QWANTR 0x00000002 /* Someone wants to read Q */ 161 0 stevel #define QWANTW 0x00000004 /* Someone wants to write Q */ 162 0 stevel #define QFULL 0x00000008 /* Q is considered full */ 163 0 stevel #define QREADR 0x00000010 /* This is the reader (first) Q */ 164 0 stevel #define QUSE 0x00000020 /* This queue in use (allocation) */ 165 0 stevel #define QNOENB 0x00000040 /* Don't enable Q via putq */ 166 0 stevel #define QWANTRMQSYNC 0x00000080 /* Want to remove sync stream Q */ 167 0 stevel #define QBACK 0x00000100 /* queue has been back-enabled */ 168 0 stevel /* UNUSED 0x00000200 was QHLIST */ 169 0 stevel /* UNUSED 0x00000400 was QUNSAFE */ 170 0 stevel #define QPAIR 0x00000800 /* per queue-pair syncq */ 171 0 stevel #define QPERQ 0x00001000 /* per queue-instance syncq */ 172 0 stevel #define QPERMOD 0x00002000 /* per module syncq */ 173 0 stevel #define QMTSAFE 0x00004000 /* stream module is MT-safe */ 174 0 stevel #define QMTOUTPERIM 0x00008000 /* Has outer perimeter */ 175 0 stevel #define QMT_TYPEMASK (QPAIR|QPERQ|QPERMOD|QMTSAFE|QMTOUTPERIM) 176 0 stevel /* all MT type flags */ 177 0 stevel #define QINSERVICE 0x00010000 /* service routine executing */ 178 0 stevel #define QWCLOSE 0x00020000 /* will not be enabled */ 179 0 stevel #define QEND 0x00040000 /* last queue in stream */ 180 0 stevel #define QWANTWSYNC 0x00080000 /* Streamhead wants to write Q */ 181 0 stevel #define QSYNCSTR 0x00100000 /* Q supports Synchronous STREAMS */ 182 0 stevel #define QISDRV 0x00200000 /* the Queue is attached to a driver */ 183 0 stevel /* UNUSED 0x00400000 was QHOT */ 184 0 stevel /* UNUSED 0x00800000 was QNEXTHOT */ 185 0 stevel /* UNUSED 0x01000000 was _QNEXTLESS */ 186 0 stevel #define _QINSERTING 0x04000000 /* Private, module is being inserted */ 187 0 stevel #define _QREMOVING 0x08000000 /* Private, module is being removed */ 188 0 stevel #define _QASSOCIATED 0x10000000 /* queue is associated with a device */ 189 741 masputra #define _QDIRECT 0x20000000 /* Private; transport module uses */ 190 741 masputra /* direct interface to/from sockfs */ 191 0 stevel 192 0 stevel /* queue sqflags (protected by SQLOCK). */ 193 0 stevel #define Q_SQQUEUED 0x01 /* Queue is in the syncq list */ 194 1110 meem #define Q_SQDRAINING 0x02 /* Servicing syncq msgs. */ 195 0 stevel /* This is also noted by the */ 196 0 stevel /* q_draining field, but this one is */ 197 0 stevel /* protected by SQLOCK */ 198 0 stevel 199 0 stevel /* 200 0 stevel * Structure that describes the separate information 201 0 stevel * for each priority band in the queue. 202 0 stevel */ 203 0 stevel typedef struct qband { 204 0 stevel struct qband *qb_next; /* next band's info */ 205 0 stevel size_t qb_count; /* number of bytes in band */ 206 0 stevel struct msgb *qb_first; /* beginning of band's data */ 207 0 stevel struct msgb *qb_last; /* end of band's data */ 208 0 stevel size_t qb_hiwat; /* high water mark for band */ 209 0 stevel size_t qb_lowat; /* low water mark for band */ 210 0 stevel uint_t qb_flag; /* see below */ 211 0 stevel size_t qb_mblkcnt; /* mblk counter for runaway msgs */ 212 0 stevel } qband_t; 213 0 stevel 214 0 stevel /* 215 0 stevel * qband flags 216 0 stevel */ 217 0 stevel #define QB_FULL 0x01 /* band is considered full */ 218 0 stevel #define QB_WANTW 0x02 /* Someone wants to write to band */ 219 0 stevel #define QB_BACK 0x04 /* queue has been back-enabled */ 220 0 stevel 221 0 stevel /* 222 0 stevel * Maximum number of bands. 223 0 stevel */ 224 0 stevel #define NBAND 256 225 0 stevel 226 0 stevel /* 227 0 stevel * Fields that can be manipulated through strqset() and strqget(). 228 0 stevel */ 229 0 stevel typedef enum qfields { 230 0 stevel QHIWAT = 0, /* q_hiwat or qb_hiwat */ 231 0 stevel QLOWAT = 1, /* q_lowat or qb_lowat */ 232 0 stevel QMAXPSZ = 2, /* q_maxpsz */ 233 0 stevel QMINPSZ = 3, /* q_minpsz */ 234 0 stevel QCOUNT = 4, /* q_count or qb_count */ 235 0 stevel QFIRST = 5, /* q_first or qb_first */ 236 0 stevel QLAST = 6, /* q_last or qb_last */ 237 0 stevel QFLAG = 7, /* q_flag or qb_flag */ 238 0 stevel QSTRUIOT = 8, /* q_struiot */ 239 0 stevel QBAD = 9 240 0 stevel } qfields_t; 241 0 stevel 242 0 stevel /* 243 0 stevel * Module information structure 244 0 stevel */ 245 0 stevel struct module_info { 246 0 stevel ushort_t mi_idnum; /* module id number */ 247 0 stevel char *mi_idname; /* module name */ 248 0 stevel ssize_t mi_minpsz; /* min packet size accepted */ 249 0 stevel ssize_t mi_maxpsz; /* max packet size accepted */ 250 0 stevel size_t mi_hiwat; /* hi-water mark */ 251 0 stevel size_t mi_lowat; /* lo-water mark */ 252 0 stevel }; 253 0 stevel 254 0 stevel /* 255 0 stevel * queue information structure (with Synchronous STREAMS extensions) 256 0 stevel */ 257 0 stevel struct qinit { 258 0 stevel int (*qi_putp)(); /* put procedure */ 259 0 stevel int (*qi_srvp)(); /* service procedure */ 260 0 stevel int (*qi_qopen)(); /* called on startup */ 261 0 stevel int (*qi_qclose)(); /* called on finish */ 262 0 stevel int (*qi_qadmin)(); /* for future use */ 263 0 stevel struct module_info *qi_minfo; /* module information structure */ 264 0 stevel struct module_stat *qi_mstat; /* module statistics structure */ 265 0 stevel int (*qi_rwp)(); /* r/w procedure */ 266 0 stevel int (*qi_infop)(); /* information procedure */ 267 0 stevel int qi_struiot; /* stream uio type for struio() */ 268 0 stevel }; 269 0 stevel 270 0 stevel /* 271 0 stevel * Values for qi_struiot and q_struiot: 272 0 stevel */ 273 0 stevel #define STRUIOT_NONE -1 /* doesn't support struio() */ 274 0 stevel #define STRUIOT_DONTCARE 0 /* use current uiomove() (default) */ 275 0 stevel #define STRUIOT_STANDARD 1 /* use standard uiomove() */ 276 0 stevel 277 0 stevel /* 278 0 stevel * Streamtab (used in cdevsw and fmodsw to point to module or driver) 279 0 stevel */ 280 0 stevel struct streamtab { 281 0 stevel struct qinit *st_rdinit; 282 0 stevel struct qinit *st_wrinit; 283 0 stevel struct qinit *st_muxrinit; 284 0 stevel struct qinit *st_muxwinit; 285 0 stevel }; 286 0 stevel 287 0 stevel /* 288 0 stevel * Structure sent to mux drivers to indicate a link. 289 0 stevel */ 290 0 stevel struct linkblk { 291 0 stevel queue_t *l_qtop; /* lowest level write queue of upper stream */ 292 0 stevel /* (set to NULL for persistent links) */ 293 0 stevel queue_t *l_qbot; /* highest level write queue of lower stream */ 294 0 stevel int l_index; /* index for lower stream. */ 295 0 stevel }; 296 0 stevel 297 0 stevel /* 298 0 stevel * Esballoc data buffer freeing routine 299 0 stevel */ 300 0 stevel typedef struct free_rtn { 301 0 stevel void (*free_func)(); 302 0 stevel caddr_t free_arg; 303 0 stevel } frtn_t; 304 0 stevel 305 0 stevel /* 306 0 stevel * Data block descriptor 307 0 stevel * 308 0 stevel * NOTE: db_base, db_lim, db_ref and db_type are the *only* public fields, 309 0 stevel * as described in datab(9S). Everything else is implementation-private. 310 0 stevel */ 311 0 stevel 312 0 stevel #define DBLK_REFMAX 255U 313 0 stevel 314 0 stevel typedef struct datab { 315 0 stevel frtn_t *db_frtnp; 316 0 stevel unsigned char *db_base; 317 0 stevel unsigned char *db_lim; 318 0 stevel unsigned char db_ref; 319 0 stevel unsigned char db_type; 320 0 stevel unsigned char db_flags; 321 0 stevel unsigned char db_struioflag; 322 0 stevel pid_t db_cpid; /* cached pid, needs verification */ 323 0 stevel void *db_cache; /* kmem cache descriptor */ 324 0 stevel struct msgb *db_mblk; 325 0 stevel void (*db_free)(struct msgb *, struct datab *); 326 0 stevel void (*db_lastfree)(struct msgb *, struct datab *); 327 0 stevel intptr_t db_cksumstart; 328 0 stevel intptr_t db_cksumend; 329 0 stevel intptr_t db_cksumstuff; 330 0 stevel union { 331 0 stevel double enforce_alignment; 332 0 stevel unsigned char data[8]; 333 0 stevel struct { 334 0 stevel union { 335 0 stevel uint32_t u32; 336 0 stevel uint16_t u16; 337 0 stevel } cksum_val; /* used to store calculated cksum */ 338 0 stevel uint16_t flags; 339 0 stevel uint16_t pad; 340 0 stevel } cksum; 341 0 stevel /* 342 0 stevel * Union used for future extensions (pointer to data ?). 343 0 stevel */ 344 0 stevel } db_struioun; 345 1110 meem struct fthdr *db_fthdr; 346 0 stevel cred_t *db_credp; /* credential */ 347 0 stevel } dblk_t; 348 0 stevel 349 0 stevel #define db_cksum16 db_struioun.cksum.cksum_val.u16 350 0 stevel #define db_cksum32 db_struioun.cksum.cksum_val.u32 351 0 stevel 352 0 stevel /* 353 0 stevel * Accessor macros for private dblk_t fields (the rest are in <sys/strsun.h>). 354 0 stevel */ 355 0 stevel #define DB_CPID(mp) ((mp)->b_datap->db_cpid) 356 0 stevel #define DB_CRED(mp) ((mp)->b_datap->db_credp) 357 0 stevel #define DB_FTHDR(mp) ((mp)->b_datap->db_fthdr) 358 2760 dg199075 /* 359 2760 dg199075 * Used by GLDv2 to store the TCI information. 360 2760 dg199075 */ 361 2760 dg199075 #define DB_TCI(mp) ((mp)->b_datap->db_struioun.cksum.pad) 362 0 stevel 363 0 stevel /* 364 0 stevel * Message block descriptor 365 0 stevel */ 366 0 stevel typedef struct msgb { 367 0 stevel struct msgb *b_next; 368 0 stevel struct msgb *b_prev; 369 0 stevel struct msgb *b_cont; 370 0 stevel unsigned char *b_rptr; 371 0 stevel unsigned char *b_wptr; 372 0 stevel struct datab *b_datap; 373 0 stevel unsigned char b_band; 374 0 stevel unsigned char b_tag; 375 0 stevel unsigned short b_flag; 376 0 stevel queue_t *b_queue; /* for sync queues */ 377 0 stevel } mblk_t; 378 0 stevel 379 0 stevel /* 380 0 stevel * bcache descriptor 381 0 stevel */ 382 0 stevel typedef struct bcache { 383 0 stevel kmutex_t mutex; 384 0 stevel struct kmem_cache *buffer_cache; 385 0 stevel struct kmem_cache *dblk_cache; 386 0 stevel int alloc; 387 0 stevel int destroy; 388 0 stevel size_t size; 389 0 stevel uint_t align; 390 0 stevel } bcache_t; 391 0 stevel 392 0 stevel /* 393 0 stevel * db_flags values (all implementation private!) 394 0 stevel */ 395 2958 dr146992 #define DBLK_REFMIN 0x01 /* min refcnt stored in low bit */ 396 2958 dr146992 #define DBLK_COOKED 0x02 /* message has been processed once */ 397 6707 brutus #define DBLK_UIOA 0x04 /* uioamove() is pending */ 398 0 stevel 399 0 stevel /* 400 0 stevel * db_struioflag values: 401 0 stevel */ 402 0 stevel #define STRUIO_SPEC 0x01 /* struio{get,put}() special mblk */ 403 0 stevel #define STRUIO_DONE 0x02 /* struio done (could be partial) */ 404 0 stevel #define STRUIO_IP 0x04 /* IP checksum stored in db_struioun */ 405 0 stevel #define STRUIO_ZC 0x08 /* mblk eligible for zero-copy */ 406 0 stevel #define STRUIO_ZCNOTIFY 0x10 /* notify stream head when mblk acked */ 407 0 stevel 408 0 stevel /* 409 0 stevel * Message flags. These are interpreted by the stream head. 410 0 stevel */ 411 0 stevel #define MSGMARK 0x01 /* last byte of message is "marked" */ 412 0 stevel #define MSGNOLOOP 0x02 /* don't loop message around to */ 413 0 stevel /* write side of stream */ 414 0 stevel #define MSGDELIM 0x04 /* message is delimited */ 415 0 stevel /* UNUSED 0x08 was MSGNOGET (can be recycled) */ 416 0 stevel #define MSGMARKNEXT 0x10 /* Private: first byte of next msg marked */ 417 0 stevel #define MSGNOTMARKNEXT 0x20 /* Private: ... not marked */ 418 11042 Erik #define MSGWAITSYNC 0x40 /* Private: waiting for sync squeue enter */ 419 0 stevel 420 0 stevel /* 421 0 stevel * Streams message types. 422 0 stevel */ 423 0 stevel 424 0 stevel /* 425 0 stevel * Data and protocol messages (regular and priority) 426 0 stevel */ 427 0 stevel #define M_DATA 0x00 /* regular data */ 428 0 stevel #define M_PROTO 0x01 /* protocol control */ 429 0 stevel #define M_MULTIDATA 0x02 /* reserved for Multidata use only */ 430 0 stevel 431 0 stevel /* 432 0 stevel * Control messages (regular and priority) 433 0 stevel */ 434 0 stevel #define M_BREAK 0x08 /* line break */ 435 0 stevel #define M_PASSFP 0x09 /* pass file pointer */ 436 0 stevel #define M_EVENT 0x0a /* Obsoleted: do not use */ 437 0 stevel #define M_SIG 0x0b /* generate process signal */ 438 0 stevel #define M_DELAY 0x0c /* real-time xmit delay (1 param) */ 439 0 stevel #define M_CTL 0x0d /* device-specific control message */ 440 0 stevel #define M_IOCTL 0x0e /* ioctl; set/get params */ 441 0 stevel #define M_SETOPTS 0x10 /* set various stream head options */ 442 0 stevel #define M_RSE 0x11 /* reserved for RSE use only */ 443 0 stevel 444 0 stevel /* 445 0 stevel * Control messages (high priority; go to head of queue) 446 0 stevel */ 447 0 stevel #define M_IOCACK 0x81 /* acknowledge ioctl */ 448 0 stevel #define M_IOCNAK 0x82 /* negative ioctl acknowledge */ 449 0 stevel #define M_PCPROTO 0x83 /* priority proto message */ 450 0 stevel #define M_PCSIG 0x84 /* generate process signal */ 451 0 stevel #define M_READ 0x85 /* generate read notification */ 452 0 stevel #define M_FLUSH 0x86 /* flush your queues */ 453 0 stevel #define M_STOP 0x87 /* stop transmission immediately */ 454 0 stevel #define M_START 0x88 /* restart transmission after stop */ 455 0 stevel #define M_HANGUP 0x89 /* line disconnect */ 456 0 stevel #define M_ERROR 0x8a /* send error to stream head */ 457 0 stevel #define M_COPYIN 0x8b /* request to copyin data */ 458 0 stevel #define M_COPYOUT 0x8c /* request to copyout data */ 459 0 stevel #define M_IOCDATA 0x8d /* response to M_COPYIN and M_COPYOUT */ 460 0 stevel #define M_PCRSE 0x8e /* reserved for RSE use only */ 461 0 stevel #define M_STOPI 0x8f /* stop reception immediately */ 462 0 stevel #define M_STARTI 0x90 /* restart reception after stop */ 463 0 stevel #define M_PCEVENT 0x91 /* Obsoleted: do not use */ 464 0 stevel #define M_UNHANGUP 0x92 /* line reconnect, sigh */ 465 6583 meem #define M_CMD 0x93 /* out-of-band ioctl command */ 466 0 stevel 467 0 stevel /* 468 0 stevel * Queue message class definitions. 469 0 stevel */ 470 0 stevel #define QNORM 0x00 /* normal priority messages */ 471 0 stevel #define QPCTL 0x80 /* high priority cntrl messages */ 472 0 stevel 473 0 stevel /* 474 0 stevel * IOCTL structure - this structure is the format of the M_IOCTL message type. 475 0 stevel */ 476 0 stevel #if defined(_LP64) 477 0 stevel struct iocblk { 478 0 stevel int ioc_cmd; /* ioctl command type */ 479 0 stevel cred_t *ioc_cr; /* full credentials */ 480 0 stevel uint_t ioc_id; /* ioctl id */ 481 0 stevel uint_t ioc_flag; /* see below */ 482 0 stevel size_t ioc_count; /* count of bytes in data field */ 483 0 stevel int ioc_rval; /* return value */ 484 0 stevel int ioc_error; /* error code */ 485 0 stevel }; 486 0 stevel #else 487 0 stevel struct iocblk { 488 0 stevel int ioc_cmd; /* ioctl command type */ 489 0 stevel cred_t *ioc_cr; /* full credentials */ 490 0 stevel uint_t ioc_id; /* ioctl id */ 491 0 stevel size_t ioc_count; /* count of bytes in data field */ 492 0 stevel int ioc_error; /* error code */ 493 0 stevel int ioc_rval; /* return value */ 494 0 stevel int ioc_fill1; 495 0 stevel uint_t ioc_flag; /* see below */ 496 0 stevel int ioc_filler[2]; /* reserved for future use */ 497 0 stevel }; 498 0 stevel #endif /* _LP64 */ 499 0 stevel 500 0 stevel typedef struct iocblk *IOCP; 501 0 stevel 502 0 stevel /* {ioc,cp}_flags values */ 503 0 stevel 504 0 stevel #define IOC_MODELS DATAMODEL_MASK /* Note: 0x0FF00000 */ 505 0 stevel #define IOC_ILP32 DATAMODEL_ILP32 /* ioctl origin is ILP32 */ 506 0 stevel #define IOC_LP64 DATAMODEL_LP64 /* ioctl origin is LP64 */ 507 0 stevel #define IOC_NATIVE DATAMODEL_NATIVE 508 0 stevel #define IOC_NONE DATAMODEL_NONE /* dummy comparison value */ 509 0 stevel 510 0 stevel /* 511 0 stevel * Is the ioctl data formatted for our native model? 512 0 stevel */ 513 0 stevel #define IOC_CONVERT_FROM(iocp) ddi_model_convert_from( \ 514 0 stevel ((struct iocblk *)iocp)->ioc_flag) 515 0 stevel 516 0 stevel /* 517 0 stevel * structure for the M_COPYIN and M_COPYOUT message types. 518 0 stevel */ 519 0 stevel #if defined(_LP64) 520 0 stevel struct copyreq { 521 0 stevel int cq_cmd; /* ioctl command (from ioc_cmd) */ 522 0 stevel cred_t *cq_cr; /* full credentials (from ioc_cmd) */ 523 0 stevel uint_t cq_id; /* ioctl id (from ioc_id) */ 524 0 stevel uint_t cq_flag; /* must be zero */ 525 0 stevel mblk_t *cq_private; /* private state information */ 526 0 stevel caddr_t cq_addr; /* address to copy data to/from */ 527 0 stevel size_t cq_size; /* number of bytes to copy */ 528 0 stevel }; 529 0 stevel #else 530 0 stevel struct copyreq { 531 0 stevel int cq_cmd; /* ioctl command (from ioc_cmd) */ 532 0 stevel cred_t *cq_cr; /* full credentials */ 533 0 stevel uint_t cq_id; /* ioctl id (from ioc_id) */ 534 0 stevel caddr_t cq_addr; /* address to copy data to/from */ 535 0 stevel size_t cq_size; /* number of bytes to copy */ 536 0 stevel uint_t cq_flag; /* must be zero */ 537 0 stevel mblk_t *cq_private; /* private state information */ 538 0 stevel int cq_filler[4]; /* reserved for future use */ 539 0 stevel }; 540 0 stevel #endif /* _LP64 */ 541 0 stevel 542 0 stevel /* 543 0 stevel * structure for the M_IOCDATA message type. 544 0 stevel */ 545 0 stevel #if defined(_LP64) 546 0 stevel struct copyresp { 547 0 stevel int cp_cmd; /* ioctl command (from ioc_cmd) */ 548 0 stevel cred_t *cp_cr; /* full credentials (from ioc_cmd) */ 549 0 stevel uint_t cp_id; /* ioctl id (from ioc_id) */ 550 0 stevel uint_t cp_flag; /* datamodel IOC_ flags; see above */ 551 0 stevel mblk_t *cp_private; /* private state information */ 552 0 stevel caddr_t cp_rval; /* status of request: 0 -> success */ 553 0 stevel /* non-zero -> failure */ 554 0 stevel }; 555 0 stevel #else 556 0 stevel struct copyresp { 557 0 stevel int cp_cmd; /* ioctl command (from ioc_cmd) */ 558 0 stevel cred_t *cp_cr; /* full credentials */ 559 0 stevel uint_t cp_id; /* ioctl id (from ioc_id) */ 560 0 stevel caddr_t cp_rval; /* status of request: 0 -> success */ 561 0 stevel /* non-zero -> failure */ 562 0 stevel size_t cp_pad1; 563 0 stevel uint_t cp_pad2; 564 0 stevel mblk_t *cp_private; /* private state information */ 565 0 stevel uint_t cp_flag; /* datamodel IOC_ flags; see above */ 566 0 stevel int cp_filler[3]; 567 0 stevel }; 568 0 stevel #endif /* _LP64 */ 569 0 stevel 570 0 stevel /* 571 0 stevel * Since these structures are all intended to travel in the same message 572 0 stevel * at different stages of a STREAMS ioctl, this union is used to determine 573 0 stevel * the message size in strdoioctl(). 574 0 stevel */ 575 0 stevel union ioctypes { 576 0 stevel struct iocblk iocblk; 577 0 stevel struct copyreq copyreq; 578 0 stevel struct copyresp copyresp; 579 0 stevel }; 580 0 stevel 581 0 stevel /* 582 0 stevel * Options structure for M_SETOPTS message. This is sent upstream 583 0 stevel * by a module or driver to set stream head options. 584 0 stevel */ 585 0 stevel struct stroptions { 586 0 stevel uint_t so_flags; /* options to set */ 587 0 stevel short so_readopt; /* read option */ 588 0 stevel ushort_t so_wroff; /* write offset */ 589 0 stevel ssize_t so_minpsz; /* minimum read packet size */ 590 0 stevel ssize_t so_maxpsz; /* maximum read packet size */ 591 0 stevel size_t so_hiwat; /* read queue high water mark */ 592 0 stevel size_t so_lowat; /* read queue low water mark */ 593 0 stevel unsigned char so_band; /* band for water marks */ 594 0 stevel ushort_t so_erropt; /* error option */ 595 0 stevel ssize_t so_maxblk; /* maximum message block size */ 596 0 stevel ushort_t so_copyopt; /* copy options (see stropts.h) */ 597 898 kais ushort_t so_tail; /* space available at the end */ 598 0 stevel }; 599 0 stevel 600 0 stevel /* flags for stream options set message */ 601 0 stevel 602 0 stevel #define SO_ALL 0x003f /* set all old options */ 603 0 stevel #define SO_READOPT 0x0001 /* set read option */ 604 0 stevel #define SO_WROFF 0x0002 /* set write offset */ 605 0 stevel #define SO_MINPSZ 0x0004 /* set min packet size */ 606 0 stevel #define SO_MAXPSZ 0x0008 /* set max packet size */ 607 0 stevel #define SO_HIWAT 0x0010 /* set high water mark */ 608 0 stevel #define SO_LOWAT 0x0020 /* set low water mark */ 609 0 stevel #define SO_MREADON 0x0040 /* set read notification ON */ 610 0 stevel #define SO_MREADOFF 0x0080 /* set read notification OFF */ 611 0 stevel #define SO_NDELON 0x0100 /* old TTY semantics for NDELAY reads/writes */ 612 0 stevel #define SO_NDELOFF 0x0200 /* STREAMS semantics for NDELAY reads/writes */ 613 0 stevel #define SO_ISTTY 0x0400 /* the stream is acting as a terminal */ 614 0 stevel #define SO_ISNTTY 0x0800 /* the stream is not acting as a terminal */ 615 0 stevel #define SO_TOSTOP 0x1000 /* stop on background writes to this stream */ 616 0 stevel #define SO_TONSTOP 0x2000 /* do not stop on background writes to stream */ 617 0 stevel #define SO_BAND 0x4000 /* water marks affect band */ 618 0 stevel #define SO_DELIM 0x8000 /* messages are delimited */ 619 0 stevel #define SO_NODELIM 0x010000 /* turn off delimiters */ 620 0 stevel #define SO_STRHOLD 0x020000 /* No longer implemented */ 621 0 stevel #define SO_ERROPT 0x040000 /* set error option */ 622 0 stevel #define SO_COPYOPT 0x080000 /* copy option(s) present */ 623 0 stevel #define SO_MAXBLK 0x100000 /* set maximum message block size */ 624 898 kais #define SO_TAIL 0x200000 /* set the extra allocated space */ 625 0 stevel 626 0 stevel #ifdef _KERNEL 627 0 stevel /* 628 0 stevel * Structure for rw (read/write) procedure calls. A pointer 629 0 stevel * to a struiod_t is passed as a parameter to the rwnext() call. 630 0 stevel * 631 0 stevel * Note: DEF_IOV_MAX is defined and used as it is in "fs/vncalls.c" 632 0 stevel * as there isn't a formal definition of IOV_MAX ??? 633 0 stevel */ 634 0 stevel #define DEF_IOV_MAX 16 635 0 stevel 636 0 stevel typedef struct struiod { 637 0 stevel mblk_t *d_mp; /* pointer to mblk (chain) */ 638 0 stevel uio_t d_uio; /* uio info */ 639 0 stevel iovec_t d_iov[DEF_IOV_MAX]; /* iov referenced by uio */ 640 0 stevel } struiod_t; 641 0 stevel 642 0 stevel /* 643 0 stevel * Structure for information procedure calls. 644 0 stevel */ 645 0 stevel typedef struct infod { 646 0 stevel unsigned char d_cmd; /* info info request command */ 647 0 stevel unsigned char d_res; /* info info command results */ 648 0 stevel int d_bytes; /* mblk(s) byte count */ 649 0 stevel int d_count; /* count of mblk(s) */ 650 0 stevel uio_t *d_uiop; /* pointer to uio struct */ 651 0 stevel } infod_t; 652 0 stevel /* 653 0 stevel * Values for d_cmd & d_res. 654 0 stevel */ 655 0 stevel #define INFOD_FIRSTBYTES 0x02 /* return msgbsize() of first mblk */ 656 0 stevel #define INFOD_BYTES 0x04 /* return msgbsize() of all mblk(s) */ 657 0 stevel #define INFOD_COUNT 0x08 /* return count of mblk(s) */ 658 0 stevel #define INFOD_COPYOUT 0x10 /* copyout any M_DATA mblk(s) */ 659 6583 meem 660 6583 meem /* 661 6583 meem * Structure used by _I_CMD mechanism, similar in spirit to iocblk. 662 6583 meem */ 663 6583 meem typedef struct cmdblk { 664 6583 meem int cb_cmd; /* ioctl command type */ 665 6583 meem cred_t *cb_cr; /* full credentials */ 666 6583 meem uint_t cb_len; /* payload size */ 667 6583 meem int cb_error; /* error code */ 668 6583 meem } cmdblk_t; 669 0 stevel 670 0 stevel #endif /* _KERNEL */ 671 0 stevel 672 0 stevel /* 673 0 stevel * Miscellaneous parameters and flags. 674 0 stevel */ 675 0 stevel 676 0 stevel /* 677 0 stevel * Values for stream flag in open to indicate module open, clone open, 678 0 stevel * and the return value for failure. 679 0 stevel */ 680 0 stevel #define MODOPEN 0x1 /* open as a module */ 681 0 stevel #define CLONEOPEN 0x2 /* clone open; pick own minor dev */ 682 0 stevel #define OPENFAIL -1 /* returned for open failure */ 683 0 stevel 684 0 stevel /* 685 0 stevel * Priority definitions for block allocation. 686 0 stevel */ 687 0 stevel #define BPRI_LO 1 688 0 stevel #define BPRI_MED 2 689 0 stevel #define BPRI_HI 3 690 0 stevel 691 0 stevel /* 692 0 stevel * Value for packet size that denotes infinity 693 0 stevel */ 694 0 stevel #define INFPSZ -1 695 0 stevel 696 0 stevel /* 697 0 stevel * Flags for flushq() 698 0 stevel */ 699 0 stevel #define FLUSHALL 1 /* flush all messages */ 700 0 stevel #define FLUSHDATA 0 /* don't flush control messages */ 701 0 stevel 702 0 stevel /* 703 0 stevel * Flag for transparent ioctls 704 0 stevel */ 705 0 stevel #define TRANSPARENT (unsigned int)(-1) 706 0 stevel 707 0 stevel /* 708 0 stevel * Stream head default high/low water marks 709 0 stevel */ 710 0 stevel #define STRHIGH 5120 711 0 stevel #define STRLOW 1024 712 0 stevel 713 0 stevel /* 714 0 stevel * qwriter perimeter types 715 0 stevel */ 716 0 stevel #define PERIM_INNER 1 /* The inner perimeter */ 717 0 stevel #define PERIM_OUTER 2 /* The outer perimeter */ 718 0 stevel 719 0 stevel /* 720 0 stevel * Definitions of Streams macros and function interfaces. 721 0 stevel */ 722 0 stevel 723 0 stevel /* 724 0 stevel * canenable - check if queue can be enabled by putq(). 725 0 stevel */ 726 0 stevel #define canenable(q) !((q)->q_flag & QNOENB) 727 0 stevel 728 0 stevel /* 729 0 stevel * Test if data block type is one of the data messages (i.e. not a control 730 0 stevel * message). 731 0 stevel */ 732 0 stevel #define datamsg(type) \ 733 0 stevel ((type) == M_DATA || \ 734 0 stevel (type) == M_MULTIDATA || \ 735 0 stevel (type) == M_PROTO || \ 736 0 stevel (type) == M_PCPROTO || \ 737 0 stevel (type) == M_DELAY) 738 0 stevel 739 0 stevel /* 740 0 stevel * Extract queue class of message block. 741 0 stevel */ 742 0 stevel #define queclass(bp) (((bp)->b_datap->db_type >= QPCTL) ? QPCTL : QNORM) 743 0 stevel 744 0 stevel /* 745 0 stevel * Align address on next lower word boundary. 746 0 stevel */ 747 0 stevel #define straln(a) (caddr_t)((intptr_t)(a) & -(sizeof (int)-1)) 748 0 stevel 749 0 stevel /* 750 0 stevel * Find the max size of data block. 751 0 stevel */ 752 0 stevel #define bpsize(bp) ((unsigned int)(bp->b_datap->db_lim - bp->b_datap->db_base)) 753 0 stevel 754 0 stevel #ifdef _KERNEL 755 0 stevel 756 0 stevel /* 757 0 stevel * For two-byte M_ERROR messages: indication that a side does not have an error 758 0 stevel */ 759 0 stevel #define NOERROR ((unsigned char)-1) 760 0 stevel 761 0 stevel /* 762 0 stevel * declarations of common routines 763 0 stevel */ 764 0 stevel 765 0 stevel extern mblk_t *allocb(size_t, uint_t); 766 455 meem extern mblk_t *desballoc(unsigned char *, size_t, uint_t, frtn_t *); 767 0 stevel extern mblk_t *esballoc(unsigned char *, size_t, uint_t, frtn_t *); 768 0 stevel extern bcache_t *bcache_create(char *, size_t, uint_t); 769 0 stevel extern void bcache_destroy(bcache_t *); 770 0 stevel extern mblk_t *bcache_allocb(bcache_t *, uint_t); 771 0 stevel extern mblk_t *mkiocb(uint_t); 772 0 stevel extern int testb(size_t, uint_t); 773 0 stevel extern bufcall_id_t bufcall(size_t, uint_t, void (*)(void *), void *); 774 0 stevel extern bufcall_id_t esbbcall(uint_t, void (*)(void *), void *); 775 0 stevel extern void freeb(struct msgb *); 776 0 stevel extern void freemsg(mblk_t *); 777 0 stevel extern mblk_t *dupb(mblk_t *); 778 0 stevel extern mblk_t *dupmsg(mblk_t *); 779 0 stevel extern mblk_t *dupmsg_noloan(mblk_t *); 780 0 stevel extern mblk_t *copyb(mblk_t *); 781 0 stevel extern mblk_t *copymsg(mblk_t *); 782 0 stevel extern void linkb(mblk_t *, mblk_t *); 783 0 stevel extern mblk_t *unlinkb(mblk_t *); 784 0 stevel extern mblk_t *reallocb(mblk_t *, size_t, uint_t); /* private */ 785 0 stevel extern mblk_t *rmvb(mblk_t *, mblk_t *); 786 0 stevel extern int pullupmsg(struct msgb *, ssize_t); 787 0 stevel extern mblk_t *msgpullup(struct msgb *, ssize_t); 788 0 stevel extern int adjmsg(struct msgb *, ssize_t); 789 0 stevel extern size_t msgdsize(struct msgb *); 790 0 stevel extern mblk_t *getq(queue_t *); 791 0 stevel extern void rmvq(queue_t *, mblk_t *); 792 0 stevel extern void flushq(queue_t *, int); 793 0 stevel extern void flushq_common(queue_t *, int, int); 794 0 stevel extern void flushband(queue_t *, unsigned char, int); 795 0 stevel extern int canput(queue_t *); 796 0 stevel extern int bcanput(queue_t *, unsigned char); 797 0 stevel extern int canputnext(queue_t *); 798 0 stevel extern int bcanputnext(queue_t *, unsigned char); 799 0 stevel extern int putq(queue_t *, mblk_t *); 800 0 stevel extern int putbq(queue_t *, mblk_t *); 801 0 stevel extern int insq(queue_t *, mblk_t *, mblk_t *); 802 0 stevel extern void put(queue_t *, mblk_t *); 803 0 stevel extern void putnext(queue_t *, mblk_t *); 804 0 stevel extern int putctl(queue_t *, int); 805 0 stevel extern int putctl1(queue_t *, int, int); 806 0 stevel extern int putnextctl(queue_t *, int); 807 0 stevel extern int putnextctl1(queue_t *, int, int); 808 0 stevel extern queue_t *backq(queue_t *); 809 0 stevel extern void qreply(queue_t *, mblk_t *); 810 0 stevel extern void qenable(queue_t *); 811 0 stevel extern int qsize(queue_t *); 812 0 stevel extern void noenable(queue_t *); 813 0 stevel extern void enableok(queue_t *); 814 0 stevel extern int strqset(queue_t *, qfields_t, unsigned char, intptr_t); 815 0 stevel extern int strqget(queue_t *, qfields_t, unsigned char, void *); 816 0 stevel extern void unbufcall(bufcall_id_t); 817 0 stevel extern void qprocson(queue_t *); 818 0 stevel extern void qprocsoff(queue_t *); 819 0 stevel extern void freezestr(queue_t *); 820 0 stevel extern void unfreezestr(queue_t *); 821 0 stevel extern void qwait(queue_t *); 822 0 stevel extern int qwait_sig(queue_t *); 823 0 stevel extern boolean_t qwait_rw(queue_t *); 824 0 stevel extern void qwriter(queue_t *, mblk_t *, void (*func)(), int); 825 0 stevel extern timeout_id_t qtimeout(queue_t *, void (*func)(void *), void *, clock_t); 826 0 stevel extern bufcall_id_t qbufcall(queue_t *, size_t, uint_t, 827 0 stevel void (*)(void *), void *); 828 0 stevel extern clock_t quntimeout(queue_t *, timeout_id_t); 829 0 stevel extern void qunbufcall(queue_t *, bufcall_id_t); 830 0 stevel extern void strwakeq(queue_t *, int); 831 0 stevel extern int struioget(queue_t *, mblk_t *, struiod_t *, int); 832 0 stevel extern int rwnext(queue_t *, struiod_t *); 833 0 stevel extern int infonext(queue_t *, infod_t *); 834 0 stevel extern int isuioq(queue_t *); 835 0 stevel extern void create_putlocks(queue_t *, int); 836 6769 ja97890 extern int mp_cont_len(mblk_t *, int *); 837 0 stevel 838 0 stevel /* 839 0 stevel * shared or externally configured data structures 840 0 stevel */ 841 0 stevel extern int nstrpush; /* maximum number of pushes allowed */ 842 0 stevel 843 0 stevel #endif /* _KERNEL */ 844 0 stevel 845 0 stevel #ifdef __cplusplus 846 0 stevel } 847 0 stevel #endif 848 0 stevel 849 0 stevel #endif /* _SYS_STREAM_H */ 850
Indexes created Sat Nov 28 01:19:25 UTC 2009
Terms of Use |
Privacy |
Trademarks |
Copyright Policy |
Site Guidelines |
Help
Your use of this web site or any of its content or software indicates your agreement to be bound by these Terms of Use.
Copyright © 1995-2008 Sun Microsystems, Inc.