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