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