summaryrefslogtreecommitdiffstats
path: root/src/ccapi/server/ccs_callback.c
blob: d758acb1528ff71cea29f848302332ae9ddbca75 (plain)
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
/* ccapi/server/ccs_callback.c */
/*
 * Copyright 2006 Massachusetts Institute of Technology.
 * All Rights Reserved.
 *
 * Export of this software from the United States of America may
 * require a specific license from the United States Government.
 * It is the responsibility of any person or organization contemplating
 * export to obtain such a license before exporting.
 *
 * WITHIN THAT CONSTRAINT, permission to use, copy, modify, and
 * distribute this software and its documentation for any purpose and
 * without fee is hereby granted, provided that the above copyright
 * notice appear in all copies and that both that copyright notice and
 * this permission notice appear in supporting documentation, and that
 * the name of M.I.T. not be used in advertising or publicity pertaining
 * to distribution of the software without specific, written prior
 * permission.  Furthermore if you modify this software you must label
 * your software as modified software and not distribute it in such a
 * fashion that it might be confused with the original M.I.T. software.
 * M.I.T. makes no representations about the suitability of
 * this software for any purpose.  It is provided "as is" without express
 * or implied warranty.
 */

#include "ccs_common.h"

struct ccs_callback_d {
    cc_int32 pending;
    cc_int32 invalid_object_err;
    ccs_pipe_t client_pipe;
    ccs_pipe_t reply_pipe;
    ccs_callback_owner_t owner; /* pointer to owner */
    ccs_callback_owner_invalidate_t owner_invalidate;
};

struct ccs_callback_d ccs_callback_initializer = { 1, 1, CCS_PIPE_NULL, CCS_PIPE_NULL, NULL, NULL };

/* ------------------------------------------------------------------------ */

cc_int32 ccs_callback_new (ccs_callback_t                  *out_callback,
			   cc_int32                         in_invalid_object_err,
			   ccs_pipe_t                       in_client_pipe,
			   ccs_pipe_t                       in_reply_pipe,
			   ccs_callback_owner_t             in_owner,
			   ccs_callback_owner_invalidate_t  in_owner_invalidate_function)
{
    cc_int32 err = ccNoError;
    ccs_callback_t callback = NULL;
    ccs_client_t client = NULL;

    if (!out_callback                   ) { err = cci_check_error (ccErrBadParam); }
    if (!ccs_pipe_valid (in_client_pipe)) { err = cci_check_error (ccErrBadParam); }
    if (!ccs_pipe_valid (in_reply_pipe) ) { err = cci_check_error (ccErrBadParam); }
    if (!in_owner                       ) { err = cci_check_error (ccErrBadParam); }
    if (!in_owner_invalidate_function   ) { err = cci_check_error (ccErrBadParam); }

    if (!err) {
        callback = malloc (sizeof (*callback));
        if (callback) {
            *callback = ccs_callback_initializer;
        } else {
            err = cci_check_error (ccErrNoMem);
        }
    }

    if (!err) {
        err = ccs_server_client_for_pipe (in_client_pipe, &client);
    }

    if (!err) {
	err = ccs_pipe_copy (&callback->client_pipe, in_client_pipe);
    }

    if (!err) {
	err = ccs_pipe_copy (&callback->reply_pipe, in_reply_pipe);
    }

    if (!err) {
        callback->client_pipe = in_client_pipe;
        callback->reply_pipe = in_reply_pipe;
        callback->invalid_object_err = in_invalid_object_err;
        callback->owner = in_owner;
        callback->owner_invalidate = in_owner_invalidate_function;

        err = ccs_client_add_callback (client, callback);
    }

    if (!err) {
        *out_callback = callback;
        callback = NULL;
    }

    ccs_callback_release (callback);

    return cci_check_error (err);
}

/* ------------------------------------------------------------------------ */

