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