queue.h revision f3861e1a2ceec23a5b699c24d814b7775a9e0b52
/*
* CDDL HEADER START
*
* 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
* 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]
*
* CDDL HEADER END
*/
/*
* Copyright 2006 Sun Microsystems, Inc. All rights reserved.
* Use is subject to license terms.
*/
#ifndef _TARGET_QUEUE_H
#define _TARGET_QUEUE_H
#pragma ident "%Z%%M% %I% %E% SMI"
#ifdef __cplusplus
extern "C" {
#endif
#include <pthread.h>
#include <stdarg.h>
#include <synch.h>
#include <iscsitgt_impl.h>
#define Q_CONN_ERRS 0x00001
#define Q_CONN_LOGIN 0x00002
#define Q_CONN_NONIO 0x00004
#define Q_CONN_IO 0x00008
#define Q_SESS_ERRS 0x00010
#define Q_SESS_LOGIN 0x00020
#define Q_SESS_NONIO 0x00040
#define Q_SESS_IO 0x00080
#define Q_STE_ERRS 0x00100
#define Q_STE_NONIO 0x00200
#define Q_STE_IO 0x00400
#define Q_GEN_ERRS 0x01000
#define Q_GEN_DETAILS 0x02000
/*
* When used the queue request will be place at the head of the queue.
*/
#define Q_HIGH 0x10000
extern int qlog_lvl;
typedef enum {
/*
* []----------------------------------------------------------------
* | Messages internal to the SAM-3 portion. When the transport calls
* | the SAM-3 interfaces messages are enqueued to the LU. The LU
* | thread then dequeues these messages and calls the appropriate
* | function for the emulator.
*/
/* ---- from transport ---- */
/* ---- from emulation ---- */
/* ---- Internal SAM-3 messages ---- */
/*
* | End of SAM-3 messages
* []----------------------------------------------------------------
*/
/*
* The ConnectionReader will send packet ready messages when
* data is available. If the socket has an error or is closed
* a conn_lost message will be sent. Packet ready will have the
* number of bytes currently available on the connection. Don't
* free.
*/
/*
* Shutdowns happen from the bottom up. The replies are in place
* so that threads can wait for the top end to disappear, at least
* they must no longer reference any common structures such as
* message queues.
*/
/*
* Here's a special error condition for STE. When using mmap
* to access the backing store of a LUN which is larger than
* the underlying storage it's possible to run out of room
* on the device (no duh). When that happens the OS will send
* the daemon a SIGSBUS. The STE thread catches that signal,
* sends a UNIT ATTENTION to the other side, and closes down
* the STE thread in a special manner. The transport layer
* can then restart another STE thread with the same queues
* which mean outstanding I/O restarts.
*/
/*
* A NopIn request could be sent on the connection receive thread
* except for one little issue. Since both the receive and transmit
* threads could be issuing packets and data to the socket at the
* same time we must protect those writes so that all of the data
* for a single PDU (hdr, checksum, data, checksum) go out together.
* It's possible for the socket to receive so much incoming data
* that writes will be blocked until some of that data has been
* read. If the transmit grabs the lock, attempts to write, and is
* blocked we find a condition where the receiver is also blocked
* processing a nop command because it can't get the lock. So, instead
* we build up the packet and queue it.
*
* This will also occur with Task Management Requests.
*/
/*
* the value will be sent to STE through the session layer.
* STE can use the information however it sees fit.
* The InitiatorName will also be sent which STE can use to
* validate login properties.
*/
/*
* Issued when causing full allocation of backing store.
* This is an internal message used by t10_sam.c
*/
/*
* ---------------- Debug/Management type messages ----------------
*/
/*
* When a thread shutdowns someone must call pthread_join else
* the thread will remain in a zombie state taking up some
* amount of memory.
*/
/*
* Requests from and replys to the management host will be done using
* these messages.
*/
/*
* General debug messages.
*/
/*
* Problem message by some of the auxiliary threads indication
* problems.
*/
} msg_type_t;
typedef struct msg {
*msg_prev;
struct msg *msg_all_next;
void *msg_data;
/*
* This can be used either to insert a message higher into the queue
* or as debug level flags.
*/
} msg_t;
typedef struct target_queue {
*q_tail;
int q_num;
typedef enum mgmt_type {
} mgmt_type_t;
typedef struct mgmt_request {
char *m_targ_name;
/*
* This mutex protects the m_buf pointer from multiple connections
* attempting to update the response at the same time. One management
* request structure is sent to possible multiple connections when
* gathering statistics. The connections/sessions will lock access
* to the buffer.
*/
union {
char **m_resp;
} m_u;
typedef struct name_request {
char *nr_name;
void queue_init();
void queue_message_free(msg_t *);
void queue_walker_free(target_queue_t *q,
void queue_reset(target_queue_t *q);
void ste_queue_data_remove(msg_t *m);
void conn_queue_data_remove(msg_t *m);
void sess_queue_data_remove(msg_t *m);
#ifdef __cplusplus
}
#endif
#endif /* _TARGET_QUEUE_H */