1 /*- 2 * BSD LICENSE 3 * 4 * Copyright (c) Intel Corporation. All rights reserved. 5 * 6 * Redistribution and use in source and binary forms, with or without 7 * modification, are permitted provided that the following conditions 8 * are met: 9 * 10 * * Redistributions of source code must retain the above copyright 11 * notice, this list of conditions and the following disclaimer. 12 * * Redistributions in binary form must reproduce the above copyright 13 * notice, this list of conditions and the following disclaimer in 14 * the documentation and/or other materials provided with the 15 * distribution. 16 * * Neither the name of Intel Corporation nor the names of its 17 * contributors may be used to endorse or promote products derived 18 * from this software without specific prior written permission. 19 * 20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 21 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 22 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 23 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 24 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 25 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 26 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 27 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 28 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 29 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 30 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 31 */ 32 33 #ifndef SPDK_THREAD_INTERNAL_H_ 34 #define SPDK_THREAD_INTERNAL_H_ 35 36 #include "spdk/assert.h" 37 #include "spdk/thread.h" 38 #include "spdk/tree.h" 39 40 /** 41 * \brief Represents a per-thread channel for accessing an I/O device. 42 * 43 * An I/O device may be a physical entity (i.e. NVMe controller) or a software 44 * entity (i.e. a blobstore). 45 * 46 * This structure is not part of the API - all accesses should be done through 47 * spdk_io_channel function calls. 48 */ 49 struct spdk_io_channel { 50 struct spdk_thread *thread; 51 struct io_device *dev; 52 uint32_t ref; 53 uint32_t destroy_ref; 54 RB_ENTRY(spdk_io_channel) node; 55 spdk_io_channel_destroy_cb destroy_cb; 56 57 uint8_t _padding[40]; 58 /* 59 * Modules will allocate extra memory off the end of this structure 60 * to store references to hardware-specific references (i.e. NVMe queue 61 * pairs, or references to child device spdk_io_channels (i.e. 62 * virtual bdevs). 63 */ 64 }; 65 66 SPDK_STATIC_ASSERT(sizeof(struct spdk_io_channel) == SPDK_IO_CHANNEL_STRUCT_SIZE, "incorrect size"); 67 68 #endif /* SPDK_THREAD_INTERNAL_H_ */ 69