Coverage Report

Created: 2024-08-17 11:02

/src/openssl/include/openssl/async.h
Line
Count
Source (jump to first uncovered line)
1
/*
2
 * Copyright 2015-2018 The OpenSSL Project Authors. All Rights Reserved.
3
 *
4
 * Licensed under the Apache License 2.0 (the "License").  You may not use
5
 * this file except in compliance with the License.  You can obtain a copy
6
 * in the file LICENSE in the source distribution or at
7
 * https://www.openssl.org/source/license.html
8
 */
9
10
#include <stdlib.h>
11
12
#ifndef OPENSSL_ASYNC_H
13
# define OPENSSL_ASYNC_H
14
# pragma once
15
16
# include <openssl/macros.h>
17
# ifndef OPENSSL_NO_DEPRECATED_3_0
18
#  define HEADER_ASYNC_H
19
# endif
20
21
#if defined(_WIN32)
22
# if defined(BASETYPES) || defined(_WINDEF_H)
23
/* application has to include <windows.h> to use this */
24
#define OSSL_ASYNC_FD       HANDLE
25
#define OSSL_BAD_ASYNC_FD   INVALID_HANDLE_VALUE
26
# endif
27
#else
28
#define OSSL_ASYNC_FD       int
29
#define OSSL_BAD_ASYNC_FD   -1
30
#endif
31
# include <openssl/asyncerr.h>
32
33
34
# ifdef  __cplusplus
35
extern "C" {
36
# endif
37
38
typedef struct async_job_st ASYNC_JOB;
39
typedef struct async_wait_ctx_st ASYNC_WAIT_CTX;
40
typedef int (*ASYNC_callback_fn)(void *arg);
41
42
0
#define ASYNC_ERR      0
43
0
#define ASYNC_NO_JOBS  1
44
0
#define ASYNC_PAUSE    2
45
0
#define ASYNC_FINISH   3
46
47
#define ASYNC_STATUS_UNSUPPORTED    0
48
#define ASYNC_STATUS_ERR            1
49
#define ASYNC_STATUS_OK             2
50
#define ASYNC_STATUS_EAGAIN         3
51
52
int ASYNC_init_thread(size_t max_size, size_t init_size);
53
void ASYNC_cleanup_thread(void);
54
55
#ifdef OSSL_ASYNC_FD
56
ASYNC_WAIT_CTX *ASYNC_WAIT_CTX_new(void);
57
void ASYNC_WAIT_CTX_free(ASYNC_WAIT_CTX *ctx);
58
int ASYNC_WAIT_CTX_set_wait_fd(ASYNC_WAIT_CTX *ctx, const void *key,
59
                               OSSL_ASYNC_FD fd,
60
                               void *custom_data,
61
                               void (*cleanup)(ASYNC_WAIT_CTX *, const void *,
62
                                               OSSL_ASYNC_FD, void *));
63
int ASYNC_WAIT_CTX_get_fd(ASYNC_WAIT_CTX *ctx, const void *key,
64
                        OSSL_ASYNC_FD *fd, void **custom_data);
65
int ASYNC_WAIT_CTX_get_all_fds(ASYNC_WAIT_CTX *ctx, OSSL_ASYNC_FD *fd,
66
                               size_t *numfds);
67
int ASYNC_WAIT_CTX_get_callback(ASYNC_WAIT_CTX *ctx,
68
                                ASYNC_callback_fn *callback,
69
                                void **callback_arg);
70
int ASYNC_WAIT_CTX_set_callback(ASYNC_WAIT_CTX *ctx,
71
                                ASYNC_callback_fn callback,
72
                                void *callback_arg);
73
int ASYNC_WAIT_CTX_set_status(ASYNC_WAIT_CTX *ctx, int status);
74
int ASYNC_WAIT_CTX_get_status(ASYNC_WAIT_CTX *ctx);
75
int ASYNC_WAIT_CTX_get_changed_fds(ASYNC_WAIT_CTX *ctx, OSSL_ASYNC_FD *addfd,
76
                                   size_t *numaddfds, OSSL_ASYNC_FD *delfd,
77
                                   size_t *numdelfds);
78
int ASYNC_WAIT_CTX_clear_fd(ASYNC_WAIT_CTX *ctx, const void *key);
79
#endif
80
81
int ASYNC_is_capable(void);
82
83
int ASYNC_start_job(ASYNC_JOB **job, ASYNC_WAIT_CTX *ctx, int *ret,
84
                    int (*func)(void *), void *args, size_t size);
85
int ASYNC_pause_job(void);
86
87
ASYNC_JOB *ASYNC_get_current_job(void);
88
ASYNC_WAIT_CTX *ASYNC_get_wait_ctx(ASYNC_JOB *job);
89
void ASYNC_block_pause(void);
90
void ASYNC_unblock_pause(void);
91
92
93
# ifdef  __cplusplus
94
}
95
# endif
96
#endif