-
Notifications
You must be signed in to change notification settings - Fork 129
/
Copy pathe_qat.c
1523 lines (1383 loc) · 47.6 KB
/
e_qat.c
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/* ====================================================================
*
*
* BSD LICENSE
*
* Copyright(c) 2016-2024 Intel Corporation.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
* * Neither the name of Intel Corporation nor the names of its
* contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
*
* ====================================================================
*/
/*****************************************************************************
* @file e_qat.c
*
* This file provides a OpenSSL engine for the quick assist API
*
*****************************************************************************/
/* macros defined to allow use of the cpu get and set affinity functions */
#ifndef _GNU_SOURCE
# define _GNU_SOURCE
#endif
#ifndef __USE_GNU
# define __USE_GNU
#endif
/* Defines */
#ifdef QAT_HW
# ifdef QAT_HW_INTREE
# ifndef ENABLE_QAT_HW_SHA3
# define ENABLE_QAT_HW_SHA3
# endif
# ifndef ENABLE_QAT_HW_CHACHAPOLY
# define ENABLE_QAT_HW_CHACHAPOLY
# endif
# endif
#endif
/* Standard Includes */
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <pthread.h>
#include <unistd.h>
#include <ctype.h>
#include <fcntl.h>
#ifndef __FreeBSD__
# include <sys/epoll.h>
# include <sys/types.h>
# include <sys/eventfd.h>
#endif
#include <unistd.h>
#include <signal.h>
#include <time.h>
/* Local Includes */
#include "e_qat.h"
#include "qat_fork.h"
#include "qat_evp.h"
#include "qat_utils.h"
#ifdef QAT_HW
#ifndef QAT_BORINGSSL
# include "qat_hw_ciphers.h"
#endif /* QAT_BORINGSSL */
# include "qat_hw_polling.h"
# include "qat_hw_rsa.h"
#ifndef QAT_BORINGSSL
# include "qat_hw_dsa.h"
# include "qat_hw_dh.h"
# include "qat_hw_gcm.h"
# include "qat_hw_ccm.h"
#endif /* QAT_BORINGSSL */
/* QAT includes */
# include "cpa.h"
# include "cpa_cy_im.h"
# include "cpa_cy_common.h"
# include "cpa_types.h"
# include "icp_sal_user.h"
# include "icp_sal_poll.h"
#endif
#ifdef QAT_SW
# include "qat_sw_rsa.h"
# include "qat_sw_ecx.h"
# include "qat_sw_ec.h"
# include "qat_sw_polling.h"
# include "crypto_mb/cpu_features.h"
# ifdef ENABLE_QAT_SW_SM4_GCM
# include "crypto_mb/sm4_gcm.h"
# endif
# ifdef ENABLE_QAT_SW_SM4_CCM
# include "crypto_mb/sm4_ccm.h"
# endif
#endif
#ifdef ENABLE_QAT_SW_GCM
#ifndef QAT_BORINGSSL
# include "qat_sw_gcm.h"
#endif /* QAT_BORINGSSL */
#endif
#ifdef QAT_SW_IPSEC
# if defined(ENABLE_QAT_FIPS) && defined(ENABLE_QAT_SW_SHA2)
# include "qat_sw_sha2.h"
# endif
#endif
/* OpenSSL Includes */
#include <openssl/err.h>
#include <openssl/objects.h>
#include <openssl/crypto.h>
#if defined(QAT_SW) || defined(QAT_SW_IPSEC)
/* __cpuid(unsigned int info[4], unsigned int leaf, unsigned int subleaf); */
# define __cpuid(x, y, z) \
asm volatile("cpuid" : "=a"(x[0]), "=b"(x[1]), "=c"(x[2]), "=d"(x[3]) : "a"(y), "c"(z))
# define Genu 0x756e6547
# define ineI 0x49656e69
# define ntel 0x6c65746e
# define VAES_BIT 9
# define VPCLMULQDQ_BIT 10
# define AVX512F_BIT 16
# define AVX2_BIT 5
#endif
#define QAT_MAX_INPUT_STRING_LENGTH 1024
#ifndef QAT_ENGINE_ID
# define QAT_ENGINE_ID qatengine
#endif
#ifdef ENABLE_QAT_FIPS
int qat_fips_key_zeroize;
int qat_fips_kat_test;
#endif
/* Qat engine id declaration */
const char *engine_qat_id = STR(QAT_ENGINE_ID);
#if defined(QAT_HW) && defined(QAT_SW)
const char *engine_qat_name =
"Reference implementation of QAT crypto engine(qat_hw & qat_sw) v1.8.0";
#elif QAT_HW
const char *engine_qat_name =
"Reference implementation of QAT crypto engine(qat_hw) v1.8.0";
#else
const char *engine_qat_name =
"Reference implementation of QAT crypto engine(qat_sw) v1.8.0";
#endif
unsigned int engine_inited = 0;
int fallback_to_openssl = 0;
#if defined(QAT_OPENSSL_3) && !defined(QAT_OPENSSL_PROVIDER)
int qat_openssl3_prf_fallback = 0;
int qat_openssl3_hkdf_fallback = 0;
int qat_openssl3_sha_fallback = 0;
#endif
int qat_openssl3_sm2_fallback = 0;
int qat_openssl3_sm3_fallback = 0;
int fallback_to_qat_sw = 0; /* QAT HW initialize fail, offload to QAT SW. */
int qat_hw_offload = 0;
int qat_sw_offload = 0;
int qat_hw_rsa_offload = 0;
int qat_hw_ecx_offload = 0;
int qat_hw_ecdh_offload = 0;
int qat_hw_ecdsa_offload = 0;
int qat_hw_prf_offload = 0;
int qat_hw_hkdf_offload = 0;
int qat_hw_gcm_offload = 0;
int qat_sw_rsa_offload = 0;
int qat_sw_ecx_offload = 0;
int qat_sw_ecdh_offload = 0;
int qat_sw_ecdsa_offload = 0;
int qat_sw_gcm_offload = 0;
int qat_hw_chacha_poly_offload = 0;
int qat_hw_aes_cbc_hmac_sha_offload = 0;
int qat_hw_sm4_cbc_offload = 0;
int qat_sw_sm2_offload = 0;
int qat_hw_sm2_offload = 0;
int qat_hw_sha_offload = 0;
int qat_hw_sm3_offload = 0;
# ifdef ENABLE_QAT_FIPS
int qat_sw_sha_offload = 0;
# endif
# ifdef QAT_OPENSSL_PROVIDER
int qat_hw_dsa_offload = 0;
int qat_hw_dh_offload = 0;
int qat_hw_ecx_448_offload = 0;
# endif
int qat_sw_sm3_offload = 0;
int qat_sw_sm4_cbc_offload = 0;
int qat_sw_sm4_gcm_offload = 0;
int qat_sw_sm4_ccm_offload = 0;
int qat_hw_aes_ccm_offload = 0;
int qat_hw_keep_polling = 1;
int qat_sw_keep_polling = 1;
int enable_external_polling = 0;
int enable_heuristic_polling = 0;
pthread_mutex_t qat_engine_mutex = PTHREAD_MUTEX_INITIALIZER;
pthread_t qat_polling_thread;
sem_t hw_polling_thread_sem;
/* QAT number of in-flight requests */
int num_requests_in_flight = 0;
int num_asym_requests_in_flight = 0;
int num_kdf_requests_in_flight = 0;
int num_cipher_pipeline_requests_in_flight = 0;
/* Multi-buffer number of items in queue */
int num_asym_mb_items_in_queue = 0;
int num_kdf_mb_items_in_queue = 0;
int num_cipher_mb_items_in_queue = 0;
sigset_t set = {{0}};
pthread_t qat_timer_poll_func_thread = 0;
int cleared_to_start = 0;
pthread_mutex_t qat_poll_mutex = PTHREAD_MUTEX_INITIALIZER;
pthread_cond_t qat_poll_condition = PTHREAD_COND_INITIALIZER;
int qat_cond_wait_started = 0;
#ifdef QAT_HW
# define QAT_CONFIG_SECTION_NAME_SIZE 64
# if defined(QAT_HW_FBSD_INTREE)
char qat_config_section_name[QAT_CONFIG_SECTION_NAME_SIZE] = "SSL";
# else
char qat_config_section_name[QAT_CONFIG_SECTION_NAME_SIZE] = "SHIM";
# endif
char *ICPConfigSectionName_libcrypto = qat_config_section_name;
int enable_inline_polling = 0;
int enable_event_driven_polling = 0;
int enable_instance_for_thread = 0;
int disable_qat_offload = 0;
/* By default Software fallback disabled in QAT FIPs mode.
* Always enable_sw_fallback is zero in QAT FIPs mode.
*/
int enable_sw_fallback = 0;
CpaInstanceHandle *qat_instance_handles = NULL;
Cpa16U qat_num_instances = 0;
Cpa16U qat_asym_num_instance = 0;
Cpa16U qat_sym_num_instance = 0;
Cpa16U qat_svm_num_instance = 0;
Cpa16U qat_contig_num_instance = 0;
Cpa32U qat_num_devices = 0;
pthread_key_t thread_local_variables;
pthread_mutex_t qat_instance_mutex = PTHREAD_MUTEX_INITIALIZER;
qat_instance_details_t qat_instance_details[QAT_MAX_CRYPTO_INSTANCES] = {{{0}}};
qat_accel_details_t qat_accel_details[QAT_MAX_CRYPTO_ACCELERATORS] = {{0}};
useconds_t qat_poll_interval = QAT_POLL_PERIOD_IN_NS;
int qat_epoll_timeout = QAT_EPOLL_TIMEOUT_IN_MS;
int qat_max_retry_count = QAT_CRYPTO_NUM_POLLING_RETRIES;
unsigned int qat_map_sym_inst[QAT_MAX_CRYPTO_INSTANCES] = {'\0'};
unsigned int qat_map_asym_inst[QAT_MAX_CRYPTO_INSTANCES] = {'\0'};
unsigned int qat_map_svm_inst[QAT_MAX_CRYPTO_INSTANCES] = {'\0'};
#endif
#ifdef QAT_SW
/* RSA */
BIGNUM *e_check = NULL;
mb_thread_data *mb_tlv = NULL;
pthread_key_t mb_thread_key;
#endif
#ifdef QAT_HW
uint64_t qat_hw_algo_enable_mask = 0xFFFFF;
#else
uint64_t qat_hw_algo_enable_mask = 0;
#endif
#if defined(QAT_SW) || defined(QAT_SW_IPSEC)
uint64_t qat_sw_algo_enable_mask = 0xFFFFF;
#else
uint64_t qat_sw_algo_enable_mask = 0;
#endif
/* Algorithm reload needs to free the previous method and reallocate it to
exclude the impact of different offload modes, like QAT_HW -> QAT_SW.
Use this flag to distinguish it from the other cases. */
int qat_reload_algo = 0;
/* For QAT_HW & QAT_SW co-existence submission. */
int qat_rsa_coexist = 0;
int qat_ecdh_coexist = 0;
int qat_ecdsa_coexist = 0;
int qat_ecx_coexist = 0;
int qat_sm4_cbc_coexist = 0;
__thread unsigned int qat_sw_rsa_priv_req = 0;
__thread unsigned int qat_sw_rsa_pub_req = 0;
__thread unsigned int qat_sw_ecdsa_sign_req = 0;
__thread unsigned int qat_sw_ecdh_keygen_req = 0;
__thread unsigned int qat_sw_ecdh_derive_req = 0;
__thread unsigned int qat_sw_ecx_keygen_req = 0;
__thread unsigned int qat_sw_ecx_derive_req = 0;
__thread unsigned int qat_sw_sm4_cbc_cipher_req;
__thread int num_rsa_priv_retry = 0;
__thread int num_rsa_pub_retry = 0;
__thread int num_ecdsa_sign_retry = 0;
__thread int num_ecdh_keygen_retry = 0;
__thread int num_ecdh_derive_retry = 0;
__thread int num_ecx_keygen_retry = 0;
__thread int num_ecx_derive_retry = 0;
__thread int num_sm4_cbc_cipher_retry = 0;
__thread unsigned long long num_rsa_hw_priv_reqs = 0;
__thread unsigned long long num_rsa_sw_priv_reqs = 0;
__thread unsigned long long num_rsa_hw_pub_reqs = 0;
__thread unsigned long long num_rsa_sw_pub_reqs = 0;
__thread unsigned long long num_ecdsa_hw_sign_reqs = 0;
__thread unsigned long long num_ecdsa_sw_sign_reqs = 0;
__thread unsigned long long num_ecdh_hw_keygen_reqs = 0;
__thread unsigned long long num_ecdh_sw_keygen_reqs = 0;
__thread unsigned long long num_ecdh_hw_derive_reqs = 0;
__thread unsigned long long num_ecdh_sw_derive_reqs = 0;
__thread unsigned long long num_ecx_hw_keygen_reqs = 0;
__thread unsigned long long num_ecx_sw_keygen_reqs = 0;
__thread unsigned long long num_ecx_hw_derive_reqs = 0;
__thread unsigned long long num_ecx_sw_derive_reqs = 0;
__thread unsigned long long num_sm4_cbc_hw_cipher_reqs = 0;
__thread unsigned long long num_sm4_cbc_sw_cipher_reqs = 0;
#ifndef __FreeBSD__
clock_t clock_id = CLOCK_MONOTONIC_RAW;
#else
clock_t clock_id = CLOCK_MONOTONIC_PRECISE;
#endif
#if ! defined(QAT_BORINGSSL) && ! defined(QAT_OPENSSL_PROVIDER)
const ENGINE_CMD_DEFN qat_cmd_defns[] = {
{
QAT_CMD_ENABLE_EXTERNAL_POLLING,
"ENABLE_EXTERNAL_POLLING",
"Enables the external polling interface to the engine.",
ENGINE_CMD_FLAG_NO_INPUT},
{
QAT_CMD_POLL,
"POLL",
"Polls the engine for any completed requests",
ENGINE_CMD_FLAG_NO_INPUT},
#ifdef QAT_HW
{
QAT_CMD_SET_INSTANCE_FOR_THREAD,
"SET_INSTANCE_FOR_THREAD",
"Set instance to be used by this thread",
ENGINE_CMD_FLAG_NUMERIC},
{
QAT_CMD_GET_NUM_OP_RETRIES,
"GET_NUM_OP_RETRIES",
"Get number of retries",
ENGINE_CMD_FLAG_NO_INPUT},
{
QAT_CMD_SET_MAX_RETRY_COUNT,
"SET_MAX_RETRY_COUNT",
"Set maximum retry count",
ENGINE_CMD_FLAG_NUMERIC},
{
QAT_CMD_SET_INTERNAL_POLL_INTERVAL,
"SET_INTERNAL_POLL_INTERVAL",
"Set internal polling interval",
ENGINE_CMD_FLAG_NUMERIC},
# ifndef __FreeBSD__
{
QAT_CMD_GET_EXTERNAL_POLLING_FD,
"GET_EXTERNAL_POLLING_FD",
"Returns non blocking fd for crypto engine",
ENGINE_CMD_FLAG_NO_INPUT},
{
QAT_CMD_ENABLE_EVENT_DRIVEN_POLLING_MODE,
"ENABLE_EVENT_DRIVEN_POLLING_MODE",
"Set event driven polling mode",
ENGINE_CMD_FLAG_NO_INPUT},
# endif
{
QAT_CMD_GET_NUM_CRYPTO_INSTANCES,
"GET_NUM_CRYPTO_INSTANCES",
"Get the number of crypto instances",
ENGINE_CMD_FLAG_NO_INPUT},
# ifndef __FreeBSD__
{
QAT_CMD_DISABLE_EVENT_DRIVEN_POLLING_MODE,
"DISABLE_EVENT_DRIVEN_POLLING_MODE",
"Unset event driven polling mode",
ENGINE_CMD_FLAG_NO_INPUT},
# endif
{
QAT_CMD_SET_EPOLL_TIMEOUT,
"SET_EPOLL_TIMEOUT",
"Set epoll_wait timeout",
ENGINE_CMD_FLAG_NUMERIC},
{
QAT_CMD_SET_CRYPTO_SMALL_PACKET_OFFLOAD_THRESHOLD,
"SET_CRYPTO_SMALL_PACKET_OFFLOAD_THRESHOLD",
"Set QAT small packet threshold",
ENGINE_CMD_FLAG_STRING},
{
QAT_CMD_ENABLE_INLINE_POLLING,
"ENABLE_INLINE_POLLING",
"Enables the inline polling mode.",
ENGINE_CMD_FLAG_NO_INPUT},
#endif
{
QAT_CMD_ENABLE_HEURISTIC_POLLING,
"ENABLE_HEURISTIC_POLLING",
"Enable the heuristic polling mode",
ENGINE_CMD_FLAG_NO_INPUT},
{
QAT_CMD_GET_NUM_REQUESTS_IN_FLIGHT,
"GET_NUM_REQUESTS_IN_FLIGHT",
"Get the number of in-flight requests",
ENGINE_CMD_FLAG_NUMERIC},
{
QAT_CMD_INIT_ENGINE,
"INIT_ENGINE",
"Initializes the engine if not already initialized",
ENGINE_CMD_FLAG_NO_INPUT},
#ifdef QAT_HW
{
QAT_CMD_SET_CONFIGURATION_SECTION_NAME,
"SET_CONFIGURATION_SECTION_NAME",
"Set the configuration section to use in QAT driver configuration file",
ENGINE_CMD_FLAG_STRING},
{
QAT_CMD_ENABLE_SW_FALLBACK,
"ENABLE_SW_FALLBACK",
"Enables the fallback to SW if the acceleration devices go offline",
ENGINE_CMD_FLAG_NO_INPUT},
{
QAT_CMD_HEARTBEAT_POLL,
"HEARTBEAT_POLL",
"Check the acceleration devices are still functioning",
ENGINE_CMD_FLAG_NO_INPUT},
{
QAT_CMD_DISABLE_QAT_OFFLOAD,
"DISABLE_QAT_OFFLOAD",
"Perform crypto operations on core",
ENGINE_CMD_FLAG_NO_INPUT},
#endif
#ifdef QAT_HW
{
QAT_CMD_HW_ALGO_BITMAP,
"HW_ALGO_BITMAP",
"Set the HW algorithm bitmap and reload the algorithm registration",
ENGINE_CMD_FLAG_STRING
},
#endif
#ifdef QAT_SW
{
QAT_CMD_SW_ALGO_BITMAP,
"SW_ALGO_BITMAP",
"Set the SW algorithm bitmap and reload the algorithm registration",
ENGINE_CMD_FLAG_STRING
},
#endif
{0, NULL, NULL, 0}
};
#endif /* QAT_BORINGSSL */
/******************************************************************************
* function:
* qat_engine_destroy(ENGINE *e)
*
* @param e [IN] - OpenSSL engine pointer
*
* description:
* Qat engine destroy function, required by Openssl engine API.
* Cleanup all the method structures here.
*
******************************************************************************/
#if !defined(QAT_OPENSSL_PROVIDER)
static int qat_engine_destroy(ENGINE *e)
{
DEBUG("---- Destroying Engine...\n\n");
# ifdef QAT_HW
# ifndef QAT_BORINGSSL
qat_free_DH_methods();
qat_free_DSA_methods();
# endif /* QAT_BORINGSSL */
# endif
# if defined(QAT_SW) || defined(QAT_HW)
qat_free_EC_methods();
qat_free_RSA_methods();
# ifndef QAT_BORINGSSL
qat_free_digest_meth();
qat_free_ciphers();
# endif /* QAT_BORINGSSL */
# endif
# ifdef ENABLE_QAT_SW_GCM
vaesgcm_free_ipsec_mb_mgr();
# endif
qat_hw_ecx_offload = 0;
qat_ecx_coexist = 0;
qat_hw_prf_offload = 0;
qat_hw_hkdf_offload = 0;
qat_sw_ecx_offload = 0;
qat_sw_sm2_offload = 0;
qat_hw_sm2_offload = 0;
qat_sw_sm3_offload = 0;
qat_sw_sm4_cbc_offload = 0;
qat_sw_sm4_gcm_offload = 0;
qat_sw_sm4_ccm_offload = 0;
qat_hw_sm3_offload = 0;
QAT_DEBUG_LOG_CLOSE();
ERR_unload_QAT_strings();
return 1;
}
#endif
#if defined(QAT_SW) || defined(QAT_SW_IPSEC)
int qat_sw_cpu_support(void)
{
unsigned int info[4] = {0, 0, 0, 0};
unsigned int *ebx, *ecx, *edx;
ebx = &info[1];
ecx = &info[2];
edx = &info[3];
/* Is this an Intel CPU? */
__cpuid(info, 0x00, 0);
if (*ebx != Genu || *ecx != ntel || *edx != ineI)
return 0;
__cpuid(info, 0x07, 0);
unsigned int avx512f = 0;
unsigned int avx2 = 0;
unsigned int vaes = 0;
unsigned int vpclmulqdq = 0;
if (*ebx & (0x1 << AVX512F_BIT))
avx512f = 1;
if (*ecx & (0x1 << VAES_BIT))
vaes = 1;
if (*ecx & (0x1 << VPCLMULQDQ_BIT))
vpclmulqdq = 1;
if (*ebx & (0x1 << AVX2_BIT))
avx2 = 1;
if ((avx512f || avx2) && vaes && vpclmulqdq) {
DEBUG("QAT_SW - Processor supported: AVX512F = %u, AVX2 = %u, VAES = %u, VPCLMULQDQ = %u\n",
avx512f, avx2, vaes, vpclmulqdq);
return 1;
} else {
fprintf(stderr, "\nQAT_SW - Processor unsupported: AVX512F = %u, AVX2 = %u, VAES = %u, VPCLMULQDQ = %u\n",
avx512f, avx2, vaes, vpclmulqdq);
return 0;
}
}
#endif
int qat_pthread_mutex_lock(void)
{
int ret = 0;
ret = pthread_mutex_lock(&qat_engine_mutex);
if (ret != 0) {
WARN("pthread mutex lock failure\n");
}
return ret;
}
int qat_pthread_mutex_unlock(void)
{
int ret = 0;
ret = pthread_mutex_unlock(&qat_engine_mutex);
if (ret != 0) {
WARN("pthread mutex unlock failure\n");
}
return ret;
}
int qat_engine_init(ENGINE *e)
{
qat_pthread_mutex_lock();
if (engine_inited) {
qat_pthread_mutex_unlock();
return 1;
}
CRYPTO_INIT_QAT_LOG();
DEBUG("QAT Engine initialization:\n");
#ifdef QAT_HW
if (qat_hw_offload) {
if (!qat_hw_init(e)) {
# ifdef ENABLE_QAT_FIPS
fprintf(stderr, "QAT_HW initialization Failed\n");
qat_pthread_mutex_unlock();
return 0;
# else
# ifdef QAT_SW /* Co-Existence mode: Don't return failure when QAT HW initialization Failed. */
fallback_to_qat_sw = 1;
WARN("QAT HW initialization Failed, switching to QAT SW.\n");
# else
fprintf(stderr, "QAT HW initialization Failed.\n");
qat_pthread_mutex_unlock();
return 0;
# endif
# endif
}
}
#endif
#ifdef QAT_SW
if (qat_sw_offload) {
if (!qat_sw_init(e)) {
# ifdef ENABLE_QAT_FIPS
fprintf(stderr, "QAT_SW initialization Failed\n");
qat_pthread_mutex_unlock();
return 0;
# else
WARN("QAT SW initialization Failed, switching to OpenSSL.\n");
fallback_to_openssl = 1;
# endif
}
}
#endif
engine_inited = 1;
qat_pthread_mutex_unlock();
return 1;
}
int qat_engine_finish_int(ENGINE *e, int reset_globals)
{
int ret = 1;
DEBUG("---- QAT Engine Finishing...\n\n");
DEBUG("RSA Priv retries: %d, HW requests: %lld, SW requests: %lld\n",
num_rsa_priv_retry, num_rsa_hw_priv_reqs, num_rsa_sw_priv_reqs);
DEBUG("RSA Pub retries: %d, HW requests: %lld, SW requests: %lld\n",
num_rsa_pub_retry, num_rsa_hw_pub_reqs, num_rsa_sw_pub_reqs);
DEBUG("ECDH keygen retries: %d, HW requests: %lld, SW requests: %lld\n",
num_ecdh_keygen_retry, num_ecdh_hw_keygen_reqs,
num_ecdh_sw_keygen_reqs);
DEBUG("ECDH derive retries: %d, HW requests: %lld, SW requests: %lld\n",
num_ecdh_derive_retry, num_ecdh_hw_derive_reqs,
num_ecdh_sw_derive_reqs);
DEBUG("ECX keygen retries: %d, HW requests: %lld, SW requests: %lld\n",
num_ecx_keygen_retry, num_ecx_hw_keygen_reqs, num_ecx_sw_keygen_reqs);
DEBUG("ECX derive retries: %d, HW requests: %lld, SW requests: %lld\n",
num_ecx_derive_retry, num_ecx_hw_derive_reqs, num_ecx_sw_derive_reqs);
DEBUG("ECDSA sign retries: %d, HW requests: %lld, SW requests: %lld\n",
num_ecdsa_sign_retry, num_ecdsa_hw_sign_reqs, num_ecdsa_sw_sign_reqs);
DEBUG("SM4-CBC retries: %d, HW requests: %lld, SW requests: %lld\n",
num_sm4_cbc_cipher_retry, num_sm4_cbc_hw_cipher_reqs,
num_sm4_cbc_sw_cipher_reqs);
qat_pthread_mutex_lock();
#ifdef QAT_HW
if (qat_hw_offload)
ret = qat_hw_finish_int(e, reset_globals);
#endif
#ifdef QAT_SW
if (qat_sw_offload)
ret = qat_sw_finish_int(e, reset_globals);
#endif
engine_inited = 0;
if (reset_globals == QAT_RESET_GLOBALS) {
enable_external_polling = 0;
enable_heuristic_polling = 0;
qat_hw_offload = 0;
qat_sw_offload = 0;
fallback_to_openssl = 0;
#if defined(QAT_OPENSSL_3) && !defined(QAT_OPENSSL_PROVIDER)
qat_openssl3_prf_fallback = 0;
qat_openssl3_hkdf_fallback = 0;
qat_openssl3_sm2_fallback = 0;
qat_openssl3_sm3_fallback = 0;
qat_openssl3_sha_fallback = 0;
#endif
fallback_to_qat_sw = 0;
}
qat_pthread_mutex_unlock();
CRYPTO_CLOSE_QAT_LOG();
return ret;
}
/******************************************************************************
* * function:
* qat_engine_finish(ENGINE *e)
*
* @param e [IN] - OpenSSL engine pointer
*
* description:
* Qat engine finish function with standard signature.
* This is a wrapper for qat_engine_finish_int that always resets all the
* global variables used to store the engine configuration.
******************************************************************************/
int qat_engine_finish(ENGINE *e)
{
return qat_engine_finish_int(e, QAT_RESET_GLOBALS);
}
/******************************************************************************
* function:
* qat_engine_ctrl(ENGINE *e, int cmd, long i,
* void *p, void (*f)(void))
*
* @param e [IN] - OpenSSL engine pointer
* @param cmd [IN] - Control Command
* @param i [IN] - Unused
* @param p [IN] - Parameters for the command
* @param f [IN] - Callback function
*
* description:
* Qat engine control functions.
* Note: QAT_CMD_ENABLE_EXTERNAL_POLLING should be called at the following
* point during startup:
* ENGINE_load_qat
* ENGINE_by_id
* ---> ENGINE_ctrl_cmd(QAT_CMD_ENABLE_EXTERNAL_POLLING)
* ENGINE_init
******************************************************************************/
#ifndef QAT_OPENSSL_PROVIDER
int qat_engine_ctrl(ENGINE *e, int cmd, long i, void *p, void (*f) (void))
{
unsigned int retVal = 1;
char *temp = NULL;
uint64_t val = 0;
#ifdef QAT_HW
# ifndef __FreeBSD__
CpaStatus status = CPA_STATUS_SUCCESS;
int flags = 0;
int fd = 0;
int fcntl_ret = -1;
# endif
#endif
switch (cmd) {
case QAT_CMD_POLL:
BREAK_IF(!engine_inited, "POLL failed as engine is not initialized\n");
BREAK_IF(!enable_external_polling, "POLL failed as external polling is not enabled\n");
BREAK_IF(p == NULL, "POLL failed as the input parameter was NULL\n");
#ifdef QAT_HW
if (qat_hw_offload && !fallback_to_qat_sw) {
BREAK_IF(qat_instance_handles == NULL, "POLL failed as no instances are available\n");
*(int *)p = (int)poll_instances();
}
#endif
#ifdef QAT_SW
if (qat_sw_offload)
*(int *)p = qat_sw_poll();
#endif
break;
case QAT_CMD_ENABLE_EXTERNAL_POLLING:
BREAK_IF(engine_inited, \
"ENABLE_EXTERNAL_POLLING failed as the engine is already initialized\n");
DEBUG("Enabled external polling\n");
enable_external_polling = 1;
#ifdef QAT_HW
enable_inline_polling = 0;
#endif
break;
#ifdef QAT_HW
case QAT_CMD_ENABLE_INLINE_POLLING:
BREAK_IF(engine_inited, \
"ENABLE_INLINE_POLLING failed as the engine is already initialized\n");
DEBUG("Enabled inline polling\n");
enable_inline_polling = 1;
enable_external_polling = 0;
break;
# ifndef __FreeBSD__
case QAT_CMD_GET_EXTERNAL_POLLING_FD:
BREAK_IF(!enable_event_driven_polling || !enable_external_polling, \
"GET_EXTERNAL_POLLING_FD failed as this engine message is only supported \
when running in Event Driven Mode with External Polling enabled\n");
BREAK_IF(!engine_inited, \
"GET_EXTERNAL_POLLING_FD failed as the engine is not initialized\n");
BREAK_IF(qat_instance_handles == NULL, \
"GET_EXTERNAL_POLLING_FD failed as no instances are available\n");
BREAK_IF(p == NULL, "GET_EXTERNAL_POLLING_FD failed as the input parameter was NULL\n");
BREAK_IF(i >= qat_num_instances, \
"GET_EXTERNAL_POLLING_FD failed as the instance does not exist\n");
/* Get the file descriptor for the instance */
status = icp_sal_CyGetFileDescriptor(qat_instance_handles[i], &fd);
BREAK_IF(CPA_STATUS_FAIL == status, \
"GET_EXTERNAL_POLLING_FD failed as there was an error retrieving the fd\n");
/* Make the file descriptor non-blocking */
flags = qat_fcntl(fd, F_GETFL, 0);
fcntl_ret = qat_fcntl(fd, F_SETFL, flags | O_NONBLOCK);
BREAK_IF(fcntl_ret == -1, \
"GET_EXTERNAL_POLLING_FD failed as there was an error in setting the fd as NONBLOCKING\n");
DEBUG("External polling FD for instance[%ld] = %d\n", i, fd);
*(int *)p = fd;
break;
case QAT_CMD_ENABLE_EVENT_DRIVEN_POLLING_MODE:
DEBUG("Enabled event driven polling mode\n");
BREAK_IF(engine_inited, \
"ENABLE_EVENT_DRIVEN_POLLING_MODE failed as the engine is already initialized\n");
enable_event_driven_polling = 1;
break;
case QAT_CMD_DISABLE_EVENT_DRIVEN_POLLING_MODE:
DEBUG("Disabled event driven polling mode\n");
BREAK_IF(engine_inited, \
"DISABLE_EVENT_DRIVEN_POLLING_MODE failed as the engine is already initialized\n");
enable_event_driven_polling = 0;
break;
# endif
/* qatPerformOpRetries and qat_pkt_threshold_table_set_threshold undefined */
#ifndef QAT_BORINGSSL
case QAT_CMD_SET_INSTANCE_FOR_THREAD:
BREAK_IF(!engine_inited, \
"SET_INSTANCE_FOR_THREAD failed as the engine is not initialized\n");
BREAK_IF(qat_instance_handles == NULL, \
"SET_INSTANCE_FOR_THREAD failed as no instances are available\n");
DEBUG("Set instance for thread = %ld\n", i);
retVal = qat_set_instance_for_thread(i);
break;
case QAT_CMD_GET_NUM_OP_RETRIES:
BREAK_IF(p == NULL, "GET_NUM_OP_RETRIES failed as the input parameter was NULL\n");
BREAK_IF(!engine_inited, "GET_NUM_OP_RETRIES failed as the engine is not initialized\n");
*(int *)p = qatPerformOpRetries;
break;
case QAT_CMD_SET_MAX_RETRY_COUNT:
BREAK_IF(i < -1 || i > 100000,
"The Message retry count value is out of range, using default value\n");
DEBUG("Set max retry counter = %ld\n", i);
qat_max_retry_count = (int)i;
break;
#endif
case QAT_CMD_SET_INTERNAL_POLL_INTERVAL:
BREAK_IF(i < 1 || i > 1000000,
"The polling interval value is out of range, using default value\n");
DEBUG("Set internal poll interval = %ld ns\n", i);
qat_poll_interval = (useconds_t) i;
break;
#ifndef QAT_BORINGSSL
case QAT_CMD_SET_EPOLL_TIMEOUT:
BREAK_IF(i < 1 || i > 10000,
"The epoll timeout value is out of range, using default value\n")
DEBUG("Set epoll_wait timeout = %ld ms\n", i);
qat_epoll_timeout = (int) i;
break;
case QAT_CMD_GET_NUM_CRYPTO_INSTANCES:
BREAK_IF(p == NULL, \
"GET_NUM_CRYPTO_INSTANCES failed as the input parameter was NULL\n");
BREAK_IF(!engine_inited, \
"GET_NUM_CRYPTO_INSTANCES failed as the engine is not initialized\n");
BREAK_IF(qat_instance_handles == NULL, \
"GET_NUM_CRYPTO_INSTANCES failed as no instances are available\n");
DEBUG("Get number of crypto instances = %d\n", qat_num_instances);
*(int *)p = qat_num_instances;
break;
#endif /* QAT_BORINGSSL */
#endif
#ifndef QAT_BORINGSSL
case QAT_CMD_SET_CRYPTO_SMALL_PACKET_OFFLOAD_THRESHOLD:
# ifndef ENABLE_QAT_SMALL_PKT_OFFLOAD
if (p != NULL) {
char *token;
char str_p[QAT_MAX_INPUT_STRING_LENGTH];
char *itr = str_p;
strncpy(str_p, (const char *)p, QAT_MAX_INPUT_STRING_LENGTH - 1);
str_p[QAT_MAX_INPUT_STRING_LENGTH - 1] = '\0';
while ((token = strsep(&itr, ","))) {
char *name_token = strsep(&token,":");
char *value_token = strsep(&token,":");
if (name_token && value_token) {
retVal = qat_pkt_threshold_table_set_threshold(
name_token, atoi(value_token));
} else {
WARN("Invalid name_token or value_token\n");
retVal = 0;
}
}
} else {
WARN("Invalid p parameter\n");
retVal = 0;
}
# else
WARN("QAT_CMD_SET_CRYPTO_SMALL_PACKET_OFFLOAD_THRESHOLD is not supported\n");
retVal = 0;
# endif
break;
#endif /* QAT_BORINGSSL */
case QAT_CMD_ENABLE_HEURISTIC_POLLING:
BREAK_IF(engine_inited,
"ENABLE_HEURISTIC_POLLING failed as the engine is already initialized\n");
BREAK_IF(!enable_external_polling,
"ENABLE_HEURISTIC_POLLING failed as external polling is not enabled\n");
DEBUG("Enabled heuristic polling\n");
enable_heuristic_polling = 1;
break;
case QAT_CMD_GET_NUM_REQUESTS_IN_FLIGHT:
BREAK_IF(p == NULL,
"GET_NUM_REQUESTS_IN_FLIGHT failed as the input parameter was NULL\n");
if (i == GET_NUM_ASYM_REQUESTS_IN_FLIGHT) {
*(int **)p = &num_asym_requests_in_flight;
} else if (i == GET_NUM_KDF_REQUESTS_IN_FLIGHT) {
*(int **)p = &num_kdf_requests_in_flight;
} else if (i == GET_NUM_CIPHER_PIPELINE_REQUESTS_IN_FLIGHT) {
*(int **)p = &num_cipher_pipeline_requests_in_flight;
} else if (i == GET_NUM_ASYM_MB_ITEMS_IN_QUEUE) {
*(int **)p = &num_asym_mb_items_in_queue;
} else if (i == GET_NUM_KDF_MB_ITEMS_IN_QUEUE) {
*(int **)p = &num_kdf_mb_items_in_queue;
} else if (i == GET_NUM_SYM_MB_ITEMS_IN_QUEUE) {
*(int **)p = &num_cipher_mb_items_in_queue;
} else {
WARN("Invalid i parameter\n");
retVal = 0;
}
break;
case QAT_CMD_INIT_ENGINE:
DEBUG("Init engine\n");
if ((retVal = qat_engine_init(e)) == 0) {
WARN("Failure initializing engine\n");
}
break;
#ifdef QAT_HW
case QAT_CMD_SET_CONFIGURATION_SECTION_NAME:
BREAK_IF(engine_inited, \
"QAT_CMD_SET_CONFIGURATION_SECTION_NAME failed as the engine is already initialized\n");
if (p) {
retVal = validate_configuration_section_name(p);
if (retVal) {
strncpy(qat_config_section_name, p, QAT_CONFIG_SECTION_NAME_SIZE - 1);
qat_config_section_name[QAT_CONFIG_SECTION_NAME_SIZE - 1] = '\0';
} else {
WARN("Section name is NULL or invalid length\n");
retVal = 0;
}
} else {
WARN("Invalid p parameter\n");
retVal = 0;
}
break;
case QAT_CMD_ENABLE_SW_FALLBACK:
DEBUG("Enabled SW Fallback\n");
BREAK_IF(engine_inited, \
"ENABLE_SW_FALLBACK failed as the engine is already initialized\n");
enable_sw_fallback = 1;
CRYPTO_QAT_LOG("SW Fallback enabled - %s\n", __func__);
break;
case QAT_CMD_HEARTBEAT_POLL:
BREAK_IF(!engine_inited, "HEARTBEAT_POLL failed as engine is not initialized\n");
BREAK_IF(!enable_external_polling,
"HEARTBEAT_POLL failed as external polling is not enabled\n");
BREAK_IF(p == NULL, "HEARTBEAT_POLL failed as the input parameter was NULL\n");
if (qat_instance_handles != NULL) {
*(int *)p = (int)poll_heartbeat();