ucx1-sys 0.1.0

Rust FFI bindings to UCX.
Documentation 
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

/**
* Copyright (C) Mellanox Technologies Ltd. 2001-2014.  ALL RIGHTS RESERVED.
*
* See file LICENSE for terms.
*/

#ifndef UCS_ASYNC_INT_H
#define UCS_ASYNC_INT_H

#include "async.h"

#include <ucs/datastruct/queue.h>
#include <ucs/time/timerq.h>


/* Async event handler */
typedef struct ucs_async_handler ucs_async_handler_t;
struct ucs_async_handler {
    int                        id;      /* Event/Timer ID */
    ucs_async_mode_t           mode;    /* Event delivery mode */
    ucs_event_set_types_t      events;  /* Bitmap of events */
    pthread_t                  caller;  /* Thread which invokes the callback */
    ucs_async_event_cb_t       cb;      /* Callback function */
    void                       *arg;    /* Callback argument */
    ucs_async_context_t        *async;  /* Async context for the handler. Can be NULL */
    volatile uint32_t          missed;  /* Protect against adding to miss queue multiple times */
    volatile uint32_t          refcount;
};


/**
 * Dispatch event coming from async context.
 *
 * @param handler_ids   Array of handler IDs to dispatch.
 * @param count         Number of events
 * @param events        Events to pass to the handler
 */
ucs_status_t ucs_async_dispatch_handlers(int *handler_ids, size_t count,
                                         ucs_event_set_types_t events);


/**
 * Dispatch timers from a timer queue.
 *
 * @param timerq        Timer queue whose timers to dispatch.
 * @param current_time  Current time for checking timer expiration.
 */
ucs_status_t ucs_async_dispatch_timerq(ucs_timer_queue_t *timerq,
                                       ucs_time_t current_time);


typedef void (*ucs_async_init_t)();

typedef void (*ucs_async_cleanup_t)();

typedef int (*ucs_async_is_from_async_t)();

typedef void (*ucs_async_block_t)();

typedef void (*ucs_async_unblock_t)();

typedef ucs_status_t (*ucs_async_context_init_t)(ucs_async_context_t *async);

typedef void (*ucs_async_context_cleanup_t)(ucs_async_context_t *async);

typedef int (*ucs_async_context_try_block_t)(ucs_async_context_t *async);

typedef void (*ucs_async_context_unblock_t)(ucs_async_context_t *async);

typedef ucs_status_t (*ucs_async_add_event_fd_t)(ucs_async_context_t *async,
                                                 int event_fd,
                                                 ucs_event_set_types_t events);

typedef ucs_status_t (*ucs_async_remove_event_fd_t)(ucs_async_context_t *async,
                                                    int event_fd);

typedef ucs_status_t (*ucs_async_modify_event_fd_t)(ucs_async_context_t *async,
                                                    int event_fd,
                                                    ucs_event_set_types_t events);

typedef ucs_status_t (*ucs_async_add_timer_t)(ucs_async_context_t *async,
                                              int timer_id,
                                              ucs_time_t interval);

typedef ucs_status_t (*ucs_async_remove_timer_t)(ucs_async_context_t *async,
                                                 int timer_id);


/**
 * Operation for specific async event delivery method.
 */
typedef struct ucs_async_ops {
    ucs_async_init_t              init;
    ucs_async_cleanup_t           cleanup;
    ucs_async_is_from_async_t     is_from_async;

    ucs_async_block_t             block;
    ucs_async_unblock_t           unblock;

    ucs_async_context_init_t      context_init;
    ucs_async_context_cleanup_t   context_cleanup;
    ucs_async_context_try_block_t context_try_block;
    ucs_async_context_unblock_t   context_unblock;

    ucs_async_add_event_fd_t      add_event_fd;
    ucs_async_remove_event_fd_t   remove_event_fd;
    ucs_async_modify_event_fd_t   modify_event_fd;

    ucs_async_add_timer_t         add_timer;
    ucs_async_remove_timer_t      remove_timer;
} ucs_async_ops_t;


extern ucs_async_ops_t ucs_async_thread_spinlock_ops;
extern ucs_async_ops_t ucs_async_thread_mutex_ops;
extern ucs_async_ops_t ucs_async_signal_ops;

#endif