1 karl 1.1.2.1 Using the CIM/XML Pull Operations
2
3 STATUS
4
|
5 karl 1.1.2.4 <<< The TODO section is being maintained during the review and checkin process
|
6 karl 1.1.2.1 to keep track of problems, errors, notes, etc. Must be deleted before
7 checkin to head of tree. Please feel free to add notes, etc in this
8 section as you review/test.>>>>>>
9
|
10 karl 1.1.2.4 TODO list:
|
11 karl 1.1.2.3 1. Binary operation from OOP. Need to add counter to binary
12 protocol to be able to count objects in response. Generates
13 warnings in things like messageserializer and does not work with
|
14 karl 1.1.2.14 OOP right now. Corrected by converting to XML.
|
15 karl 1.1.2.15 2. OpenExecQuery - Code is incorrect in that it does not include the
16 return from the exec query function to the aggregator yet.
|
17 karl 1.1.2.4 3. Code for Pull part of OpenQueryInstancesRequest a) should be part of
18 the common CIMOperationRequestDispatcher execCommon code.
19 4. The changes to WQLCIMOperationRequestDispatcher and CQL... for handling
20 pull not completed so we feed the responses back to the EnmerationContext
21 queues
|
22 karl 1.1.2.7 3. Lots of minor TODOs, diagnostics, etc.
|
23 karl 1.1.2.14 4. External runtime variables. Proposing that they be fixed for this release
|
24 karl 1.1.2.15 rather than set by configuration. This should be discussed. Am making
25 this a separate bug. See bug
|
26 karl 1.1.2.3 5. Decision on EnumerationContext timeout (separate thread or just
|
27 karl 1.1.2.4 checks during other operations). Can we, in fact really keep the
28 enumeration context table and queue under control without monitoring
29 with a separate thread. We must monitor for:
30 a. Client operation that stop requesting (i.e. inter operation time
31 exceeds operationTimeout). Note that if it simply exceeds the time
32 the next operation does the cleanup. The issue is those clients that
33 simply stop and do not either close or go to completion.
34 b. We should protect against providers that no not every finish delivering
35 or take to long between deliveries. This does not exist in Pegasus
36 today
|
37 karl 1.1.2.15 6. Consider moving some of the code in dispatcher from templates to common
38 functions which would mean adding intermediate classes in CIMMessage
|
39 karl 1.1.2.3 7. Extension to avoid double move of objects in CIMResponseData (one
40 into enumerationContext queue and second to new cimResponseData for
41 response. Want to avoid second move by extending Open/Pull response
42 messages to include count and CIMResponse data to count objects out
43 of queue when converting (avoids the second move). Big issue here
44 with binary data since need to extend format to count it.
|
45 karl 1.1.2.8 8. NEXT TASKS:
|
46 karl 1.1.2.15 a. test the enumeration timeout thread
47 b. Add openQueryInstances test to pullop
48
49 18 November 2013
50 1. Cleanup of a bunch of minor errors and completion of all of the code for
51 the openQueryInstances except for the PullInstances in Dispatcher and
52 the aggregator function.
53 2. OpenqueryInstances added to cimcli.
|
54 karl 1.1.2.14
55 13 October 2013 CVS branch update.
56 1. Integrated bug 9786 into the branch. Note that we need to test the
57 generated statistics.
58 2. Mergeout executed to update to head of tree as of 8:00 am 13 October 2013.
59 3. Cleaned up several errors in OOP processing. Note that there is at least
60 one issue left when we to a pull on ManagedElement in at least one of the
61 namespaces.
62 4. Cleaned up some of the outstanding diagnostic code
63 5. Generally passes all tests except for one test of pullop where it is trying
64 to pull enum instances CIM_ManagedElement from a particular namespace.
|
65 karl 1.1.2.12
66 30 September 2013 - CVS Update
67 Mergeout head of tree up to 29 September 2013.
|
68 karl 1.1.2.10
69 29 September 2013. CVS update.
70 1. Modified calls to statisticalData.cpp to a) directly call with request
71 type, b) incorporate the open, pull, etc. messages. However, since these
72 are not part of the CIM class, we must do something special with them.
|
73 karl 1.1.2.13 See bug 9785 for full solution to this issue.
|
74 karl 1.1.2.10 2. Corrected OOP interface to enable new flag to indicate internal operations
75 and set host, etc.
76 3. Add code to CQLOperationsDispatcher and WQLOperationDispatcher to clean
77 up CIMResponseDataCounter after filtering.
78 4. Modified ProviderAgent to set Host info for some pull operations.
79 5. Added new flag to CIMBinMsgSerializer and Deserializer.
|
80 karl 1.1.2.8
|
81 karl 1.1.2.9 17 September 2013 CVS update (Actually two different updates over 3 days)
82 1. Clean up some issues in CIMMessage.h and CIMMessage.cpp
83 2. Extend OpenExecQuery to WQL and CQL processors but return not complete
84 3. Remove memory leak in EnumerationContext and EnumerationContextTable
85 handling.
86 4. Created template functions for much of the pull operations.
87 5. Reversed order of queryLanguage and query (and changed names to match
88 execQuery) in client and server. Note that these are the execQuery
89 WQL and CQL filters and NOT FQL filters.
90 6. Some code cleanup in dispatcher
91 7. Today, passes all tests in pullop but issue in alltests. For some reason
92 not finding CIMObjectManager instance. Also, leaves enumeration contexts
93 if client terminates since cleanup thread not operating.
|
94 karl 1.1.2.11 8. XML from OOP not correctly processed.
|
95 karl 1.1.2.9
|
96 karl 1.1.2.8 14 September 2013 CVS update
97 Merged out up to 25 August. Cleaned up all operations and standardized code.
98 At this point the non pull operations code is in a set of templates but the
99 pull is not yet.
100 Fixed a significant number of problems so that it appears that the operations
101 except for OpenExecQuery run stably, at least with the pullop test program.
102 Note that there is a problem in that the Interop control provider is not
103 returning its singleton wbemserver object for some reason. Causes a test
104 failure
|
105 karl 1.1.2.7
106 Fixed for 16 June CVS Update
107 1. Cleaned up the enumerationContext and Table release functions and tested
108 to confirm that we do not lose memory in either normal sequences or
109 sequences that close early. Cleaned up pullop and added more tests
|
110 karl 1.1.2.8 Taged Before: PREAUG25UPDATE and after POSTAUG25UPDATE
|
111 karl 1.1.2.4
112 Fixed for 9 June CVS update
113 1. Cleaned up code for OpenQueryInstances. Note that this is incomplete.
114 No support in WQL or CQL Operations
115 2.
116
117 What was fixed for 5 June checkin.
|
118 karl 1.1.2.3 1. Extended ResponseTest MOF for for both CMPI and C++ subclasses
119 2. Fixed issues with pullop.
120 3. Fixed temp issue with CIMResponseData size by putting in mutex. That
121 is not a permanent fix but it gets around issue probably in the control
122 of the move logic that meant counts were off.
123 4. Fixed issues in Dispatcher so that associator code works. Still messy
124 code in the dispatcher.
125 5. Changed name of Enumerationtable.h & cpp to EnumerationContextTable.*
126 6 Changed name of ResponseStressTest module, classes, etc.
127
128 TAG: TASK_PEP317_5JUNE_2013_2
129
|
130 karl 1.1.2.2 2 June 2013
|
131 karl 1.1.2.1
132 Issues - KS
133
|
134 karl 1.1.2.15 - Still way to many TODO and KS comments and KS_TEMPS. Removing bit by bit.
|
135 karl 1.1.2.1
|
136 karl 1.1.2.15 - Runtime variable connection for the config parameters not installed. That
137 has been made into a separate bug (see bug 9819)
|
138 karl 1.1.2.1
139 5. Issue with the threaded timer. For some reason during tests it
140 eventually calls the timer thread with trash for the parm (which is
141 pointer to the EnumerationTable object). Caught because we do a valid
142 test at beginning of the function.
143
|
144 karl 1.1.2.2 6. Still using the templates in CIMOperationRequestDispatcher to simplify
145 the handle... processing.
146
147 7. I think I have a way around the double move of objects in the
148 EnumerationContext so that the outputter will just take a defined number
149 of objects directly from the gathering cache and save the second move.
150
|
151 karl 1.1.2.15 8. Not yet passing all tests but getting closer now. The major test that is
152 causing an error today is the execution of a full enumeration with the
153 forceProviders = true. This causes a client timeout sometimes.
|
154 karl 1.1.2.2
155
156
|
157 karl 1.1.2.1 ===========================================
158
159 OVERVIEW:
160
161 The operation extensions for pull operations defined in the DMTF specification
162 DSP0200 V 1.4 were implemented in Pegasus effective Pegasus version 2.11
163 including Client and Server.
164
165 These operations extend the CIM/XML individual operations to operation
166 sequences where the server must maintain state between operations in a
167 sequence and the client must execute multiple operations to get the full
168 set of instances or instance paths.
169
170 The following new CIM/XML operations as defined in DSP0200 are included;
171
172 -OpenEnumerateInstances
173 -openEnumerateInstancePaths
174 -OpenReferenceInstances
175 -OpenReferenceInstancePaths
176 -OpenAssociatiorInstances
177 -OpenAssociatorInstancePaths
178 karl 1.1.2.1 -PullInstancesWithPath
179 -PullInstancePaths
180 -CloseEnumeration
181 -EnumerationCount
|
182 karl 1.1.2.2 OpenExecQuery
|
183 karl 1.1.2.1
184 The following operations have not been implemented in this version of Pegasus:
185
186 -OpenQueryInstances
187
188 The following limitations on the implementation exist;
189
190 1. The filterQueryLanguage and filterQuery parameters are processed by
191 the Pegasus client but the server returns error if there is any data in
|
192 karl 1.1.2.2 either parameter. This work does not include the development of the
193 query language. Note that a separate effort to extend Pegasus to use
194 the DMTF FQL query language is in process.
|
195 karl 1.1.2.1
196 2. The input parameter continueOnError is processed correctly by the client
197 but the Pegasus server only provides for false since the server does not
198 include logic to continue processing responses after an error is
199 encountered.
200 This is consistent with the statement in the specification that use of
201 this functionality is optional and the fact that the DMTF agrees that all
202 of the issues of continuing after errors have not been clarified.
203
204 3. The operation enumerationCount is not processed by the server today since
205 a) really getting the count would be the same cost as the corresponding
206 enumeration, b) the server does not include a history or estimating
207 mechanism for this to date.
|
208 karl 1.1.2.2 NOTE: After a through review as part of the development of the next version
209 of CMPI we have concluded that this operation is probably not worth the
210 effort. Since it is optional, Pegasus will only return the unknown status
211 at this point
|
212 karl 1.1.2.1
213 Since the concept of sequences of operations linked together (open, pull, close)
214 is a major extension to the original CIM/XML operation concept of completely
215 independent operations several new pieces of functionality are implemented
216 to control interOperationTimeouts, counts of objects to be returned, etc.
217
218 TBD - Review this
219
220 CLIENT
221
222 The new operations follow the same pattern as the APIs for existing operations
223 in that:
224
225 1. All errors are handled as CIMException and Exception
226
227 2. The means of inputting parameters are the same except that there are
228 significantly more input parameters with the open operations and for the
229 first time operations return parameters as well as objects in the
230 response. Specifically the open and pull operations return values for
231 enumerationContext which is the identity for a pull sequence and
232 endOfSequence which is the marker the server sends in open and pull
233 karl 1.1.2.1 responses when it has no more objects to send.
234
235 The significant differences include:
236
237 1. Processing of parameters on responses (i.e. the endOfSequence and
238 enumerationContext parameters are returned for open and pull operations).
239
240 2. Numeric arguments (Uint32 and Uint64 include the option of NULL in some
241 cases so they are packaged inside classes Uint32Arg and Uint64Arg in the
242 client api.
243
244 3. The association and reference operations ONLY process instances. They do
245 not include the capability to return classes like reference and associator
246 do and therefore return CIMInstance rather than CIMObject.
247
248 4. Paths are returned in all cases (i.e OpenEnumerateInstances and
249 PullInstancesWithPath where they were not with EnumeratInstances.
250
251 5. The client must maintain state between operations in a sequence (using
252 the enumerationContext parameter).
253
254 karl 1.1.2.1 TBD- Are there more differences.
255
256
257 SERVER
258
259 The Pegasus server attempts to always deliver the requested number of objects
260 for any open or pull request (the specification allows for the server to
261 deliver less than the requested number of objects and specifically to return
262 zero objects on open). We felt that it was worth any extra cost in processing
263 to provide the client with exactly what it had requested.
264
265 The pegasus server always closes an enumeration sequence upon receipt of any
266 error from the providers, repository, etc. Therefore the server will reject
|
267 karl 1.1.2.2 any request that has continueOnError = true;
268
269 Expansion to allow the continue on error may be added in a future version.
270 In any case, the whole purpose of the continue on error is really to allow
271 input from good providers to be mixed with providers that return errors so
272 that generally this would mean simply changing the logic in the return mechanism
273 to not shutdown when an error is received from any given provider.
274
275 Generally we do not believe that the providers need to do much more in the
276 future to support the continueOnError other than possibly allowing the provider
277 to continue processing after it has received an error.
|
278 karl 1.1.2.1
279 PROVIDERS
280
281 This implementation requires NO changes to the existing providers. The
282 provider APIs operate just as they do with the original operations.
283
284 Because the server processing is different however, there may be some
285 behavior differences primarily because the client now controls the speed of
286 delivery of objects.
287
288 In previous versions of Pegasus, the server attempts to deliver objects as
289 rapidly as then can be put on the network. In the case of HTTP chunked requests
290 they are delivered in chunks of about 100 objects. The primary delay for the
291 providers was the processing of each segment through the server. The server
292 is blocked so that no other segment can proceed through the server until that
293 segment is processed and sent on the network.
294 In the case of non-chunkedresponses, they are completely gathered in the serve
295 and then delivered as one non-chunked response. There were no delays for the
296 providers, just lots of possible memory use in the server.
297
298 The responses from providers (delivered through the deliver(...) interface are
299 karl 1.1.2.1 gathered into segments of about 100 objects and this group of objects is moved
300 through the server to be delivered to the client.
301
302 However with the inclusion of the pull operations, The segments of objects
303 from the providers are cached in the server response path until the
304 maxObjectCount for that request (open or pull) and that number returned in a
305 non-chunked response. Thus, if the client is slow to issue pull requests,
306 the providers might be delayed at some point to reduce memory usage in the
307 server (the delay appears as slow response tothe deliver operation).
308
309 In other words, the time to process large sets of responses from the provider
310 now depends on the speed of handling the client.
311
312 It is important to remember in developing providers that the Pegasus server
313 can most efficiently process responses if they are passed from the provider
314 to the server individually or in small arrays of objects rather than the
315 provider gathering very large arrays of objects and sending them to the
316 server.
317
|
318 karl 1.1.2.2 NEXT GENERATION PROVIDERS
319 KS_TODO
320
|
321 karl 1.1.2.1 CONFIGURATION PARAMETERS
322
323 The server includes several configuration parameters to set limits on the
324 processing of pull operations. All of these configuration parameters are
325 compile time parameters rather than runtime.
326
327 1. Maximum value of minimum interoperation time. This parameter defines the
328 maximum time allowed between the return of an open or pull response and
329 the receipt of the next pull or a close operation before the server may
330 close the enumeration. The specification allows the server to set a
331 maximum interoperation time and refuse open requests that with requested
332 operationTimeout greater than that time.
333 CIM_ERR_INVALID_OPERATION_TIMEOUT
334
335 This value is set with the Pegasus environment variable
336 PEGASUS_PULL....
337
338 2. Maximum objects returned in a single open or pull operation. The server
339 can set a maximum limit on the number of objects that can be returned in
340 a single open or pull oepration with the maxObjectCount parameter.
341
342 karl 1.1.2.1 3. Whether the server allows 0 as an interoperation timeout value. The value
343 zero is s special value for the interoperationTimeout in that it tells the
344 server to not timeout any enumeration sequence.
345
346 With this value for interoperationTimeout, the only way to close an
347 enumeration sequence is to complete all of the pulls or issue the close.
348 If for some reason the sequence is not completed, that enumeration context
349 would remain open indefinitly. Since in Pegasus any open enumeration
350 context uses resources (the context object and any provider resposnes that
351 have not yet been issued in a response) it would appear that most
352 platforms would not want to allow the existence of enumeration contexts
353 that cannot be closed by the server.
354
355 4, maximum consecutive pull requests with 0 maxObjectCount. The use of the
356 pull operation with maxObjectCount set to zero could be used to keep an
357 enumeration context open indefinitly (this tells the server to restart the
358 interoperationTimeout but not send any objects in the response). Therefore the
359 specification allows for the server setting maximum limits on this behavior
360 and returning the error CIM_ERR_SERVER_LIMITS_EXCEEDED if this limit is
361 exceeded.
362 Note that this is maximum CONSECUTIVE pulls so that issuing a pull with
363 karl 1.1.2.1 a non-zero count resets this counter.
364
365 KS-TBD - Is this really logical since we can still block by just issuing
366 lots of zero request and an occansional request for one object.
367
368 Pegaus sets the value of this limit to 1000 and allows the implementer to
369 modify it with the PEGASUS_MAXIMUM_ZERO_OBJECTCOUNT environment variable.
370
371 5. Default operationTimeout -
372
373 The default of this parameter is to refuse operat
374
375 In the current release of Pegasus these are all compile time parameters.
|
376 karl 1.1.2.11
377
378 NOTES On working with task branch.
379
380 Merge out Process
381
382 To keep our TASK branch in sync with the current head of tree we need
383 to do a regular merge out. the TaskMakefile contains the makefile
384 procedures to do this efficiently. NOTE: Following these procedures is
385 important in that you are merging out new material each time you do
386 the merge out. If you were just to repeatedly merge out, you would be
387 merging previously merged changes a second time causing a real mess.
388
389 Start with new directory and put TaskMakefile above pegasus (needed so you
390 have this file for the initial operations.
391
392 make -f TaskMakefile branch_merge_out BNAME=PEP317-pullop ## takes a long time
393
394 This checks out current head, merges it into task branch and sets tags
395 for the mergeout. Note that at the end of this step this work is
396 part of the TASK... branch.
397 karl 1.1.2.11
398 NOW check for conflicts, errors, etc. that resulted from the merge.
399 Look for conflict flags, compare the results (I use linux merge as a
400 good graphic compare tool) and build and test. When you are satisfied
401 that the merge out is clean, you can commit the results to the TASK...
402 branch
403
404 To commit the work to this into Task branch
405
406 make -f mak/TaskMakefile branch_merge_out_commit BNAME=PEP317-pullop
407
408 or manually commit and finish as follows
409
410 cvs commit
411 make -f mak/TaskMakefile branch_merge_out_finish BNAME=PEP317-pullop
412
413 ## This last step is important since it cleans up temporary tags to prepare
414 you for the next checkout
415
416 COMPARE TASKBRANCH WITH HEAD
417
418 karl 1.1.2.11 In a new pegasus work space do same as above for merge out.
419
420 make -f TaskMakefile BNAME=PEP317-pullop
421
422 This produces a result which is all of the head merged into the branch.
423 A diff of this is all the new changes to the head of tree that you will
424 include into the merge.
425
|
Return to
readme.pulloperations
CVS log
Up to [Pegasus] / pegasus