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
|
#ifndef __SGE_MIRROR_H
#define __SGE_MIRROR_H
/*___INFO__MARK_BEGIN__*/
/*************************************************************************
*
* The Contents of this file are made available subject to the terms of
* the Sun Industry Standards Source License Version 1.2
*
* Sun Microsystems Inc., March, 2001
*
*
* Sun Industry Standards Source License Version 1.2
* =================================================
* The contents of this file are subject to the Sun Industry Standards
* Source License Version 1.2 (the "License"); You may not use this file
* except in compliance with the License. You may obtain a copy of the
* License at http://gridengine.sunsource.net/Gridengine_SISSL_license.html
*
* Software provided under this License is provided on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
* WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
* MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
* See the License for the specific provisions governing your rights and
* obligations concerning the Software.
*
* The Initial Developer of the Original Code is: Sun Microsystems, Inc.
*
* Copyright: 2001 by Sun Microsystems, Inc.
*
* All Rights Reserved.
*
************************************************************************/
/*___INFO__MARK_END__*/
#include "cull/cull.h"
#include "gdi/sge_gdi.h"
#include "sgeobj/sge_object.h"
#include "sgeobj/sge_event.h"
#include "evc/sge_event_client.h"
/****** Eventmirror/--Eventmirror ***************************************
*
* NAME
* Eventmirror -- mirroring of master lists through event client interface
*
* FUNCTION
* The event mirror interface provides a means to easily implement
* Grid Engine components that need to have access to the masters
* object lists and therefore have to mirror them.
*
* Such components can be schedulers, proxies, monitoring tools etc.
*
* It is designed as a layer above the event client interface.
*
* Mirroring can be restricted to certain event types / object types.
* Callback functions can be installed to perform actions additional to
* pure mirroring.
*
* BUGS
* Not yet operable on the usermapping related objects and lists.
*
* SEE ALSO
* Eventmirror/-Eventmirror-Typedefs
* Eventmirror/sge_mirror_initialize()
* Eventmirror/sge_mirror_shutdown()
* Eventmirror/sge_mirror_subscribe()
* Eventmirror/sge_mirror_unsubscribe()
* Eventmirror/sge_mirror_process_events()
* Eventmirror/sge_mirror_update_master_list()
* Eventmirror/sge_mirror_update_master_list_host_key()
* Eventmirror/sge_mirror_update_master_list_str_key()
* Eventmirror/sge_mirror_strerror()
****************************************************************************
*/
/****** Eventmirror/-Eventmirror-Typedefs ***************************************
*
* NAME
* Eventmirror -- mirroring of master lists through event client interface
*
* SYNOPSIS
* typedef enum {
* ...
* } sge_event_action;
*
* typedef enum {
* ...
* } sge_mirror_error;
*
* typedef int (*sge_mirror_callback)(sge_object_type type,
* sge_event_action action,
* lListElem *event, void *clientdata);
*
*
* FUNCTION
* The following types are defined for use with the event mirroring
* interface:
*
*
* Different event actions are defined in the enumeration sge_event_action:
* SGE_EMA_LIST - the whole master list has been sent
* (used at initialization)
* SGE_EMA_ADD - a new object has been created
* SGE_EMA_MOD - an object has been modified
* SGE_EMA_DEL - an object has been deleted
* SGE_EMA_TRIGGER - a certain action has been triggered,
* e.g. a scheduling run or a shutdown.
*
* Most functions of the event mirroring interface return error codes that
* are defined in the enumeration sge_mirror_error:
* SGE_EM_OK - action performed successfully
* SGE_EM_NOT_INITIALIZED - the interface is not yet initialized
* SGE_EM_BAD_ARG - some input parameter was incorrect
* SGE_EM_TIMEOUT - a timeout occured
* SGE_EM_DUPLICATE_KEY - an object should be added, but an object
* with the same unique identifier already
* exists.
* SGE_EM_KEY_NOT_FOUND - an object with the given key was not found.
* SGE_EM_CALLBACK_FAILED - a callback function failed
* SGE_EM_PROCESS_ERRORS - an error occured during event processing
*
* The event mirroring interface allows to install callback funktions for
* actions on certain event types. These callback functions have to have
* the same prototype as given by the function typedef sge_mirror_callback.
*
****************************************************************************
*/
typedef enum {
SGE_EMA_LIST = 1,
SGE_EMA_ADD,
SGE_EMA_MOD,
SGE_EMA_DEL,
SGE_EMA_TRIGGER
} sge_event_action;
typedef enum {
SGE_EMA_FAILURE = 0, /* the processing of events is stoped */
SGE_EMA_OK = 1, /* everything is fine */
SGE_EMA_IGNORE = 2 /* no further processing for this event is done */
} sge_callback_result;
typedef sge_callback_result (*sge_mirror_callback)(sge_evc_class_t *evc,
object_description *object_base,
sge_object_type type,
sge_event_action action,
lListElem *event,
void *clientdata);
typedef enum {
SGE_EM_OK = 0,
SGE_EM_NOT_INITIALIZED,
SGE_EM_BAD_ARG,
SGE_EM_TIMEOUT,
SGE_EM_DUPLICATE_KEY,
SGE_EM_KEY_NOT_FOUND,
SGE_EM_CALLBACK_FAILED,
SGE_EM_PROCESS_ERRORS,
SGE_EM_LAST_ERRNO
} sge_mirror_error;
/* Initialization - Shutdown */
sge_mirror_error
sge_mirror_initialize(sge_evc_class_t *evc, ev_registration_id id, const char *name,
bool use_global_data, event_client_update_func_t update_func,
evm_mod_func_t mod_func, evm_add_func_t add_func,
evm_remove_func_t remove_func, evm_ack_func_t ack_func);
sge_mirror_error sge_mirror_shutdown(sge_evc_class_t *evc);
/* Subscription */
sge_mirror_error sge_mirror_subscribe(sge_evc_class_t *evc,
sge_object_type type,
sge_mirror_callback callback_before,
sge_mirror_callback callback_after,
void *clientdata,
const lCondition *where, const lEnumeration *what);
sge_mirror_error sge_mirror_unsubscribe(sge_evc_class_t *evc,
sge_object_type type);
/* Event Processing */
sge_mirror_error
sge_mirror_process_event_list(sge_evc_class_t *evc, lList *event_list);
sge_mirror_error
sge_mirror_process_events(sge_evc_class_t *evc);
sge_mirror_error
sge_mirror_update_master_list(lList **list, const lDescr *list_descr,
lListElem *ep, const char *key,
sge_event_action action, lListElem *event);
sge_mirror_error
sge_mirror_update_master_list_host_key(lList **list, const lDescr *list_descr,
int key_nm, const char *key,
sge_event_action action,
lListElem *event);
sge_mirror_error
sge_mirror_update_master_list_str_key(lList **list, const lDescr *list_descr,
int key_nm, const char *key,
sge_event_action action,
lListElem *event);
/* Error Handling */
const char *sge_mirror_strerror(sge_mirror_error num);
#endif /* __SGE_MIRROR_H */
|
