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
|
/* ====================================================================
*
*
* BSD LICENSE
*
* Copyright(c) 2016-2025 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.h
*
* This file provides and interface for an OpenSSL QAT engine implementation
*
*****************************************************************************/
#ifndef E_QAT_H
# define E_QAT_H
# ifndef QAT_OPENSSL_PROVIDER
# include <openssl/engine.h>
# endif
# include <openssl/ec.h>
# include <openssl/err.h>
# include <sys/types.h>
# include <unistd.h>
# include <string.h>
# include <semaphore.h>
# include <sched.h>
# include <stdatomic.h>
# ifdef QAT_BORINGSSL
# include "qat_bssl.h"
# include "qat_bssl_err.h"
# else
# include "qat_err.h"
# include <openssl/async.h>
#endif /* QAT_BORINGSSL */
# ifdef QAT_HW
# include "cpa.h"
# include "cpa_types.h"
# include "cpa_cy_common.h"
# include "qat_hw_usdm_inf.h"
# endif
# ifdef QAT_SW
# include "qat_sw_queue.h"
# include "qat_sw_freelist.h"
# endif
#include "qat_common.h"
# ifndef ERR_R_RETRY
# define ERR_R_RETRY 57
# endif
# define likely(x) __builtin_expect (!!(x), 1)
# define unlikely(x) __builtin_expect (!!(x), 0)
# define XSTR(x) #x
# define STR(x) XSTR(x)
/* Macro used to handle errors in qat_engine_ctrl() */
# define BREAK_IF(cond, mesg) \
if (unlikely(cond)) { retVal = 0; WARN(mesg); break; }
/*
* Max Length (bytes) of error string in human readable format
*/
# define QAT_MAX_ERROR_STRING 256
/*
* Different values passed in as param 3 for the message
* QAT_CMD_GET_NUM_REQUESTS_IN_FLIGHT to retrieve the number of different kinds
* of in-flight requests and number of items in queue for Multi-buffer
*/
# define GET_NUM_ASYM_REQUESTS_IN_FLIGHT 1
# define GET_NUM_KDF_REQUESTS_IN_FLIGHT 2
# define GET_NUM_CIPHER_PIPELINE_REQUESTS_IN_FLIGHT 3
# define GET_NUM_ASYM_MB_ITEMS_IN_QUEUE 4
# define GET_NUM_KDF_MB_ITEMS_IN_QUEUE 5
# define GET_NUM_SYM_MB_ITEMS_IN_QUEUE 6
/* Behavior of qat_engine_finish_int */
# define QAT_RETAIN_GLOBALS 0
# define QAT_RESET_GLOBALS 1
# define QAT_ATOMIC_INC(qat_int) \
(__sync_add_and_fetch(&(qat_int), 1))
# define QAT_ATOMIC_DEC(qat_int) \
(__sync_sub_and_fetch(&(qat_int), 1))
extern clock_t clock_id;
# ifdef QAT_HW
typedef struct {
int qatAsymInstanceNumForThread;
int qatSymInstanceNumForThread;
#ifdef ENABLE_QAT_HW_KPT
/* WPK index used in KPT scenario. */
int kpt_wpk_in_use;
#endif
unsigned int localOpsInFlight;
} thread_local_variables_t;
typedef struct {
CpaInstanceInfo2 qat_instance_info;
unsigned int qat_instance_started;
} qat_instance_details_t;
typedef struct {
unsigned int qat_accel_present;
unsigned int qat_accel_reset_status;
} qat_accel_details_t;
# define INSTANCE_TYPE_CRYPTO 1
# define QAT_INSTANCE_ASYM 8
# define QAT_INSTANCE_SYM 16
# define QAT_INSTANCE_ANY -1
# define QAT_INSTANCE_CONTIGUOUS 0
# define QAT_INSTANCE_SVM 1
# define QAT_RETRY_BACKOFF_MODULO_DIVISOR 8
# define QAT_INFINITE_MAX_NUM_RETRIES -1
# define QAT_INVALID_INSTANCE -1
# define QAT_INC_IN_FLIGHT_REQS(qat_int, tlv) \
do { \
if (qat_use_signals()) { \
QAT_ATOMIC_INC(qat_int); \
tlv->localOpsInFlight++; \
} \
} while(0)
# define QAT_DEC_IN_FLIGHT_REQS(qat_int, tlv) \
do { \
if (qat_use_signals()) { \
tlv->localOpsInFlight--; \
QAT_ATOMIC_DEC(qat_int); \
} \
} while(0)
# define QAT_MEM_FREE_BUFF(b, svm) \
do { \
if (b != NULL) { \
if (!svm) \
qaeCryptoMemFree(b); \
else \
OPENSSL_free(b); \
b = NULL; \
} \
} while(0)
# define QAT_CLEANSE_FREE_BUFF(b,len) \
do { \
if (b != NULL) { \
OPENSSL_cleanse(b, len); \
OPENSSL_free(b); \
b = NULL; \
} \
} while(0)
# define QAT_MEM_FREE_NONZERO_BUFF(b, svm) \
do { \
if (b != NULL) { \
if (!svm) \
qaeCryptoMemFreeNonZero(b); \
else \
OPENSSL_free(b); \
b = NULL; \
} \
} while(0)
# define QAT_CLEANSE_FLATBUFF(b) \
OPENSSL_cleanse((b).pData, (b).dataLenInBytes)
# define QAT_MEM_FREE_FLATBUFF(b, svm) \
do { \
if ((b).pData != NULL) { \
if (!svm) \
qaeCryptoMemFree((b).pData); \
else \
OPENSSL_free((b).pData); \
(b).pData = NULL; \
} \
} while(0)
# define QAT_CLEANSE_MEMFREE_FLATBUFF(b, svm) \
do { \
if ((b).pData != NULL) { \
QAT_CLEANSE_FLATBUFF(b); \
QAT_MEM_FREE_FLATBUFF(b, svm); \
} \
} while(0)
# define QAT_MEM_FREE_NONZERO_FLATBUFF(b, svm) \
do { \
if ((b).pData != NULL) { \
if (!svm) \
qaeCryptoMemFreeNonZero((b).pData); \
else \
OPENSSL_free((b).pData); \
(b).pData = NULL; \
} \
} while(0)
# define QAT_CLEANSE_MEMFREE_NONZERO_FLATBUFF(b, svm) \
do { \
if ((b).pData != NULL) { \
QAT_CLEANSE_FLATBUFF(b); \
QAT_MEM_FREE_NONZERO_FLATBUFF(b, svm); \
} \
} while(0)
# define FLATBUFF_ALLOC_AND_CHAIN(b1, b2, len) \
do { \
(b1).pData = qaeCryptoMemAlloc(len, __FILE__, __LINE__); \
(b2).pData = (b1).pData; \
(b1).dataLenInBytes = len; \
(b2).dataLenInBytes = len; \
} while(0)
#define FLATBUFF_ALLOC_AND_CHAIN_SVM(b1, b2, len) \
do { \
(b1).pData = OPENSSL_zalloc(len); \
(b2).pData = (b1).pData; \
(b1).dataLenInBytes = len; \
(b2).dataLenInBytes = len; \
} while(0)
# define QAT_CONFIG_SECTION_NAME_SIZE 64
/*
* Crypto instances value is set to 2048 to accommodate
* up to 32 QAT devices, each with a maximum of 64 instances
*/
# define QAT_MAX_CRYPTO_INSTANCES 2048
# define QAT_MAX_CRYPTO_ACCELERATORS 512
/*
* The default interval in nanoseconds used for the internal polling thread
*/
# define QAT_POLL_PERIOD_IN_NS 10000
/*
* The number of retries of the nanosleep if it gets interrupted during
* waiting between polling.
*/
# define QAT_CRYPTO_NUM_POLLING_RETRIES 5
/*
* The number of retries of the sigtimedwait if it gets interrupted during
* waiting for a signal.
*/
# define QAT_CRYPTO_NUM_EVENT_RETRIES 2
/*
* The number of seconds to wait for a response back after submitting a
* request before raising an error.
*/
# define QAT_CRYPTO_RESPONSE_TIMEOUT 5
/*
* The default timeout in milliseconds used for epoll_wait when event driven
* polling mode is enabled.
*/
# define QAT_EPOLL_TIMEOUT_IN_MS 1000
/*
* The default timeout in seconds used when waiting for events that requests
* are in-flight.
*/
# define QAT_EVENT_TIMEOUT_IN_SEC 1
#endif
#ifdef QAT_SW
/*
* Used to size the freelist and queue as it represents how many
* requests can be in-flight at once.
*/
# ifndef MULTIBUFF_MAX_INFLIGHTS
# define MULTIBUFF_MAX_INFLIGHTS 128
# endif
/*
* The maximum amount of iterations we will continue to submit
* batches of requests for. This is to prevent getting stuck in
* a continuous loop in the situation where requests are getting
* submitted faster than they are getting processed.
*/
# define MULTIBUFF_MAX_SUBMISSIONS 4
/*
* Additional define just for the prototype to force batching
* of requests less than MULTIBUFF_BATCH.
*/
# ifndef MULTIBUFF_MIN_BATCH
# define MULTIBUFF_MIN_BATCH 8
# endif
/*
* Number of multi-buffer requests to wait until are queued before
* attempting to process them.
*/
# ifndef MULTIBUFF_MAX_BATCH
# define MULTIBUFF_MAX_BATCH 8
# endif
/*
* Number of multi-buffer requests to submit to the crypto_mb library
* for processing in one go.
*/
# define MULTIBUFF_BATCH 8
/*
* SM3 can handle processing up to 16 requests while others can handle
* up to 8 requests only */
# ifndef MULTIBUFF_SM3_BATCH
# define MULTIBUFF_SM3_BATCH 16
# endif
# ifndef MULTIBUFF_SM3_MIN_BATCH
# define MULTIBUFF_SM3_MIN_BATCH 16
# endif
# ifndef MULTIBUFF_SM3_MAX_BATCH
# define MULTIBUFF_SM3_MAX_BATCH 16
# endif
/*
* SM4 can handle processing up to 16 requests while others can handle
* up to 8 requests only
*/
# ifndef MULTIBUFF_SM4_BATCH
# define MULTIBUFF_SM4_BATCH 16
# endif
# ifndef MULTIBUFF_SM4_MIN_BATCH
# define MULTIBUFF_SM4_MIN_BATCH 16
# endif
# ifndef MULTIBUFF_SM4_MAX_BATCH
# define MULTIBUFF_SM4_MAX_BATCH 16
# endif
/*
* Max number of multi-buffer Polling threads
*/
# define NUM_POLL_THREADS 128
/* Macro that does queue cleanup based on the algorithm
* request in (x) */
# define QAT_SW_CLEANUP(x, opdata, ptr) \
opdata *req_##x = NULL; \
mb_queue_##x##_disable(ptr); \
if (ptr) { \
while ((req_##x = \
mb_queue_##x##_dequeue(ptr)) != NULL) { \
*req_##x->sts = -1; \
qat_wake_job(req_##x->job, 0); \
OPENSSL_free(req_##x); \
} \
mb_queue_##x##_cleanup(ptr); \
}
#endif
/* Qat engine id declaration */
extern const char *engine_qat_id;
extern const char *engine_qat_name;
extern unsigned int engine_inited;
extern int fallback_to_openssl;
#if defined(QAT_OPENSSL_3) && !defined(QAT_OPENSSL_PROVIDER)
extern int qat_openssl3_prf_fallback;
extern int qat_openssl3_hkdf_fallback;
extern int qat_openssl3_sha_fallback;
#endif
extern int qat_openssl3_sm3_fallback;
extern int qat_openssl3_sm2_fallback;
extern int fallback_to_qat_sw; /* QAT HW initialization fail, offload to QAT SW. */
extern int qat_hw_offload;
extern int qat_sw_offload;
extern int qat_hw_rsa_offload;
extern int qat_hw_ecx_offload;
extern int qat_hw_ecdh_offload;
extern int qat_hw_ecdsa_offload;
extern int qat_hw_prf_offload;
extern int qat_hw_hkdf_offload;
extern int qat_hw_gcm_offload;
extern int qat_hw_chacha_poly_offload;
extern int qat_hw_aes_cbc_hmac_sha_offload;
extern int qat_hw_sm4_cbc_offload;
extern int qat_sw_rsa_offload;
extern int qat_sw_ecx_offload;
extern int qat_sw_ecdh_offload;
extern int qat_sw_ecdsa_offload;
extern int qat_sw_gcm_offload;
extern int qat_sw_sm2_offload;
extern int qat_hw_sm2_offload;
extern int qat_hw_sha_offload;
extern int qat_hw_sm3_offload;
# ifdef ENABLE_QAT_FIPS
extern int qat_sw_sha_offload;
# endif
# ifdef QAT_OPENSSL_PROVIDER
extern int qat_hw_dsa_offload;
extern int qat_hw_dh_offload;
extern int qat_hw_ecx_448_offload;
# endif
extern int qat_sw_sm3_offload;
extern int qat_sw_sm4_cbc_offload;
extern int qat_sw_sm4_gcm_offload;
extern int qat_sw_sm4_ccm_offload;
extern int qat_hw_aes_ccm_offload;
extern int qat_hw_keep_polling;
extern int qat_sw_keep_polling;
extern int enable_external_polling;
extern int enable_heuristic_polling;
extern pthread_mutex_t qat_engine_mutex;
extern pthread_t qat_polling_thread;
extern sem_t hw_polling_thread_sem;
extern int num_requests_in_flight;
extern int num_asym_requests_in_flight;
extern int num_kdf_requests_in_flight;
extern int num_cipher_pipeline_requests_in_flight;
extern int num_asym_mb_items_in_queue;
extern int num_kdf_mb_items_in_queue;
extern int num_cipher_mb_items_in_queue;
extern sigset_t set;
extern pthread_t qat_timer_poll_func_thread;
extern int cleared_to_start;
extern pthread_mutex_t qat_poll_mutex;
extern pthread_cond_t qat_poll_condition;
extern int qat_cond_wait_started;
#ifdef ENABLE_QAT_FIPS
extern int integrity_status;
extern int qat_fips_service_indicator;
#endif
#define ALGO_ENABLE_MASK_RSA 0x00001
#define ALGO_ENABLE_MASK_DSA 0x00002
#define ALGO_ENABLE_MASK_DH 0x00004
#define ALGO_ENABLE_MASK_ECDSA 0x00008
#define ALGO_ENABLE_MASK_ECDH 0x00010
#define ALGO_ENABLE_MASK_ECX25519 0x00020
#define ALGO_ENABLE_MASK_ECX448 0x00040
#define ALGO_ENABLE_MASK_PRF 0x00080
#define ALGO_ENABLE_MASK_HKDF 0x00100
#define ALGO_ENABLE_MASK_SM2 0x00200
#define ALGO_ENABLE_MASK_AES_GCM 0x00400
#define ALGO_ENABLE_MASK_AES_CBC_HMAC_SHA 0x00800
#define ALGO_ENABLE_MASK_SM4_CBC 0x01000
#define ALGO_ENABLE_MASK_CHACHA_POLY 0x02000
#define ALGO_ENABLE_MASK_SHA3 0x04000
#define ALGO_ENABLE_MASK_SM3 0x08000
#define ALGO_ENABLE_MASK_SM4_GCM 0x10000
#define ALGO_ENABLE_MASK_SM4_CCM 0x20000
#define ALGO_ENABLE_MASK_AES_CCM 0x40000
extern int qat_reload_algo;
extern uint64_t qat_hw_algo_enable_mask;
extern uint64_t qat_sw_algo_enable_mask;
extern int qat_rsa_coexist;
extern int qat_ecdh_coexist;
extern int qat_ecdsa_coexist;
extern int qat_ecx_coexist;
extern int qat_sm4_cbc_coexist;
extern __thread unsigned int qat_sw_rsa_priv_req;
extern __thread unsigned int qat_sw_rsa_pub_req;
extern __thread unsigned int qat_sw_ecdsa_sign_req;
extern __thread unsigned int qat_sw_ecdh_keygen_req;
extern __thread unsigned int qat_sw_ecdh_derive_req;
extern __thread unsigned int qat_sw_ecx_keygen_req;
extern __thread unsigned int qat_sw_ecx_derive_req;
extern __thread unsigned int qat_sw_sm4_cbc_cipher_req;
extern __thread int num_rsa_priv_retry;
extern __thread int num_rsa_pub_retry;
extern __thread int num_ecdsa_sign_retry;
extern __thread int num_ecdh_keygen_retry;
extern __thread int num_ecdh_derive_retry;
extern __thread int num_ecx_keygen_retry;
extern __thread int num_ecx_derive_retry;
extern __thread int num_sm4_cbc_cipher_retry;
extern __thread unsigned long long num_rsa_hw_priv_reqs;
extern __thread unsigned long long num_rsa_sw_priv_reqs;
extern __thread unsigned long long num_rsa_hw_pub_reqs;
extern __thread unsigned long long num_rsa_sw_pub_reqs;
extern __thread unsigned long long num_ecdsa_hw_sign_reqs;
extern __thread unsigned long long num_ecdsa_sw_sign_reqs;
extern __thread unsigned long long num_ecdh_hw_keygen_reqs;
extern __thread unsigned long long num_ecdh_sw_keygen_reqs;
extern __thread unsigned long long num_ecdh_hw_derive_reqs;
extern __thread unsigned long long num_ecdh_sw_derive_reqs;
extern __thread unsigned long long num_ecx_hw_keygen_reqs;
extern __thread unsigned long long num_ecx_sw_keygen_reqs;
extern __thread unsigned long long num_ecx_hw_derive_reqs;
extern __thread unsigned long long num_ecx_sw_derive_reqs;
extern __thread unsigned long long num_sm4_cbc_hw_cipher_reqs;
extern __thread unsigned long long num_sm4_cbc_sw_cipher_reqs;
#define QAT_SW_SWITCH_MB8 8
#define QAT_SW_SWITCH_MB16 16
# ifdef QAT_HW
extern char qat_config_section_name[QAT_CONFIG_SECTION_NAME_SIZE];
extern char *ICPConfigSectionName_libcrypto;
extern int enable_inline_polling;
extern int enable_event_driven_polling;
extern int enable_instance_for_thread;
extern int qatPerformOpRetries;
extern int disable_qat_offload;
extern int enable_sw_fallback;
extern CpaInstanceHandle *qat_instance_handles;
extern Cpa16U qat_num_instances;
extern Cpa16U qat_asym_num_instance;
extern Cpa16U qat_sym_num_instance;
extern Cpa16U qat_svm_num_instance;
extern Cpa16U qat_contig_num_instance;
extern Cpa32U qat_num_devices;
extern pthread_key_t thread_local_variables;
extern pthread_mutex_t qat_instance_mutex;
extern qat_instance_details_t qat_instance_details[QAT_MAX_CRYPTO_INSTANCES];
extern qat_accel_details_t qat_accel_details[QAT_MAX_CRYPTO_ACCELERATORS];
extern useconds_t qat_poll_interval;
extern int qat_epoll_timeout;
extern int qat_max_retry_count;
extern unsigned int qat_map_sym_inst[QAT_MAX_CRYPTO_INSTANCES];
extern unsigned int qat_map_asym_inst[QAT_MAX_CRYPTO_INSTANCES];
extern unsigned int qat_map_svm_inst[QAT_MAX_CRYPTO_INSTANCES];
# ifdef ENABLE_QAT_HW_KPT
# include "qat_hw_kpt.h"
# include "cpa_cy_kpt.h"
# define KPT_INVALID_WPK_IDX -1
extern int kpt_enabled;
extern int kpt_inited;
# endif
# endif
# ifdef QAT_SW
/* RSA */
extern BIGNUM *e_check;
extern mb_thread_data *mb_tlv;
extern pthread_key_t mb_thread_key;
typedef struct _mb_req_rates {
int req_this_period;
struct timespec previous_time;
struct timespec current_time;
} mb_req_rates;
extern mb_req_rates mb_rsa2k_priv_req_rates;
extern mb_req_rates mb_rsa2k_pub_req_rates;
extern mb_req_rates mb_rsa3k_priv_req_rates;
extern mb_req_rates mb_rsa3k_pub_req_rates;
extern mb_req_rates mb_rsa4k_priv_req_rates;
extern mb_req_rates mb_rsa4k_pub_req_rates;
extern mb_req_rates mb_x25519_keygen_req_rates;
extern mb_req_rates mb_x25519_derive_req_rates;
extern mb_req_rates mb_ecdsap256_sign_req_rates;
extern mb_req_rates mb_ecdsap256_sign_setup_req_rates;
extern mb_req_rates mb_ecdsap256_sign_sig_req_rates;
extern mb_req_rates mb_ecdsap256_verify_req_rates;
extern mb_req_rates mb_ecdsap384_sign_req_rates;
extern mb_req_rates mb_ecdsap384_sign_setup_req_rates;
extern mb_req_rates mb_ecdsap384_sign_sig_req_rates;
extern mb_req_rates mb_ecdsap384_verify_req_rates;
extern mb_req_rates mb_ecdhp256_keygen_req_rates;
extern mb_req_rates mb_ecdhp256_compute_req_rates;
extern mb_req_rates mb_ecdhp384_keygen_req_rates;
extern mb_req_rates mb_ecdhp384_compute_req_rates;
extern mb_req_rates mb_sm2ecdh_keygen_req_rates;
extern mb_req_rates mb_sm2ecdh_compute_req_rates;
extern mb_req_rates mb_sm3_init_req_rates;
extern mb_req_rates mb_sm3_update_req_rates;
extern mb_req_rates mb_sm3_final_req_rates;
# endif
# define QAT_CMD_ENABLE_EXTERNAL_POLLING ENGINE_CMD_BASE
# define QAT_CMD_POLL (ENGINE_CMD_BASE + 1)
# define QAT_CMD_SET_INSTANCE_FOR_THREAD (ENGINE_CMD_BASE + 2)
# define QAT_CMD_GET_NUM_OP_RETRIES (ENGINE_CMD_BASE + 3)
# define QAT_CMD_SET_MAX_RETRY_COUNT (ENGINE_CMD_BASE + 4)
# define QAT_CMD_SET_INTERNAL_POLL_INTERVAL (ENGINE_CMD_BASE + 5)
# define QAT_CMD_GET_EXTERNAL_POLLING_FD (ENGINE_CMD_BASE + 6)
# define QAT_CMD_ENABLE_EVENT_DRIVEN_POLLING_MODE (ENGINE_CMD_BASE + 7)
# define QAT_CMD_GET_NUM_CRYPTO_INSTANCES (ENGINE_CMD_BASE + 8)
# define QAT_CMD_DISABLE_EVENT_DRIVEN_POLLING_MODE (ENGINE_CMD_BASE + 9)
# define QAT_CMD_SET_EPOLL_TIMEOUT (ENGINE_CMD_BASE + 10)
# define QAT_CMD_SET_CRYPTO_SMALL_PACKET_OFFLOAD_THRESHOLD (ENGINE_CMD_BASE + 11)
# define QAT_CMD_ENABLE_INLINE_POLLING (ENGINE_CMD_BASE + 12)
# define QAT_CMD_ENABLE_HEURISTIC_POLLING (ENGINE_CMD_BASE + 13)
# define QAT_CMD_GET_NUM_REQUESTS_IN_FLIGHT (ENGINE_CMD_BASE + 14)
# define QAT_CMD_INIT_ENGINE (ENGINE_CMD_BASE + 15)
# define QAT_CMD_SET_CONFIGURATION_SECTION_NAME (ENGINE_CMD_BASE + 16)
# define QAT_CMD_ENABLE_SW_FALLBACK (ENGINE_CMD_BASE + 17)
# define QAT_CMD_HEARTBEAT_POLL (ENGINE_CMD_BASE + 18)
# define QAT_CMD_DISABLE_QAT_OFFLOAD (ENGINE_CMD_BASE + 19)
# define QAT_CMD_HW_ALGO_BITMAP (ENGINE_CMD_BASE + 20)
# define QAT_CMD_SW_ALGO_BITMAP (ENGINE_CMD_BASE + 21)
#ifndef QAT_BORINGSSL
#ifndef ENGINE_QAT_PTR_DEFINE
# define ENGINE_QAT_PTR_RESET()
# define ENGINE_QAT_PTR_SET(pt)
# define ENGINE_QAT_PTR_GET() NULL
#endif
#endif /* QAT_BORINGSSL */
# ifdef QAT_HW
extern CpaStatus icp_adf_get_numDevices(Cpa32U *);
/******************************************************************************
* function:
* qat_get_qat_offload_disabled(void)
*
* description:
* This function indicates whether offloading to the QuickAssist hardware
* has been disabled. If it has then we can still perform crypto oncore.
*
******************************************************************************/
int qat_get_qat_offload_disabled(void);
/******************************************************************************
* function:
* qat_use_signals(void)
*
* description:
* This function indicates whether pthread signals are being used for thread
* synchronisation. If so, then a non-zero value is returned, else zero is
* returned.
*
******************************************************************************/
int qat_use_signals(void);
/******************************************************************************
* function:
* qat_get_sw_fallback_enabled(void)
*
* description:
* Return the flag which indicates if QAT engine is enabled to fall back to
* software calculation.
*
******************************************************************************/
int qat_get_sw_fallback_enabled(void);
/******************************************************************************
* function:
* int validate_configuration_section_name(const char *name)
*
* description:
* This function validates whether the section name has valid length and
* address. If so, then one is returned else zero is returned.
*
******************************************************************************/
int validate_configuration_section_name(const char *name);
/******************************************************************************
* function:
* is_instance_available(int inst_num)
*
* description:
* Return whether the instance number passed in is a currently available
* instance. Returns 1 if available, 0 otherwise.
*
******************************************************************************/
int is_instance_available(int inst_num);
/******************************************************************************
* function:
* is_any_device_available(void)
*
* description:
* Return whether any devices are currently available.
* Returns 1 if at least one device is detected and up, 0 otherwise.
*
******************************************************************************/
int is_any_device_available(void);
/******************************************************************************
* function:
* get_instance(int inst_type, int mem_type)
*
* description:
* Return the next instance number to use for an operation.
*
******************************************************************************/
int get_instance(int inst_type, int mem_type);
/******************************************************************************
* function:
* qat_check_create_local_variables(void)
*
* description:
* This function checks whether local variables exist in the current thread.
* If not, then it will attempt to create them. It returns NULL if the local
* variables could not be created, otherwise it returns a pointer to the
* local variables data structure.
*
******************************************************************************/
thread_local_variables_t * qat_check_create_local_variables(void);
/*****************************************************************************
* * function:
* qat_hw_init(ENGINE *e)
*
* @param e [IN] - OpenSSL engine pointer
*
* description:
* qat_hw init function, associated with
* Crypto memory setup and cpaStartInstance setups.
******************************************************************************/
int qat_hw_init(ENGINE *e);
# endif
/*****************************************************************************
* * function:
* bind_qat(ENGINE *e, const char *id)
*
* @param e [IN] - OpenSSL engine pointer
* @param id [IN] - engine id pointer
*
* description:
* bind function for registering algorithms that are supported in qatngine
* and other qat_hw and qat_sw intializaton.
*
*****************************************************************************/
int bind_qat(ENGINE *e, const char *id);
/******************************************************************************
* function:
* qat_engine_init(ENGINE *e)
*
* @param e [IN] - OpenSSL engine pointer
*
* description:
* Qat Engine initialization
******************************************************************************/
int qat_engine_init(ENGINE *e);
/******************************************************************************
* 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
******************************************************************************/
int qat_engine_ctrl(ENGINE *e, int cmd, long i, void *p, void (*f) (void));
/******************************************************************************
* function:
* qat_hw_finish_int(ENGINE *e)
*
* @param e [IN] - OpenSSL engine pointer
*
* description:
* Qat finish function associated with qat crypto memory free
******************************************************************************/
int qat_hw_finish_int(ENGINE *e, int reset_globals);
/******************************************************************************
* function:
* qat_engine_finish(ENGINE *e)
*
* @param e [IN] - OpenSSL engine pointer
*
* description:
* Qat engine finish function.
******************************************************************************/
int qat_engine_finish(ENGINE *e);
/******************************************************************************
* function:
* qat_engine_finish_int(ENGINE *e, int reset_globals)
*
* @param e [IN] - OpenSSL engine pointer
* @param reset_globals [IN] - Whether reset the global configuration variables
*
* description:
* Internal Qat engine finish function.
* The value of reset_globals should be either QAT_RESET_GLOBALS or
* QAT_RETAIN_GLOBALS
******************************************************************************/
int qat_engine_finish_int(ENGINE *e, int reset_globals);
#ifdef ENABLE_QAT_HW_KPT
/******************************************************************************
* function:
* qat_engine_load_privkey(ENGINE *e, const char *key_id,
* UI_METHOD *ui_method, void *callback_data)
*
* @param e [IN] - OpenSSL engine pointer
* @param key_id [IN] - String of Path to WPK file
* @param ui_method [IN] - Unused
* @param callback_data [IN] - Unused
*
* description:
* Qat engine load private key function.
* This function will be hooked by openssl and used to load WPK file
* in KPT scenario.
******************************************************************************/
EVP_PKEY *qat_engine_load_privkey(ENGINE *e, const char *key_id,
UI_METHOD *ui_method, void *callback_data);
#endif
/*****************************************************************************
* function:
* int qat_pthread_mutex_lock(void)
*
* description:
* Wrapper function to pthread_mutex with return values checked.
*
******************************************************************************/
int qat_pthread_mutex_lock(void);
/*****************************************************************************
* function:
* int qat_pthread_mutex_unlock(void)
*
* description:
* Wrapper function to pthread_mutex with return values checked.
*
******************************************************************************/
int qat_pthread_mutex_unlock(void);
# ifdef QAT_SW
/*****************************************************************************
* * function:
* qat_sw_init(ENGINE *e)
*
* @param e [IN] - OpenSSL engine pointer
*
* description:
* QAT_SW init function, associated with memory setup.
******************************************************************************/
int qat_sw_init(ENGINE *e);
/******************************************************************************
* function:
* qat_sw_finish_int(ENGINE *e, int reset_globals)
*
* @param e [IN] - OpenSSL engine pointer
* @param reset_globals [IN] - Whether reset the global configuration variables
*
* description:
* Internal QAT_SW finish function.
* The value of reset_globals should be either QAT_RESET_GLOBALS or
* QAT_RETAIN_GLOBALS
******************************************************************************/
int qat_sw_finish_int(ENGINE *e, int reset_globals);
/******************************************************************************
* function:
* mb_check_thread_local(void)
*
* description:
* Check if the thread has thread local pointer created using the key
* if not thread local memory polling thread will be created and stored on the
* Heap.
******************************************************************************/
mb_thread_data *mb_check_thread_local(void);
# endif
/******************************************************************************
* function:
* qat_sw_cpu_support(void)
*
* description:
* Checks if we are running on Intel CPU and has the instruction set needed
* for crypto_mb and ipsec_mb (QAT_SW) offload.
******************************************************************************/
# if defined(QAT_SW) || defined(QAT_SW_IPSEC)
int qat_sw_cpu_support(void);
# endif
# ifdef QAT_OPENSSL_PROVIDER
static inline int QAT_CRYPTO_NEW_REF(QAT_CRYPTO_REF_COUNT *refcnt, int n)
{
refcnt->val = n;
return 1;
}
static inline int QAT_CRYPTO_GET_REF(QAT_CRYPTO_REF_COUNT *refcnt, int *ret)
{
*ret = atomic_load_explicit(&refcnt->val, memory_order_acquire);
return 1;
}
static inline int QAT_CRYPTO_UP_REF(QAT_CRYPTO_REF_COUNT *refcnt, int *ret)
{
*ret = atomic_fetch_add_explicit(&refcnt->val, 1, memory_order_relaxed) + 1;
return 1;
}
static inline int QAT_CRYPTO_DOWN_REF(QAT_CRYPTO_REF_COUNT *refcnt, int *ret)
{
*ret = atomic_fetch_sub_explicit(&refcnt->val, 1, memory_order_release) - 1;
if (*ret == 0)
atomic_thread_fence(memory_order_acquire);
return 1;
}
# endif
#endif /* E_QAT_H */
|
