/******************************************************************************
* function:
* qat_engine_init(ENGINE *e)
*
* @param e [IN] - OpenSSL engine pointer
*
* description:
* Qat engine init function, associated with Crypto memory setup
* and cpaStartInstance setups.
******************************************************************************/
static int qat_engine_init(ENGINE *e)
{
int instNum, err, checkLimitStatus;
CpaStatus status = CPA_STATUS_SUCCESS;
CpaBoolean limitDevAccess = CPA_FALSE;
pthread_mutex_lock(&qat_engine_mutex);
if(engine_inited) {
pthread_mutex_unlock(&qat_engine_mutex);
return 1;
}
DEBUG("[%s] ---- Engine Initing\n\n", __func__);
CRYPTO_INIT_QAT_LOG();
if ((err = pthread_key_create(&qatInstanceForThread, NULL)) != 0) {
fprintf(stderr, "pthread_key_create: %s\n", strerror(err));
pthread_mutex_unlock(&qat_engine_mutex);
return 0;
}
checkLimitStatus =
checkLimitDevAccessValue((int *)&limitDevAccess,
ICPConfigSectionName_libcrypto);
if (!checkLimitStatus) {
WARN("Assuming LimitDevAccess = 0\n");
}
/* Initialise the QAT hardware */
if (CPA_STATUS_SUCCESS !=
icp_sal_userStartMultiProcess(ICPConfigSectionName_libcrypto,
limitDevAccess)) {
WARN("icp_sal_userStart failed\n");
pthread_mutex_unlock(&qat_engine_mutex);
return 0;
}
/* Get the number of available instances */
status = cpaCyGetNumInstances(&numInstances);
if (CPA_STATUS_SUCCESS != status) {
WARN("cpaCyGetNumInstances failed, status=%d\n", status);
pthread_mutex_unlock(&qat_engine_mutex);
qat_engine_finish(e);
return 0;
}
if (!numInstances) {
WARN("No crypto instances found\n");
pthread_mutex_unlock(&qat_engine_mutex);
qat_engine_finish(e);
return 0;
}
DEBUG("%s: %d Cy instances got\n", __func__, numInstances);
/* Allocate memory for the instance handle array */
qatInstanceHandles =
(CpaInstanceHandle *) OPENSSL_zalloc(((int)numInstances) *
sizeof(CpaInstanceHandle));
if (NULL == qatInstanceHandles) {
WARN("OPENSSL_zalloc() failed for instance handles.\n");
pthread_mutex_unlock(&qat_engine_mutex);
qat_engine_finish(e);
return 0;
}
/* Get the Cy instances */
status = cpaCyGetInstances(numInstances, qatInstanceHandles);
if (CPA_STATUS_SUCCESS != status) {
WARN("cpaCyGetInstances failed, status=%d\n", status);
pthread_mutex_unlock(&qat_engine_mutex);
qat_engine_finish(e);
return 0;
}
if (0 == enable_external_polling) {
if (qat_is_event_driven()) {
CpaStatus status;
int flags;
int engine_fd;
icp_polling_threads =
(pthread_t *) OPENSSL_zalloc(sizeof(pthread_t));
/* Add the file descriptor to an epoll event list */
internal_efd = epoll_create1(0);
if (-1 == internal_efd) {
WARN("Error creating epoll fd\n");
pthread_mutex_unlock(&qat_engine_mutex);
qat_engine_finish(e);
return 0;
}
for (instNum = 0; instNum < numInstances; instNum++) {
/* Get the file descriptor for the instance */
status =
icp_sal_CyGetFileDescriptor(qatInstanceHandles[instNum],
&engine_fd);
if (CPA_STATUS_FAIL == status) {
WARN("Error getting file descriptor for instance\n");
pthread_mutex_unlock(&qat_engine_mutex);
qat_engine_finish(e);
return 0;
}
/* Make the file descriptor non-blocking */
eng_poll_st[instNum].eng_fd = engine_fd;
eng_poll_st[instNum].inst_index = instNum;
flags = fcntl(engine_fd, F_GETFL, 0);
fcntl(engine_fd, F_SETFL, flags | O_NONBLOCK);
eng_epoll_events[instNum].data.ptr = &eng_poll_st[instNum];
eng_epoll_events[instNum].events = EPOLLIN | EPOLLET;
if (-1 ==
epoll_ctl(internal_efd, EPOLL_CTL_ADD, engine_fd,
&eng_epoll_events[instNum])) {
WARN("Error adding fd to epoll\n");
pthread_mutex_unlock(&qat_engine_mutex);
qat_engine_finish(e);
return 0;
}
}
} else {
icp_polling_threads =
(pthread_t *) OPENSSL_zalloc(((int)numInstances) *
sizeof(pthread_t));
}
if (NULL == icp_polling_threads) {
WARN("OPENSSL_malloc() failed for icp_polling_threads.\n");
pthread_mutex_unlock(&qat_engine_mutex);
qat_engine_finish(e);
return 0;
}
}
/* Set translation function and start each instance */
for (instNum = 0; instNum < numInstances; instNum++) {
/* Set the address translation function */
status = cpaCySetAddressTranslation(qatInstanceHandles[instNum],
virtualToPhysical);
if (CPA_STATUS_SUCCESS != status) {
WARN("cpaCySetAddressTranslation failed, status=%d\n", status);
pthread_mutex_unlock(&qat_engine_mutex);
qat_engine_finish(e);
return 0;
}
/* Start the instances */
status = cpaCyStartInstance(qatInstanceHandles[instNum]);
if (CPA_STATUS_SUCCESS != status) {
WARN("cpaCyStartInstance failed, status=%d\n", status);
pthread_mutex_unlock(&qat_engine_mutex);
qat_engine_finish(e);
return 0;
}
if (0 == enable_external_polling && !qat_is_event_driven()) {
/* Create the polling threads */
if (qat_create_thread(&icp_polling_threads[instNum], NULL,
sendPoll_ns, qatInstanceHandles[instNum])) {
WARN("Polling thread create failed\n");
instance_started[instNum] = 1;
pthread_mutex_unlock(&qat_engine_mutex);
qat_engine_finish(e);
return 0;
}
if (qat_adjust_thread_affinity(icp_polling_threads[instNum]) == 0) {
instance_started[instNum] = 1;
pthread_mutex_unlock(&qat_engine_mutex);
qat_engine_finish(e);
return 0;
}
}
instance_started[instNum] = 1;
}
if (0 == enable_external_polling && qat_is_event_driven()) {
if (qat_create_thread(&icp_polling_threads[0], NULL, eventPoll_ns, NULL)) {
WARN("Epoll thread create failed\n");
pthread_mutex_unlock(&qat_engine_mutex);
qat_engine_finish(e);
return 0;
}
if (qat_adjust_thread_affinity(icp_polling_threads[0]) == 0) {
pthread_mutex_unlock(&qat_engine_mutex);
qat_engine_finish(e);
return 0;
}
}
/* Reset currInst */
currInst = 0;
engine_inited = 1;
pthread_mutex_unlock(&qat_engine_mutex);
return 1;
}
int qat_engine_finish_int(ENGINE *e, int reset_globals)
{
int i;
int ret = 1;
CpaStatus status = CPA_STATUS_SUCCESS;
ENGINE_EPOLL_ST *epollst = NULL;
int pthread_kill_ret;
DEBUG("---- Engine Finishing...\n\n");
pthread_mutex_lock(&qat_engine_mutex);
keep_polling = 0;
if (qat_use_signals()) {
pthread_kill_ret = pthread_kill(timer_poll_func_thread, SIGUSR1);
if (pthread_kill_ret != 0) {
WARN("pthread_kill error\n");
QATerr(QAT_F_QAT_ENGINE_FINISH_INT, QAT_R_PTHREAD_KILL_FAILURE);
ret = 0;
}
}
if (qat_instance_handles) {
for (i = 0; i < qat_num_instances; i++) {
if(instance_started[i]) {
status = cpaCyStopInstance(qat_instance_handles[i]);
if (CPA_STATUS_SUCCESS != status) {
WARN("cpaCyStopInstance failed, status=%d\n", status);
QATerr(QAT_F_QAT_ENGINE_FINISH_INT, QAT_R_STOP_INSTANCE_FAILURE);
ret = 0;
}
instance_started[i] = 0;
}
}
}
/* If polling thread is different from the main thread, wait for polling
* thread to finish. pthread_equal returns 0 when threads are different.
*/
if (!enable_external_polling && !enable_inline_polling &&
pthread_equal(polling_thread, pthread_self()) == 0) {
if (qat_join_thread(polling_thread, NULL) != 0) {
WARN("Polling thread join failed with status: %d\n", ret);
QATerr(QAT_F_QAT_ENGINE_FINISH_INT, QAT_R_PTHREAD_JOIN_FAILURE);
ret = 0;
}
}
polling_thread = pthread_self();
if (qat_instance_handles) {
OPENSSL_free(qat_instance_handles);
qat_instance_handles = NULL;
}
if (!enable_external_polling && !enable_inline_polling &&
qat_is_event_driven()) {
for (i = 0; i < qat_num_instances; i++) {
epollst = (ENGINE_EPOLL_ST*)eng_epoll_events[i].data.ptr;
if (epollst) {
if (-1 ==
epoll_ctl(internal_efd, EPOLL_CTL_DEL,
epollst->eng_fd,
&eng_epoll_events[i])) {
WARN("Error removing fd from epoll\n");
QATerr(QAT_F_QAT_ENGINE_FINISH_INT, QAT_R_EPOLL_CTL_FAILURE);
ret = 0;
}
close(epollst->eng_fd);
}
}
}
/* Reset global variables */
qat_num_instances = 0;
icp_sal_userStop();
engine_inited = 0;
internal_efd = 0;
qat_instance_handles = NULL;
keep_polling = 1;
curr_inst = 0;
qatPerformOpRetries = 0;
/* Reset the configuration global variables (to their default values) only
* if requested, i.e. when we are not re-initializing the engine after
* forking
*/
if (reset_globals) {
enable_external_polling = 0;
enable_inline_polling = 0;
enable_event_driven_polling = 0;
enable_instance_for_thread = 0;
qat_poll_interval = QAT_POLL_PERIOD_IN_NS;
qat_max_retry_count = QAT_CRYPTO_NUM_POLLING_RETRIES;
}
pthread_mutex_unlock(&qat_engine_mutex);
CRYPTO_CLOSE_QAT_LOG();
return ret;
}
/******************************************************************************
* function:
* qat_engine_finish(ENGINE *e)
*
* @param e [IN] - OpenSSL engine pointer
*
* description:
* Qat engine finish function.
******************************************************************************/
static int qat_engine_finish(ENGINE *e)
{
int i;
int ret = 1;
CpaStatus status = CPA_STATUS_SUCCESS;
ENGINE_EPOLL_ST *epollst = NULL;
DEBUG("[%s] ---- Engine Finishing...\n\n", __func__);
pthread_mutex_lock(&qat_engine_mutex);
keep_polling = 0;
if (qatInstanceHandles) {
for (i = 0; i < numInstances; i++) {
if(instance_started[i]) {
status = cpaCyStopInstance(qatInstanceHandles[i]);
if (CPA_STATUS_SUCCESS != status) {
WARN("cpaCyStopInstance failed, status=%d\n", status);
ret = 0;
}
if (0 == enable_external_polling && !qat_is_event_driven()) {
if ((pthread_t *) icp_polling_threads[i] != NULL) {
if (qat_join_thread(icp_polling_threads[i], NULL)) {
WARN("Polling thread join failed\n");
ret = 0;
}
}
}
instance_started[i] = 0;
}
}
}
if (0 == enable_external_polling && qat_is_event_driven()) {
if ((pthread_t *) icp_polling_threads[0] != NULL) {
if (qat_join_thread(icp_polling_threads[0], NULL)) {
WARN("Epoll thread join failed\n");
ret = 0;
}
}
}
if (qatInstanceHandles) {
OPENSSL_free(qatInstanceHandles);
qatInstanceHandles = NULL;
}
if (0 == enable_external_polling && qat_is_event_driven()) {
for (i = 0; i < numInstances; i++) {
epollst = (ENGINE_EPOLL_ST*)eng_epoll_events[i].data.ptr;
if (epollst) {
if (-1 ==
epoll_ctl(internal_efd, EPOLL_CTL_DEL,
epollst->eng_fd,
&eng_epoll_events[i])) {
WARN("Error removing fd from epoll\n");
ret = 0;
}
close(epollst->eng_fd);
}
}
}
if (0 == enable_external_polling) {
if (icp_polling_threads) {
OPENSSL_free(icp_polling_threads);
icp_polling_threads = NULL;
}
}
/* Reset global variables */
numInstances = 0;
icp_sal_userStop();
engine_inited = 0;
internal_efd = 0;
qatInstanceHandles = NULL;
keep_polling = 1;
enable_external_polling = 0;
enable_event_driven_polling = 0;
enable_instance_for_thread = 0;
qatPerformOpRetries = 0;
currInst = 0;
pthread_mutex_unlock(&qat_engine_mutex);
CRYPTO_CLOSE_QAT_LOG();
return ret;
}
int qat_engine_init(ENGINE *e)
{
int instNum, err;
CpaStatus status = CPA_STATUS_SUCCESS;
CpaBoolean limitDevAccess = CPA_FALSE;
int ret_pthread_sigmask;
pthread_mutex_lock(&qat_engine_mutex);
if(engine_inited) {
pthread_mutex_unlock(&qat_engine_mutex);
return 1;
}
DEBUG("QAT Engine initialization:\n");
DEBUG("- External polling: %s\n", enable_external_polling ? "ON": "OFF");
DEBUG("- Inline polling: %s\n", enable_inline_polling ? "ON": "OFF");
DEBUG("- Internal poll interval: %dns\n", qat_poll_interval);
DEBUG("- Epoll timeout: %dms\n", qat_epoll_timeout);
DEBUG("- Event driven polling mode: %s\n", enable_event_driven_polling ? "ON": "OFF");
DEBUG("- Instance for thread: %s\n", enable_instance_for_thread ? "ON": "OFF");
DEBUG("- Max retry count: %d\n", qat_max_retry_count);
CRYPTO_INIT_QAT_LOG();
polling_thread = pthread_self();
if ((err = pthread_key_create(&qatInstanceForThread, NULL)) != 0) {
WARN("pthread_key_create failed: %s\n", strerror(err));
QATerr(QAT_F_QAT_ENGINE_INIT, QAT_R_PTHREAD_CREATE_FAILURE);
pthread_mutex_unlock(&qat_engine_mutex);
return 0;
}
#ifndef OPENSSL_ENABLE_QAT_UPSTREAM_DRIVER
/* limitDevAccess is passed as an input to icp_sal_userStartMultiProcess().
* However, in upstream driver the value is ignored and read directly from
* the configuration file -> No need to parse the file here.
*/
if (!checkLimitDevAccessValue((int *)&limitDevAccess,
ICPConfigSectionName_libcrypto)) {
WARN("Could not load driver config file. Assuming LimitDevAccess = 0\n");
}
#endif
/* Initialise the QAT hardware */
if (CPA_STATUS_SUCCESS !=
icp_sal_userStartMultiProcess(ICPConfigSectionName_libcrypto,
limitDevAccess)) {
WARN("icp_sal_userStart failed\n");
QATerr(QAT_F_QAT_ENGINE_INIT, QAT_R_ICP_SAL_USERSTART_FAIL);
pthread_mutex_unlock(&qat_engine_mutex);
return 0;
}
/* Get the number of available instances */
status = cpaCyGetNumInstances(&qat_num_instances);
if (CPA_STATUS_SUCCESS != status) {
WARN("cpaCyGetNumInstances failed, status=%d\n", status);
QATerr(QAT_F_QAT_ENGINE_INIT, QAT_R_GET_NUM_INSTANCE_FAILURE);
pthread_mutex_unlock(&qat_engine_mutex);
qat_engine_finish(e);
return 0;
}
if (!qat_num_instances) {
WARN("No crypto instances found\n");
QATerr(QAT_F_QAT_ENGINE_INIT, QAT_R_INSTANCE_UNAVAILABLE);
pthread_mutex_unlock(&qat_engine_mutex);
qat_engine_finish(e);
return 0;
}
DEBUG("Found %d Cy instances\n", qat_num_instances);
/* Allocate memory for the instance handle array */
qat_instance_handles =
(CpaInstanceHandle *) OPENSSL_zalloc(((int)qat_num_instances) *
sizeof(CpaInstanceHandle));
if (NULL == qat_instance_handles) {
WARN("OPENSSL_zalloc() failed for instance handles.\n");
QATerr(QAT_F_QAT_ENGINE_INIT, QAT_R_INSTANCE_HANDLE_MALLOC_FAILURE);
pthread_mutex_unlock(&qat_engine_mutex);
qat_engine_finish(e);
return 0;
}
/* Get the Cy instances */
status = cpaCyGetInstances(qat_num_instances, qat_instance_handles);
if (CPA_STATUS_SUCCESS != status) {
WARN("cpaCyGetInstances failed, status=%d\n", status);
QATerr(QAT_F_QAT_ENGINE_INIT, QAT_R_GET_INSTANCE_FAILURE);
pthread_mutex_unlock(&qat_engine_mutex);
qat_engine_finish(e);
return 0;
}
if (!enable_external_polling && !enable_inline_polling) {
if (qat_is_event_driven()) {
CpaStatus status;
int flags;
int engine_fd;
/* Add the file descriptor to an epoll event list */
internal_efd = epoll_create1(0);
if (-1 == internal_efd) {
WARN("Error creating epoll fd\n");
QATerr(QAT_F_QAT_ENGINE_INIT, QAT_R_EPOLL_CREATE_FAILURE);
pthread_mutex_unlock(&qat_engine_mutex);
qat_engine_finish(e);
return 0;
}
for (instNum = 0; instNum < qat_num_instances; instNum++) {
/* Get the file descriptor for the instance */
status =
icp_sal_CyGetFileDescriptor(qat_instance_handles[instNum],
&engine_fd);
if (CPA_STATUS_FAIL == status) {
WARN("Error getting file descriptor for instance\n");
QATerr(QAT_F_QAT_ENGINE_INIT, QAT_R_GET_FILE_DESCRIPTOR_FAILURE);
pthread_mutex_unlock(&qat_engine_mutex);
qat_engine_finish(e);
return 0;
}
/* Make the file descriptor non-blocking */
eng_poll_st[instNum].eng_fd = engine_fd;
eng_poll_st[instNum].inst_index = instNum;
flags = fcntl(engine_fd, F_GETFL, 0);
fcntl(engine_fd, F_SETFL, flags | O_NONBLOCK);
eng_epoll_events[instNum].data.ptr = &eng_poll_st[instNum];
eng_epoll_events[instNum].events = EPOLLIN | EPOLLET;
if (-1 ==
epoll_ctl(internal_efd, EPOLL_CTL_ADD, engine_fd,
&eng_epoll_events[instNum])) {
WARN("Error adding fd to epoll\n");
QATerr(QAT_F_QAT_ENGINE_INIT, QAT_R_EPOLL_CTL_FAILURE);
pthread_mutex_unlock(&qat_engine_mutex);
qat_engine_finish(e);
return 0;
}
}
}
}
/* Set translation function and start each instance */
for (instNum = 0; instNum < qat_num_instances; instNum++) {
/* Set the address translation function */
status = cpaCySetAddressTranslation(qat_instance_handles[instNum],
virtualToPhysical);
if (CPA_STATUS_SUCCESS != status) {
WARN("cpaCySetAddressTranslation failed, status=%d\n", status);
QATerr(QAT_F_QAT_ENGINE_INIT, QAT_R_SET_ADDRESS_TRANSLATION_FAILURE);
pthread_mutex_unlock(&qat_engine_mutex);
qat_engine_finish(e);
return 0;
}
/* Start the instances */
status = cpaCyStartInstance(qat_instance_handles[instNum]);
if (CPA_STATUS_SUCCESS != status) {
WARN("cpaCyStartInstance failed, status=%d\n", status);
QATerr(QAT_F_QAT_ENGINE_INIT, QAT_R_START_INSTANCE_FAILURE);
pthread_mutex_unlock(&qat_engine_mutex);
qat_engine_finish(e);
return 0;
}
instance_started[instNum] = 1;
}
if (!enable_external_polling && !enable_inline_polling) {
if (!qat_is_event_driven()) {
sigemptyset(&set);
sigaddset(&set, SIGUSR1);
ret_pthread_sigmask = pthread_sigmask(SIG_BLOCK, &set, NULL);
if (ret_pthread_sigmask != 0) {
WARN("pthread_sigmask error\n");
QATerr(QAT_F_QAT_ENGINE_INIT, QAT_R_POLLING_THREAD_SIGMASK_FAILURE);
pthread_mutex_unlock(&qat_engine_mutex);
qat_engine_finish(e);
return 0;
}
}
if (qat_create_thread(&polling_thread, NULL,
qat_is_event_driven() ? event_poll_func : timer_poll_func, NULL)) {
WARN("Creation of polling thread failed\n");
QATerr(QAT_F_QAT_ENGINE_INIT, QAT_R_POLLING_THREAD_CREATE_FAILURE);
polling_thread = pthread_self();
pthread_mutex_unlock(&qat_engine_mutex);
qat_engine_finish(e);
return 0;
}
if (qat_adjust_thread_affinity(polling_thread) == 0) {
WARN("Setting polling thread affinity failed\n");
QATerr(QAT_F_QAT_ENGINE_INIT, QAT_R_SET_POLLING_THREAD_AFFINITY_FAILURE);
pthread_mutex_unlock(&qat_engine_mutex);
qat_engine_finish(e);
return 0;
}
if (!qat_is_event_driven()) {
while (!cleared_to_start)
sleep(1);
}
}
/* Reset curr_inst */
curr_inst = 0;
engine_inited = 1;
pthread_mutex_unlock(&qat_engine_mutex);
return 1;
}