2654012f83cec5dc15b61dfe3e4a4915f186e7a6Reza Sabdar * Copyright 2008 Sun Microsystems, Inc. All rights reserved.
2654012f83cec5dc15b61dfe3e4a4915f186e7a6Reza Sabdar * Use is subject to license terms.
2654012f83cec5dc15b61dfe3e4a4915f186e7a6Reza Sabdar * BSD 3 Clause License
2654012f83cec5dc15b61dfe3e4a4915f186e7a6Reza Sabdar * Copyright (c) 2007, The Storage Networking Industry Association.
2654012f83cec5dc15b61dfe3e4a4915f186e7a6Reza Sabdar * Redistribution and use in source and binary forms, with or without
2654012f83cec5dc15b61dfe3e4a4915f186e7a6Reza Sabdar * modification, are permitted provided that the following conditions
2654012f83cec5dc15b61dfe3e4a4915f186e7a6Reza Sabdar * - Redistributions of source code must retain the above copyright
2654012f83cec5dc15b61dfe3e4a4915f186e7a6Reza Sabdar * notice, this list of conditions and the following disclaimer.
2654012f83cec5dc15b61dfe3e4a4915f186e7a6Reza Sabdar * - Redistributions in binary form must reproduce the above copyright
2654012f83cec5dc15b61dfe3e4a4915f186e7a6Reza Sabdar * notice, this list of conditions and the following disclaimer in
2654012f83cec5dc15b61dfe3e4a4915f186e7a6Reza Sabdar * the documentation and/or other materials provided with the
2654012f83cec5dc15b61dfe3e4a4915f186e7a6Reza Sabdar * distribution.
2654012f83cec5dc15b61dfe3e4a4915f186e7a6Reza Sabdar * - Neither the name of The Storage Networking Industry Association (SNIA)
2654012f83cec5dc15b61dfe3e4a4915f186e7a6Reza Sabdar * nor the names of its contributors may be used to endorse or promote
2654012f83cec5dc15b61dfe3e4a4915f186e7a6Reza Sabdar * products derived from this software without specific prior written
2654012f83cec5dc15b61dfe3e4a4915f186e7a6Reza Sabdar * permission.
2654012f83cec5dc15b61dfe3e4a4915f186e7a6Reza Sabdar * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
2654012f83cec5dc15b61dfe3e4a4915f186e7a6Reza Sabdar * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
2654012f83cec5dc15b61dfe3e4a4915f186e7a6Reza Sabdar * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
2654012f83cec5dc15b61dfe3e4a4915f186e7a6Reza Sabdar * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
2654012f83cec5dc15b61dfe3e4a4915f186e7a6Reza Sabdar * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
2654012f83cec5dc15b61dfe3e4a4915f186e7a6Reza Sabdar * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
2654012f83cec5dc15b61dfe3e4a4915f186e7a6Reza Sabdar * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
2654012f83cec5dc15b61dfe3e4a4915f186e7a6Reza Sabdar * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
2654012f83cec5dc15b61dfe3e4a4915f186e7a6Reza Sabdar * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
2654012f83cec5dc15b61dfe3e4a4915f186e7a6Reza Sabdar * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
2654012f83cec5dc15b61dfe3e4a4915f186e7a6Reza Sabdar * POSSIBILITY OF SUCH DAMAGE.
2654012f83cec5dc15b61dfe3e4a4915f186e7a6Reza Sabdar * tlm_allocate_buffers
2654012f83cec5dc15b61dfe3e4a4915f186e7a6Reza Sabdar * build a set of buffers
2654012f83cec5dc15b61dfe3e4a4915f186e7a6Reza Sabdartlm_allocate_buffers(boolean_t write, long xfer_size)
2654012f83cec5dc15b61dfe3e4a4915f186e7a6Reza Sabdar tlm_buffers_t *buffers = ndmp_malloc(sizeof (tlm_buffers_t));
2654012f83cec5dc15b61dfe3e4a4915f186e7a6Reza Sabdar if (buffers->tbs_buffer[buf].tb_buffer_data == 0) {
2654012f83cec5dc15b61dfe3e4a4915f186e7a6Reza Sabdar /* Memory allocation failed. Give everything back */
2654012f83cec5dc15b61dfe3e4a4915f186e7a6Reza Sabdar for (i = 0; i < buf; i++)
2654012f83cec5dc15b61dfe3e4a4915f186e7a6Reza Sabdar buffers->tbs_buffer[buf].tb_buffer_size = (write)
2654012f83cec5dc15b61dfe3e4a4915f186e7a6Reza Sabdar (void) cond_init(&buffers->tbs_out_cv, 0, NULL);
2654012f83cec5dc15b61dfe3e4a4915f186e7a6Reza Sabdar * tlm_release_buffers
2654012f83cec5dc15b61dfe3e4a4915f186e7a6Reza Sabdar * give all memory back to the OS
2654012f83cec5dc15b61dfe3e4a4915f186e7a6Reza Sabdar for (i = 0; i < TLM_TAPE_BUFFERS; i++)
2654012f83cec5dc15b61dfe3e4a4915f186e7a6Reza Sabdar * tlm_buffer_mark_empty
2654012f83cec5dc15b61dfe3e4a4915f186e7a6Reza Sabdar * Mark a buffer empty and clear its flags. No lock is take here:
2654012f83cec5dc15b61dfe3e4a4915f186e7a6Reza Sabdar * the buffer should be marked empty before it is released for use
2654012f83cec5dc15b61dfe3e4a4915f186e7a6Reza Sabdar * by another thread.
2654012f83cec5dc15b61dfe3e4a4915f186e7a6Reza Sabdar buf->tb_full = buf->tb_eof = buf->tb_eot = FALSE;
2654012f83cec5dc15b61dfe3e4a4915f186e7a6Reza Sabdar * tlm_buffer_advance_in_idx
2654012f83cec5dc15b61dfe3e4a4915f186e7a6Reza Sabdar * Advance the input index of the buffers(round-robin) and return pointer
2654012f83cec5dc15b61dfe3e4a4915f186e7a6Reza Sabdar * to the next buffer in the buffer pool.
2654012f83cec5dc15b61dfe3e4a4915f186e7a6Reza Sabdar return (&bufs->tbs_buffer[bufs->tbs_buffer_in]);
2654012f83cec5dc15b61dfe3e4a4915f186e7a6Reza Sabdar * tlm_buffer_advance_out_idx
2654012f83cec5dc15b61dfe3e4a4915f186e7a6Reza Sabdar * Advance the output index of the buffers(round-robin) and return pointer
2654012f83cec5dc15b61dfe3e4a4915f186e7a6Reza Sabdar * to the next buffer in the buffer pool.
2654012f83cec5dc15b61dfe3e4a4915f186e7a6Reza Sabdar return (&bufs->tbs_buffer[bufs->tbs_buffer_out]);
2654012f83cec5dc15b61dfe3e4a4915f186e7a6Reza Sabdar * tlm_buffer_in_buf
2654012f83cec5dc15b61dfe3e4a4915f186e7a6Reza Sabdar * Return pointer to the next buffer in the buffer pool.
2654012f83cec5dc15b61dfe3e4a4915f186e7a6Reza Sabdar * tlm_buffer_out_buf
2654012f83cec5dc15b61dfe3e4a4915f186e7a6Reza Sabdar * Return pointer to the next buffer in the buffer pool.
2654012f83cec5dc15b61dfe3e4a4915f186e7a6Reza Sabdartlm_buffer_out_buf(tlm_buffers_t *bufs, int *idx)
2654012f83cec5dc15b61dfe3e4a4915f186e7a6Reza Sabdar * tlm_buffer_release_in_buf
2654012f83cec5dc15b61dfe3e4a4915f186e7a6Reza Sabdar * Another buffer is filled. Wake up the consumer if it's waiting for it.
2654012f83cec5dc15b61dfe3e4a4915f186e7a6Reza Sabdar * tlm_buffer_release_out_buf
2654012f83cec5dc15b61dfe3e4a4915f186e7a6Reza Sabdar * A buffer is used. Wake up the producer to re-fill a buffer if it's waiting
2654012f83cec5dc15b61dfe3e4a4915f186e7a6Reza Sabdar * for the buffer to be used.
2654012f83cec5dc15b61dfe3e4a4915f186e7a6Reza Sabdar * tlm_buffer_in_buf_wait
2654012f83cec5dc15b61dfe3e4a4915f186e7a6Reza Sabdar * Wait for the input buffer to get available.
2654012f83cec5dc15b61dfe3e4a4915f186e7a6Reza Sabdar while ((bufs->tbs_flags & TLM_BUF_IN_READY) == 0)
2654012f83cec5dc15b61dfe3e4a4915f186e7a6Reza Sabdar (void) cond_wait(&bufs->tbs_in_cv, &bufs->tbs_mtx);
2654012f83cec5dc15b61dfe3e4a4915f186e7a6Reza Sabdar * tlm_buffer_setup_timer
2654012f83cec5dc15b61dfe3e4a4915f186e7a6Reza Sabdar * Set up the time out value.
2654012f83cec5dc15b61dfe3e4a4915f186e7a6Reza Sabdarstatic inline void
2654012f83cec5dc15b61dfe3e4a4915f186e7a6Reza Sabdartlm_buffer_setup_timer(timestruc_t *timo, unsigned milli_timo)
2654012f83cec5dc15b61dfe3e4a4915f186e7a6Reza Sabdar * tlm_buffer_in_buf_timed_wait
2654012f83cec5dc15b61dfe3e4a4915f186e7a6Reza Sabdar * Wait for the input buffer to get ready with a time out.
2654012f83cec5dc15b61dfe3e4a4915f186e7a6Reza Sabdartlm_buffer_in_buf_timed_wait(tlm_buffers_t *bufs, unsigned int milli_timo)
2654012f83cec5dc15b61dfe3e4a4915f186e7a6Reza Sabdar (void) cond_reltimedwait(&bufs->tbs_in_cv, &bufs->tbs_mtx, &timo);
2654012f83cec5dc15b61dfe3e4a4915f186e7a6Reza Sabdar * TLM_BUF_IN_READY doesn't matter for timedwait but clear
2654012f83cec5dc15b61dfe3e4a4915f186e7a6Reza Sabdar * it here so that cond_wait doesn't get the wrong result.
2654012f83cec5dc15b61dfe3e4a4915f186e7a6Reza Sabdar * tlm_buffer_out_buf_timed_wait
2654012f83cec5dc15b61dfe3e4a4915f186e7a6Reza Sabdar * Wait for the output buffer to get ready with a time out.
2654012f83cec5dc15b61dfe3e4a4915f186e7a6Reza Sabdartlm_buffer_out_buf_timed_wait(tlm_buffers_t *bufs, unsigned int milli_timo)
2654012f83cec5dc15b61dfe3e4a4915f186e7a6Reza Sabdar (void) cond_reltimedwait(&bufs->tbs_out_cv, &bufs->tbs_mtx, &timo);
2654012f83cec5dc15b61dfe3e4a4915f186e7a6Reza Sabdar * TLM_BUF_OUT_READY doesn't matter for timedwait but clear
2654012f83cec5dc15b61dfe3e4a4915f186e7a6Reza Sabdar * it here so that cond_wait doesn't get the wrong result.
2654012f83cec5dc15b61dfe3e4a4915f186e7a6Reza Sabdar * tlm_cmd_wait
2654012f83cec5dc15b61dfe3e4a4915f186e7a6Reza Sabdar * TLM command synchronization typically use by command
2654012f83cec5dc15b61dfe3e4a4915f186e7a6Reza Sabdar * parent threads to wait for launched threads to initialize.
2654012f83cec5dc15b61dfe3e4a4915f186e7a6Reza Sabdartlm_cmd_wait(tlm_cmd_t *cmd, uint32_t event_type)
2654012f83cec5dc15b61dfe3e4a4915f186e7a6Reza Sabdar * tlm_cmd_signal
2654012f83cec5dc15b61dfe3e4a4915f186e7a6Reza Sabdar * TLM command synchronization typically use by launched threads
2654012f83cec5dc15b61dfe3e4a4915f186e7a6Reza Sabdar * to unleash the parent thread.