cc_int32 ccs_callback_release (ccs_callback_t io_callback)
{
    cc_int32 err = ccNoError;

    if (!err && io_callback) {
	ccs_client_t client = NULL;

	if (io_callback->pending) {
	    err = ccs_server_send_reply (io_callback->reply_pipe,
					 io_callback->invalid_object_err, NULL);

	    io_callback->pending = 0;
	}

	if (!err) {
	    err = ccs_server_client_for_pipe (io_callback->client_pipe, &client);
	}

	if (!err && client) {
	    /* if client object still has a reference to us, remove it */
	    err = ccs_client_remove_callback (client, io_callback);
	}

	if (!err) {
	    ccs_pipe_release (io_callback->client_pipe);
	    ccs_pipe_release (io_callback->reply_pipe);
	    free (io_callback);
	}
    }

    return cci_check_error (err);
}

/* ------------------------------------------------------------------------ */

cc_int32 ccs_callback_invalidate (ccs_callback_t io_callback)
{
    cc_int32 err = ccNoError;

    if (!io_callback) { err = cci_check_error (ccErrBadParam); }

    if (!err) {
        io_callback->pending = 0; /* client is dead, don't try to talk to it */
	if (io_callback->owner_invalidate) {
	    err = io_callback->owner_invalidate (io_callback->owner, io_callback);
	} else {
	    cci_debug_printf ("WARNING %s() unable to notify callback owner!",
			      __FUNCTION__);
	}
    }

    return cci_check_error (err);
}

/* ------------------------------------------------------------------------ */

cc_int32 ccs_callback_reply_to_client (ccs_callback_t io_callback,
				       k5_ipc_stream   in_stream)
{
    cc_int32 err = ccNoError;

    if (!io_callback) { err = cci_check_error (ccErrBadParam); }

    if (!err) {
        if (io_callback->pending) {
	    cci_debug_printf ("%s: callback %p replying to client.", __FUNCTION__, io_callback);

            err = ccs_server_send_reply (io_callback->reply_pipe, err, in_stream);

            if (err) {
                cci_debug_printf ("WARNING %s() called on a lock belonging to a dead client!",
                                  __FUNCTION__);
            }

            io_callback->pending = 0;
        } else {
            cci_debug_printf ("WARNING %s() called on non-pending callback!",
                              __FUNCTION__);
        }
    }

    return cci_check_error (err);
}

/* ------------------------------------------------------------------------ */

cc_uint32 ccs_callback_is_pending (ccs_callback_t  in_callback,
				   cc_uint32      *out_pending)
{
    cc_int32 err = ccNoError;

    if (!in_callback) { err = cci_check_error (ccErrBadParam); }
    if (!out_pending) { err = cci_check_error (ccErrBadParam); }

    if (!err) {
        *out_pending = in_callback->pending;
    }

    return cci_check_error (err);
}

/* ------------------------------------------------------------------------ */

cc_int32 ccs_callback_is_for_client_pipe (ccs_callback_t  in_callback,
					  ccs_pipe_t      in_client_pipe,
					  cc_uint32      *out_is_for_client_pipe)
{
    cc_int32 err = ccNoError;

    if (!in_callback                    ) { err = cci_check_error (ccErrBadParam); }
    if (!ccs_pipe_valid (in_client_pipe)) { err = cci_check_error (ccErrBadParam); }
    if (!out_is_for_client_pipe         ) { err = cci_check_error (ccErrBadParam); }

    if (!err) {
        err = ccs_pipe_compare (in_callback->client_pipe, in_client_pipe,
                                out_is_for_client_pipe);
    }

    return cci_check_error (err);
}


/* ------------------------------------------------------------------------ */

cc_int32 ccs_callback_client_pipe (ccs_callback_t  in_callback,
				   ccs_pipe_t     *out_client_pipe)
{
    cc_int32 err = ccNoError;

    if (!in_callback    ) { err = cci_check_error (ccErrBadParam); }
    if (!out_client_pipe) { err = cci_check_error (ccErrBadParam); }

    if (!err) {
        *out_client_pipe = in_callback->client_pipe;
    }

    return cci_check_error (err);
}