void
CQ::Init(uint16_t qId, uint16_t entrySize, uint16_t numEntries,
bool irqEnabled, uint16_t irqVec)
{
Queue::Init(qId, entrySize, numEntries);
mIrqEnabled = irqEnabled;
mIrqVec = irqVec;
LOG_NRM("Allocating contiguous CQ memory in dnvme");
if (numEntries < 2)
LOG_WARN("Number elements breaches spec requirement");
if (GetIsAdmin()) {
if (gCtrlrConfig->IsStateEnabled()) {
// At best this will cause tnvme to seg fault or a kernel crash
// The NVME spec states unpredictable outcomes will occur.
LOG_DBG("Creating an ASQ while ctrlr is enabled is a shall not");
throw exception();
}
// We are creating a contiguous ACQ. ACQ's have a constant well known
// element size and no setup is required for this type of Q.
int ret;
struct nvme_create_admn_q q;
q.elements = GetNumEntries();
q.type = ADMIN_CQ;
LOG_NRM("Init contig ACQ: (id, entrySize, numEntries) = (%d, %d, %d)",
GetQId(), GetEntrySize(), GetNumEntries());
if ((ret = ioctl(mFd, NVME_IOCTL_CREATE_ADMN_Q, &q)) < 0) {
LOG_DBG("Q Creation failed by dnvme with error: 0x%02X", ret);
throw exception();
}
} else {
// We are creating a contiguous IOCQ.
struct nvme_prep_cq q;
q.cq_id = GetQId();
q.elements = GetNumEntries();
q.contig = true;
CreateIOCQ(q);
}
// Contiguous Q's are created in dnvme and must be mapped back to user space
mContigBuf = KernelAPI::mmap(mFd, GetQSize(), GetQId(), KernelAPI::MMR_CQ);
if (mContigBuf == NULL) {
LOG_DBG("Unable to mmap contig memory to user space");
throw exception();
}
LOG_NRM(
"Created CQ: (id, entrySize, numEntry, IRQEnable) = (%d, %d, %d, %s)",
GetQId(), GetEntrySize(), GetNumEntries(), GetIrqEnabled() ? "T" : "F");
}
void
CQ::Init(uint16_t qId, uint16_t entrySize, uint16_t numEntries,
const SharedMemBufferPtr memBuffer, bool irqEnabled, uint16_t irqVec)
{
Queue::Init(qId, entrySize, numEntries);
mIrqEnabled = irqEnabled;
mIrqVec = irqVec;
LOG_NRM("Allocating discontiguous CQ memory in tnvme");
if (numEntries < 2)
LOG_WARN("Number elements breaches spec requirement");
if (memBuffer == MemBuffer::NullMemBufferPtr) {
LOG_DBG("Passing an uninitialized SharedMemBufferPtr");
throw exception();
} else if (GetIsAdmin()) {
// There are no appropriate methods for an NVME device to report ASC/ACQ
// creation errors, thus since ASC/ASQ may only be contiguous then don't
// allow these problems to be injected, at best they will only succeed
// to seg fault the app or crash the kernel.
LOG_DBG("Illegal memory alignment will corrupt");
throw exception();
} else if (memBuffer->GetBufSize() < GetQSize()) {
LOG_DBG("Q buffer memory ambiguous to passed size params");
LOG_DBG("Mem buffer size = %d, Q size = %d", memBuffer->GetBufSize(),
GetQSize());
throw exception();
} else if (memBuffer->GetAlignment() != sysconf(_SC_PAGESIZE)) {
// Nonconformance to page alignment will seg fault the app or crash
// the kernel. This state is not testable since no errors can be
// reported by hdw, thus disallow this attempt.
LOG_DBG("Q content memory shall be page aligned");
throw exception();
}
// Zero out the content memory so the P-bit correlates to a newly alloc'd Q.
// Also assuming life time ownership of this object if it wasn't created
// by the RsrcMngr.
mDiscontigBuf = memBuffer;
mDiscontigBuf->Zero();
// We are creating a discontiguous IOCQ
struct nvme_prep_cq q;
q.cq_id = GetQId();
q.elements = GetNumEntries();
q.contig = false;
CreateIOCQ(q);
LOG_NRM(
"Created CQ: (id, entrySize, numEntry, IRQEnable) = (%d, %d, %d, %s)",
GetQId(), GetEntrySize(), GetNumEntries(), GetIrqEnabled() ? "T" : "F");
}
void
SQ::Init(uint16_t qId, uint16_t entrySize, uint32_t numEntries, uint16_t cqId)
{
uint64_t work;
mCqId = cqId;
Queue::Init(qId, entrySize, numEntries);
LOG_NRM("Create SQ: (id,cqid,entrySize,numEntries) = (%d,%d,%d,%d)",
GetQId(), GetCqId(), GetEntrySize(), GetNumEntries());
LOG_NRM("Allocating contiguous SQ memory in dnvme");
if (numEntries < 2) {
throw FrmwkEx(HERE, "Number elements breaches spec requirement");
} else if (gRegisters->Read(CTLSPC_CAP, work) == false) {
throw FrmwkEx(HERE, "Unable to determine MQES");
}
// Detect if doing something that looks suspicious/incorrect/illegal
work &= CAP_MQES;
work += 1; // convert to 1-based
if (work < (uint64_t)numEntries) {
LOG_WARN("Creating Q with %d entries, but DUT only allows %d",
numEntries, (uint32_t)work);
}
if (GetIsAdmin()) {
if (gCtrlrConfig->IsStateEnabled()) {
// At best this will cause tnvme to seg fault or a kernel crash
// The NVME spec states unpredictable outcomes will occur.
throw FrmwkEx(HERE,
"Creating an ASQ while ctrlr is enabled is a shall not");
}
// We are creating a contiguous ASQ. ASQ's have a constant well known
// element size and no setup is required for this type of Q.
int ret;
struct nvme_create_admn_q q;
q.elements = GetNumEntries();
q.type = ADMIN_SQ;
LOG_NRM("Init contig ASQ: (id, cqid, entrySize, numEntries) = "
"(%d, %d, %d, %d)", GetQId(), GetCqId(), GetEntrySize(),
GetNumEntries());
if ((ret = ioctl(mFd, NVME_IOCTL_CREATE_ADMN_Q, &q)) < 0) {
throw FrmwkEx(HERE,
"Q Creation failed by dnvme with error: 0x%02X", ret);
}
} else {
// We are creating a contiguous IOSQ.
struct nvme_prep_sq q;
q.sq_id = GetQId();
q.cq_id = GetCqId();
q.elements = GetNumEntries();
q.contig = true;
CreateIOSQ(q);
}
// Contiguous Q's are created in dnvme and must be mapped back to user space
mContigBuf = KernelAPI::mmap(GetQSize(), GetQId(), KernelAPI::MMR_SQ);
if (mContigBuf == NULL)
throw FrmwkEx(HERE, "Unable to mmap contig memory to user space");
}
void
SQ::Init(uint16_t qId, uint16_t entrySize, uint32_t numEntries,
const SharedMemBufferPtr memBuffer, uint16_t cqId)
{
uint64_t work;
mCqId = cqId;
Queue::Init(qId, entrySize, numEntries);
LOG_NRM("Create SQ: (id,cqid,entrySize,numEntries) = (%d,%d,%d,%d)",
GetQId(), GetCqId(), GetEntrySize(), GetNumEntries());
LOG_NRM("Allocating discontiguous SQ memory in tnvme");
if (numEntries < 2) {
throw FrmwkEx(HERE, "Number elements breaches spec requirement");
} else if (gRegisters->Read(CTLSPC_CAP, work) == false) {
throw FrmwkEx(HERE, "Unable to determine MQES");
}
// Detect if doing something that looks suspicious/incorrect/illegal
work &= CAP_MQES;
work += 1; // convert to 1-based
if (work < (uint64_t)numEntries) {
LOG_WARN("Creating Q with %d entries, but DUT only allows %d",
numEntries, (uint32_t)work);
}
if (memBuffer == MemBuffer::NullMemBufferPtr) {
throw FrmwkEx(HERE, "Passing an uninitialized SharedMemBufferPtr");
} else if (GetIsAdmin()) {
// There are no appropriate methods for an NVME device to report ASC/ACQ
// creation errors, thus since ASC/ASQ may only be contiguous then don't
// allow these problems to be injected, at best they will only succeed
// to seg fault the app or crash the kernel.
throw FrmwkEx(HERE, "Illegal memory alignment will corrupt");
} else if (memBuffer->GetBufSize() < GetQSize()) {
LOG_ERR("Q buffer memory ambiguous to passed size params");
throw FrmwkEx(HERE, "Mem buffer size = %d, Q size = %d",
memBuffer->GetBufSize(), GetQSize());
} else if (memBuffer->GetAlignment() != sysconf(_SC_PAGESIZE)) {
// Nonconformance to page alignment will seg fault the app or crash
// the kernel. This state is not testable since no errors can be
// reported by hdw, thus disallow this attempt.
throw FrmwkEx(HERE, "Q content memory shall be page aligned");
}
// Zero out the content memory so the P-bit correlates to a newly alloc'd Q.
// Also assuming life time ownership of this object if it wasn't created
// by the RsrcMngr.
mDiscontigBuf = memBuffer;
mDiscontigBuf->Zero();
// We are creating a discontiguous IOSQ
struct nvme_prep_sq q;
q.sq_id = GetQId();
q.cq_id = GetCqId();
q.elements = GetNumEntries();
q.contig = false;
CreateIOSQ(q);
}
