(file) Return to readme.pulloperations CVS log (file) (dir) Up to [Pegasus] / pegasus

  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.31       OOP right now.  Fixed by converting to XML. Concluded that we do not
 15                      need to do this. The binary response is not really used often
 16                      in the current environment So double mapping it is not a major issue.
 17                      Leave this as FUTURE
 18 karl  1.1.2.35    2. DONE OpenExecQuery - Code is incomplete in that it does not include the
 19 karl  1.1.2.31       return from the exec query function to the aggregator yet. Code for Pull
 20 karl  1.1.2.34       part of OpenQueryInstancesRequest a) should be part of the common
 21                      CIMOperationRequestDispatcher execCommon code. DONE, not tested. 29 May
 22 karl  1.1.2.35        30 May tested with simple cli calls.
 23                   3. DONE The changes to WQLCIMOperationRequestDispatcher and CQL... for handling
 24 karl  1.1.2.4        pull not completed so we feed the responses back to the EnmerationContext
 25 karl  1.1.2.35       queues. DONE Not tested 29 May 30 May DONE,  some testing done
 26                   4. Minor TODOs, diagnostics, etc. still in the code. Reduced almost to
 27                      none now.  We are leaving some in as PEGASUS_DEBUG
 28 karl  1.1.2.31    5. Extension to avoid double move of objects in CIMResponseData (one
 29 karl  1.1.2.3        into enumerationContext queue and second to new cimResponseData for
 30                      response.  Want to avoid second move by extending Open/Pull response
 31                      messages to include count and CIMResponse data to count objects out
 32 karl  1.1.2.23       of queue when converting (avoids the second move). This would mean
 33                      extending the output writers to allow the count field to be supplied
 34 karl  1.1.2.30       so they would only create output for up to the count supplied.(Make
 35 karl  1.1.2.35       this future beyond bug 9676). This is fairly extensive because it
 36                      extends beyond CIMResponseData to SCMO and XML writers where the
 37                      XmlWriters used by encodeXmlResponse would have to have counters
 38                      added. Then instead of copying on getCache we would simply pass the
 39                      cache and count on and the writer would take and remove.
 40 karl  1.1.2.31    6. Add more static tests (currently only OpenEnumerateInstances and
 41 karl  1.1.2.30       OpenEnumerateInstanceNames covered). 
 42 karl  1.1.2.26       Low priority because most of this except exact XML covered in other
 43 karl  1.1.2.28       tests. note that we can only add very limited tests since a) no
 44 karl  1.1.2.31       way to test multiple operations in sequence(i.e. open/pull) and
 45 karl  1.1.2.28       cannot be sure how many responses will come back in all cases even
 46 karl  1.1.2.35       for open.  The only reason for most of these tests is to assure that
 47                      we do not change XML inadvertendtly in future with change that is
 48                      compatible to both our server and client but breaks other clients or
 49                      servers. In any case we can do only minimal tests because most real
 50                      testing involves both open and pull and the static tests are by their
 51                      nature single operation.
 52                   7. Clean up the CIMOperationRequestDecoder.cpp reject CIMException
 53                      further since there is some overlap. The only overlap is that a
 54                      couple of the specific functions duplicate. VERY LOW priority.
 55 karl  1.1.2.32    8. Correct issue between operations and HTTP where we are sending
 56 karl  1.1.2.31       trailers with exceptions. Modify response mechanisms so that we
 57                      set non-chunked for all responses where we send error responses to
 58 karl  1.1.2.35       avoid the trailers. NOTE: There should be now a bug on this in general
 59                      where we would want to send an initial error without the trailer. Should
 60                      have always done that.
 61 karl  1.1.2.32    9. It would be more efficient in dispatcher to always use exception for
 62 karl  1.1.2.31        rejects and change the _reject functions so that they never return
 63                       when they reject. This is VERY LOW PRIORITY and primarily saves
 64                       a few lines of code in the reject functions and their calls.  Means we
 65                       would code.
 66 karl  1.1.2.35        _rejectIfEnumerationToBroad(...);
 67                       _rejectIfThisParameterIncorrect(...);
 68 karl  1.1.2.31 
 69                       instead of
 70                       if (_rejectIfEnum...)
 71                       {
 72                           return true
 73                       }
 74                       It would mean that the method trace for the handlers would not return
 75 karl  1.1.2.35        an exit if we rejected. VERY LOW PRIORITY. Possibly FUTURE. No behavior
 76                       change, just more compact source code but it messes with the method
 77                       trace logic.
 78 karl  1.1.2.34     10. There are still a couple of template functions around the task of
 79 karl  1.1.2.32        distributing requests to the multiple providers.
 80                       In fact there are two similiar but different templates for
 81 karl  1.1.2.31        the associators(i.e. assoc, ref, etc.) functions and the parallel
 82                       openAssoc functions.  It would be nice to consolidate that logic and
 83                       further to try to create a non-template form for those functions. LOW
 84                       PRIORITY.
 85 karl  1.1.2.34     11. External runtime variables. This bug leaves these variables as
 86 karl  1.1.2.37        internal to CIMOperationRequestDispatcher.cpp.  
 87                       See bug 9819 for the changes to externalize these variables, both
 88                       the runtime and buildtime variables.  The Work group discussion
 89                       documents what the variables are and how they tie to statistics info.
 90                       See the OpenPegasus Wiki, Pull operations work group.
 91 karl  1.1.2.35     12. Trace functions in CIMResponseData,h & cpp should be PEGASUS_DEBUG.
 92 karl  1.1.2.37        Same for trace function in EnumerationContext and
 93                       EnumerationContextTable
 94                    13.Question. We added trace in CIMRequestOperationDispatcher.cpp if
 95                       query enum is recevied with no object path.  However, since this is
 96                       a provider problem should we be doing something other than a trace
 97                       (ex. log) since traces are often not really used and they do generate
 98                       lots of data whereby something like this could get lost. Also, need
 99                       to review what level of trace if we keep trace.
100 karl  1.1.2.36    14. Note that the build-a-class argument on OpenQueryInstances always
101 karl  1.1.2.38       returns error since we do not build the class.  We propose to deprecate
102                      this in DMTF and not implement in in OpenPegasus. TODO add a bug
103                      defining this limitation. This is not a TODO, just a warning for
104 karl  1.1.2.37        the future. TODO add bug about this and add to release notes
105 karl  1.1.2.38    15. Clarify trace of completion of each enumeration sequence.
106                   16. Statistics keeping for open, etc. through cimperf.
107                
108 karl  1.1.2.26 
109                   NEXT TASKS: 
110 karl  1.1.2.37       a. finish 8, 12 above. Test against cimperf since there was a bug
111                      in cimperf from before.
112 karl  1.1.2.39 
113                2 July 2014
114                1. Corrected error in the new getoopt functions that caused it to fail
115                   in build and also in it unit test with the --help option.
116                
117                28 June 2014
118                1. Corrected issue where ZOs was getting errors from pullop because we
119                   used getopt to parse command line and the linux getopt is not behavior
120                   consistent with ZOs.  Note that the ZOs getopt matches the posix expect and
121                   the linux one has extensions (notably it permutes non option arguments to
122                   the end of the arguments array.  The easiest and most logical was to move
123                   the whole parser to use the internal getoopt which is what we should be
124                   using all the time in any case.
125 karl  1.1.2.38 18 June 2014
126                1. Correct errors in pullop and CMIMessage.cpp identified by Ji Lee as comments 58,59
127                2. Correct error in Makefile identified by Ji Lee as bug comment 60
128 karl  1.1.2.37 
129                14 June 2014
130                1. Mergeout from head of tree.
131                
132 karl  1.1.2.36 12 June 2014
133                1. Implement the basic code for the CIMOperationDispatcher portion of bug 9819
134                   Note that the CIMConfig calls are disabled with comments.
135                2. Corrected a number of differences in const declaration and definition for
136 karl  1.1.2.37    continueOnError and maxObjectCount in CIMClient. This corrects issue
137                   documented in bug 9676 comment 53
138 karl  1.1.2.36 3. Corrected some documentation for Pull operations in CIMClient.
139                4. Corrected similar issue In EnumerationContext class. See comment 54
140                5. Removed ExecInfo.h header from Client/tests/PullErrors/PullErrors.cpp
141 karl  1.1.2.35 
142                30 May 2014
143                1. Correct issue in UintArgs.  Modified to use smart pointers, consistent
144                   with public interfaces. Tested
145                2. Complete code for OpenQueryInstances and PullInstances so that the complete
146                   sequence works for both the server and client (i.e. 2, 3 above done
147                   except for more tests in pullop).
148                3. Fix issue in cimcli where the OpenQueryInstances was outputting a path
149                   component where there is no path transmitted from the server.
150                4. Moved large block of common code in CQLOperationRequestDispatcher.cpp
151                   and WQLOperationRequestDispatcher.cpp to common function
152                   handleQueryRequestCommon in CIMOperationRequestDispatcher.cpp. These
153                   handlers now reduced to just the parser processing and minimal error
154                   checks.
155                5. Cleaned up some code in EnumerationContextTable.CreateContext so only
156                   single interface for all requests.
157                6, Commented out a number of PEG_TRACE messages.  Note that they are
158                   commented with 4 /s at line beginning to be easily identified.
159                   //// code
160                   There are still a number of KS_TODOs but they are mostly some questsions,
161                   some internationalization (note that almost none of this environment is
162 karl  1.1.2.35    completely internationlaized (see the decoders)) and a couple of questions
163                   about the existing code or exactly what message should be sent.  I argue
164                   that the current TODOs should not stop checkin. Will remove after we
165                   have tested couple of days and prove that there is no real need.
166                7. Added trace in Query response code if there is no objectPath since that
167                   is really an error in the provider
168                
169 karl  1.1.2.34 
170                29 May 2014
171                1. Correct issue in cimcli that was causing rejects of open operations when
172                   there were no filters requested. The standard default is WQL in cimcli
173                   so we overrode this for the pull operations.
174                2. Clean up OpenQueryInstances in CIMMessage.h and CIMMessage.cpp.
175                3. Modify CIMOperationRequestDispatcher and
176                   EnumerationContextTable.CreateContext to pass request rather than request
177                   parameters.
178                4. Remove a number of diagnostic messages.  Note that there are still some.
179                   They are marked KS_TODO with with note to remove before checkin. They are
180                   all traces and validations.
181                5. Correct error in inclusion of execinfo.h include in CIMOperationRequestDis.
182                   found by Ji Lee.
183                6. Cleaned up execQuery and extended it for OpenQueryInstances.  ExecQuery
184                   tested but have not tested OpenQueryInstances yet. One more checkin and we
185                   should be able to close 2,3 above (OpenQueryInstances).
186 karl  1.1.2.32 
187                26 May 2014
188                1. Remove a number of diagnostics.
189                2. Make cache size in EnumerationContextTable dynamic and remove function
190                   to set default values. MaximumEnums set from Dispatcher on constructor for
191                   EnumerationContextTable and table size set to 1/2 of maximum number of
192                   open contexts.
193                3. Clean up some statistics in EnumerationContextTable
194 karl  1.1.2.33 4. Correct error in query and queryLanguage parameters in cimcli in that
195                   the default for queryLanguage is WQL but must be "" for pull operations.
196                   If WQL found they set it to "".
197 karl  1.1.2.32 
198 karl  1.1.2.31 
199                9 May 2104
200                1. Converted several  template functions in CIMOperationRequestDispatcher
201                   to real functions
202                2. Added intermediate CIMMessage for CIMPullOperationRequestMessage since
203                   all of the pulls have exactly the same data. This allowed us to
204                   convert the template function processPullRequest from template to
205                   real function
206                3. Added intermediate CIMMessage for CIMOpenOperationRequestMessage betweeh\n
207                   all of the Opens and the  CIMRequestData message.  This will allow
208                   common code to test all of these variables in all 6
209                   CIMOperationRequestDispatcher handleOpen... functions
210                3. Added variable in  CIMOperationRequestDispatcher handleEnqueue to make
211                   releasing the original request conditional on return from the handle... 
212                   for open... and pull... handlers.
213                   This allowed us to drop one place where we were creating a new request msg
214                   for the delayed response and use the original request.  This meant that
215                   we could convert the issueOpenOrPullResponse from template function to
216                   real function.
217                4. Moved open and pull constructors in CIMMessage.h to CIMMessage.cpp. NOTE:
218                   openQueryInstances not moved.  Will do when we get this funciton running.
219 karl  1.1.2.31 5. Added test for correct namespace in pull operations.  Note that it is
220                   never really used but since supplied with request, we test to be sure it is
221                   same as open request namespace.  added internationalized exception for this.
222                6. We should probably add same test to close just as an input parameter
223                   validation.  
224                6. Modified processPullRequest to close the enumeration context if
225                   incorrect response type received.  Before we just returned exception and
226                   left context open for next request.  Closing is much more logical since the
227                   client really did send an erronous request.
228                7. Modified PullErrors to correctly test above changed in behavior.
229                8. Removed a significant number of diagnostic messages.
230 karl  1.1.2.33 9. Added query and querylanguage parameters to cimcli.
231 karl  1.1.2.31 
232 karl  1.1.2.23 
233 karl  1.1.2.30 4 May 2014
234                1. Clean interface with EnumerationContext timeout thread
235                2. Remove more diagnostics
236                3. Correct issue with enumerationContext Release that was causing
237                   failures during nightly tests.
238                
239 karl  1.1.2.29 2 May 2014
240                1. Remove Diagnostics from ResponseData.cpp
241                2. Correct setup and start of EnumerationContextTimerThread
242                3. Change limit on max number of enum contexts to be set from Dispatcher.
243                4. Increase size of hashtable for enum contexts.
244                5. Corrected issue causing failures in removeContext. Now runs through nightly
245                   tests most of the time.
246 karl  1.1.2.28 1 May 2014
247                1. Cleanup of code and variable names.
248                2. Removed namespace variable from EnumerationContext.  It was never used.
249                3. Added test for max number of open enumerations.  Right now it is fixed
250                   and set about 100. Note that this is tied to the size of hash table
251                   so that there is a issue with more dynamic setting of max and the
252                   hash table size.
253                4. Removed several unused functions.
254                5. Found one possible issue causing thread conflict but not the core one
255                   yet.  
256                
257                30 April
258                1. Added exception response to dispatcher for Limits exceeded on
259                   CreateEnumerationContext. Returns Exceeded server limits CIMException.
260                2. Fixed possible deadlock where we were not unlocking EnumerationContext
261                   under error condition
262                
263                
264 karl  1.1.2.27 27 April - mergeout to head of tree
265                1. Mergeout of the code to the head of tree. Documented that mergeout in
266                   the bug
267                
268                27 April 2014
269                1. Clean up in a number of areas, mostly just code without changing
270                   functionality.
271                2. Modified CIMMessage.h slightly to clarify names of the pull intermediate
272                   messages (the common open and pull response);
273                3. Removed a number of diagnostics from CIMResponseData
274                4. Added new function to ResponseStressTestProvider to be able to terminate
275                   output after a defined number of objects with a CIMException.
276                5. Removed a number of other TODOs
277                6. Corrected a couple of errors in the server message bundle.
278                7. Modified ResponseEncoder to only output the error for pull errors.
279                   It was errounously outputting the EndOfSequence, EnumerationContext and
280                   the error.  This way, only the error is sent which is spec.
281                8. Removed number of TODOs and cleaned up a couple of others.
282                9. Added static tests for OpenEnumerateInstanceNames.
283                10. Modified a number of the temporary diagnostics to be permanent by
284                    changing them to PEGASUS_DEBUG_ASSERTs
285 karl  1.1.2.27 
286 karl  1.1.2.24 22 April 2014
287                1. Clean up some messages.
288                2. Still trying to find issue that randomly keeps messages in timeout
289                   queue long after they have been closed and returned.
290 karl  1.1.2.25 3. Fixed memory loss error.
291 karl  1.1.2.26 4. Added zero reject for OperationTimeout because that effectively disables
292                   the whole timeout mechanism so that enumerations could be started, never
293                   completed by the client and would just hang around in memory. That
294                   would be a significant DDOS attack (start very large enum with no
295                   timeout) and never do pulls after open.
296 karl  1.1.2.25 
297 karl  1.1.2.23 21 April 2014
298 karl  1.1.2.27 1. Reorganized code in CIMOperationRequestDecoder.cpp ...Iparam classes.
299 karl  1.1.2.23    Cleaned up the rejectCIMException code.
300                2. Cleanup some issues in the EnumerationContextTimeout Thread.
301                3. Fixed issue in pullop where it was using zero as default for default
302                   operation timeout where it should have been NULL, the DMTF specified
303                   default.
304                4. Enabled the test to reject 0 as operation timeout on a request and but
305                   controled by a #define in CIMOperationRequestDispatcher.cpp
306                5. Added test for excessive new OperationContext entries in table.
307                
308                18 April 2014
309                1. Internationalize remaining messages in CIMOperationRequestDecoder.cpp and
310                   clean up the decoders for some of the messages so they use the
311                   ...Iparam classes.  Note that we did not clean up all of the old message
312                   decoders, just the new ones and we did not clean up the Count message
313                   since it is deprecated. TODO clean these up so the decoder is really
314                   consistent.
315                2. Enabled the EnumerationContext Timer and removed code for alternate
316                   non-thread solution.
317 karl  1.1.2.16 
318 karl  1.1.2.21 17 April 2014
319                1. Reorganized the lock/unlock for handling the EnumerationContext because
320                   there were thread windows (i.e. using the context after it was released
321                   by other thread).
322                2. Modified code for the InteroperationTimerThread and deleted old code that
323                   allowed this whole thread to by bypassed.
324                3. Internationalized a number of CIMOperationRequestDispatcher CIMException
325                   response messages.
326 karl  1.1.2.22 4. Fixed stress tests in Client/tests/pullop that were getting timeout. The
327                   issue was not the pull code but that fact that the idle client timeout
328                   appears to be measureing to the end of the operation and the operation
329                   was taking more than 40 seconds which is the default timeout. The idle
330                   timeout takes no account of the fact that chunks are being regularly
331                   delivered.
332                5. Several minor code changes.
333                NOTE: At this point the code passes extensive tests of the pull operations
334                   both in OOP and none OOP mode (but with lots of diagnostics that may
335                   be affecting timing).
336 karl  1.1.2.21 
337 karl  1.1.2.20 10 April 2014
338                1. Fix issues causing failure with repeated pull operations.
339                2. Consolidate some of the CIMOperationRequestDispatcher.cpp template code
340                
341 karl  1.1.2.19 7 April 2104
342                  MergeOut of head of tree.
343                
344                7 April 2014
345                1. Permanently fixed issue with getting correct number of objects on response.
346                   This was introduced when did a temp fix to the OOP processing, in particular
347                   removed the condition variable wait in the CIMOperationDispatcher handle
348                   functions for opens and pulls.  This moved the functionality to kick off
349                   open and pull responses to the provider threads if there are not enough
350                   objects when the handle is processed. Also added a variable to allow us to
351                   test with either a) responses are required to satisfy the original 
352                   request size or) b, responses are required only to return some objects.
353                   We will add statistics to see which of these works best.
354                2. Modified WsmProcessor EnumerationContext class since the name conflicts
355                   with the pull Operation EnumerationContext class.
356                3. Created a new intermediate level of CIMMessage, the CIMPullResponseData
357                   Message so that all of the open and Pull responses can use common code
358                   since there are only two variables (endOfSequence and EnumerationContext)
359                   and they are common across all the open and pull responses.
360                4. Removed a number of diagnostics.
361                5. Cleaned up the Dispcatcher so that the open and pulls have common response
362 karl  1.1.2.19    code and that code can be used from the dispatcher handle functions and
363                   the provider response functions.
364                
365 karl  1.1.2.18 31 March 2014 - Checkin
366                1. Fixed issues in OOP processing of pull operations, in particular
367                   issues with cimxml output format when processed through the
368                   *InternalXmlEncoder functions.
369                2. Clean up some of the internalXml functionality
370                3. Found issues causing timeout with a particular provider.  The issue
371                   is that the dispatcher and monitor end up using the same thread so the
372                   condition variable in the dispatcher thread stops the monitor. Turned
373                   off the conditionVariable in getCache for the moment which means that
374                   we get number of responses for open... with 0 objects before the
375                   providers can begin to respond.  This is only for test.
376                4. Added some statistics for enumerations and display the statistics 
377                   when we close the server (same as cache statistics)
378                
379                12 March 2014 - Mergeout and Mergein
380                1. Mergeout to head of tree for this date and mergein for patch update
381                   to bug 9676
382                2. Extensions to pullop tests program and tests.
383                3. Added some diagnostics in looking for OOP issue.
384                4. Removed a number of diagnostics messages and cleaned up code in
385                   dispatcher to simplify pull operation processing.
386 karl  1.1.2.18 
387 karl  1.1.2.17 15 December 2013
388                1. Mergeout and mergein up to 15 December 2013
389                2. Clean up issues from tests documented in bug 9676 last week.
390                3. Clean up some code in dispatcher
391                4. Remove the filter function from ResponseStressc++Provider.
392                
393 karl  1.1.2.16 21 November 2013
394                1. Mergeout from head of tree to 21 November 2013.
395 karl  1.1.2.15 
396                18 November 2013
397                1. Cleanup of a bunch of minor errors and completion of all of the code for
398                   the openQueryInstances except for the PullInstances in Dispatcher and
399                   the aggregator function.
400                2. OpenqueryInstances added to cimcli.
401 karl  1.1.2.14 
402                13 October 2013 CVS branch update.
403                1. Integrated bug 9786 into the branch.  Note that we need to test the
404                   generated statistics.
405                2. Mergeout executed to update to head of tree as of 8:00 am 13 October 2013.
406                3. Cleaned up several errors in OOP processing.  Note that there is at least
407                   one issue left when we to a pull on ManagedElement in at least one of the
408                   namespaces.
409                4. Cleaned up some of the outstanding diagnostic code
410                5. Generally passes all tests except for one test of pullop where it is trying
411                   to pull enum instances CIM_ManagedElement from a particular namespace.
412 karl  1.1.2.12 
413 karl  1.1.2.16 NOTE: I did not make comments here for changes in October despite the fact
414                that I did 2 mergouts, number of fixes, and a mergein.
415                
416 karl  1.1.2.12 30 September 2013 - CVS Update
417                Mergeout head of tree up to 29 September 2013.
418 karl  1.1.2.10 
419                29 September 2013. CVS update.
420                1. Modified calls to statisticalData.cpp to a) directly call with request
421                   type, b) incorporate the open, pull, etc. messages.  However, since these
422                   are not part of the CIM class, we must do something special with them.
423 karl  1.1.2.13    See bug 9785 for full solution to this issue.
424 karl  1.1.2.10 2. Corrected OOP interface to enable new flag to indicate internal operations
425                   and set host, etc.
426                3. Add code to CQLOperationsDispatcher and WQLOperationDispatcher to clean
427                   up CIMResponseDataCounter after filtering.
428                4. Modified ProviderAgent to set Host info for some pull operations.
429                5. Added new flag to CIMBinMsgSerializer and Deserializer.
430 karl  1.1.2.8  
431 karl  1.1.2.9  17 September 2013 CVS update (Actually two different updates over 3 days)
432                1. Clean up some issues in CIMMessage.h and CIMMessage.cpp
433                2. Extend OpenExecQuery to WQL and CQL processors but return not complete
434                3. Remove memory leak in EnumerationContext and EnumerationContextTable
435                   handling.
436                4. Created template functions for much of the pull operations.
437                5. Reversed order of queryLanguage and query (and changed names to match
438                   execQuery) in client and server.  Note that these are the execQuery
439                   WQL and CQL filters and NOT FQL filters.
440                6. Some code cleanup in dispatcher
441                7. Today, passes all tests in pullop but issue in alltests. For some reason
442                   not finding CIMObjectManager instance. Also, leaves enumeration contexts
443                   if client terminates since cleanup thread not operating.
444 karl  1.1.2.11 8. XML from OOP not correctly processed.
445 karl  1.1.2.9  
446 karl  1.1.2.8  14 September 2013 CVS update
447                Merged out up to 25 August.  Cleaned up all operations and standardized code.
448                At this point the non pull operations code is in a set of templates but the
449                pull is not yet.
450                Fixed a significant number of problems so that it appears that the operations
451                except for OpenExecQuery run stably, at least with the pullop test program.
452                Note that there is a problem in that the Interop control provider is not
453                returning its singleton wbemserver object for some reason.  Causes a test
454                failure
455 karl  1.1.2.7  
456                Fixed for 16 June CVS Update
457                   1. Cleaned up the enumerationContext and Table release functions and tested
458                      to confirm that we do not lose memory in either normal sequences or
459                      sequences that close early. Cleaned up pullop and added more tests
460 karl  1.1.2.8  Taged Before: PREAUG25UPDATE and after POSTAUG25UPDATE
461 karl  1.1.2.4  
462                Fixed for 9 June CVS update
463                   1. Cleaned up code for OpenQueryInstances.  Note that this is incomplete.
464                      No support in WQL or CQL Operations
465                   2. 
466                
467                What was fixed for 5 June checkin.
468 karl  1.1.2.3     1. Extended ResponseTest MOF for for both CMPI and C++ subclasses
469                   2. Fixed issues with pullop.
470                   3. Fixed temp issue with CIMResponseData size by putting in mutex. That
471                      is not a permanent fix but it gets around issue probably in the control
472                      of the move logic that meant counts were off.
473                   4. Fixed issues in Dispatcher so that associator code works. Still messy
474                      code in the dispatcher.
475                   5. Changed name of Enumerationtable.h & cpp to EnumerationContextTable.*
476                   6  Changed name of ResponseStressTest module, classes, etc.
477                
478                TAG: TASK_PEP317_5JUNE_2013_2
479                
480 karl  1.1.2.2  2 June 2013
481 karl  1.1.2.1  
482                Issues  - KS
483                
484 karl  1.1.2.15  - Still way to many TODO and KS comments and KS_TEMPS.  Removing bit by bit.
485 karl  1.1.2.1  
486 karl  1.1.2.15  - Runtime variable connection for the config parameters not installed. That
487                   has been made into a separate bug (see bug 9819)
488 karl  1.1.2.1  
489                5. Issue with the threaded timer.  For some reason during tests it
490                eventually calls the timer thread with trash for the parm (which is
491                pointer to the EnumerationTable object). Caught because we do a valid
492                test at beginning of the function.
493                
494 karl  1.1.2.2  6. Still using the templates in CIMOperationRequestDispatcher to simplify
495                the handle... processing.  
496                
497                7. I think I have a way around the double move of objects in the
498                EnumerationContext so that the outputter will just take a defined number
499                of objects directly from the gathering cache and save the second move.
500                
501 karl  1.1.2.15 8. Not yet passing all tests but getting closer now. The major test that is
502                causing an error today is the execution of a full enumeration with the
503                forceProviders = true.  This causes a client timeout sometimes.
504 karl  1.1.2.2  
505                
506                
507 karl  1.1.2.1  ===========================================
508                
509                OVERVIEW:
510                
511                The operation extensions for pull operations defined in the DMTF specification
512                DSP0200 V 1.4 were implemented in Pegasus effective Pegasus version 2.11
513                including Client and Server.
514                
515                These operations extend the CIM/XML  individual operations to operation
516                sequences where the server must maintain state between operations in a
517                sequence and the client must execute multiple operations to get the full
518                set of instances or instance paths.
519                
520                The following new CIM/XML operations as defined in DSP0200 are included;
521                
522                    -OpenEnumerateInstances
523                    -openEnumerateInstancePaths
524                    -OpenReferenceInstances
525                    -OpenReferenceInstancePaths
526                    -OpenAssociatiorInstances
527                    -OpenAssociatorInstancePaths
528 karl  1.1.2.16     -OpenQueryInstances
529 karl  1.1.2.1      -PullInstancesWithPath
530                    -PullInstancePaths
531 karl  1.1.2.16     -PullInstances
532 karl  1.1.2.1      -CloseEnumeration
533                    -EnumerationCount
534 karl  1.1.2.2       OpenExecQuery
535 karl  1.1.2.1  
536                The following  operations have not been implemented in this version of Pegasus:
537                
538                    -OpenQueryInstances
539                
540                The following limitations on the implementation exist;
541                
542                1. The filterQueryLanguage and filterQuery parameters are processed by
543                   the Pegasus client but the server returns error if there is any data in
544 karl  1.1.2.2     either parameter. This work does not include the development of the
545                   query language.  Note that a separate effort to extend Pegasus to use
546                   the DMTF FQL query language is in process.
547 karl  1.1.2.1  
548                2. The input parameter continueOnError is processed correctly by the client
549                   but the Pegasus server only provides for false since the server does not
550                   include logic to continue processing responses after an error is
551                   encountered. 
552                   This is consistent with the statement in the specification that use of 
553                   this functionality is optional and the fact that the DMTF agrees that all 
554                   of the issues of continuing after errors have not been clarified.  
555                
556                3. The operation enumerationCount is not processed by the server today since
557                   a) really getting the count would be the same cost as the corresponding
558                   enumeration, b) the server does not include a history or estimating
559                   mechanism for this to date.
560 karl  1.1.2.2     NOTE: After a through review as part of the development of the next version
561                   of CMPI we have concluded that this operation is probably not worth the
562                   effort.  Since it is optional, Pegasus will only return the unknown status
563                   at this point
564 karl  1.1.2.1  
565                Since the concept of sequences of operations linked together (open, pull, close)
566                is a major extension to the original CIM/XML operation concept of completely
567                independent operations several new pieces of functionality are implemented
568                to control interOperationTimeouts, counts of objects to be returned, etc.
569                
570                TBD - Review this
571                
572                CLIENT
573                
574                The new operations follow the same pattern as the APIs for existing operations
575                in that:
576                
577                1. All errors are handled as CIMException and Exception
578                
579                2. The means of inputting parameters are the same except that there are
580                   significantly more input parameters with the open operations and for the 
581                   first time operations return parameters as well as objects in the 
582                   response.  Specifically the open and pull operations return values for 
583                   enumerationContext which is the identity for a pull sequence and 
584                   endOfSequence which is the marker the server sends in open and pull 
585 karl  1.1.2.1     responses when it has no more objects to send.
586                
587                The significant differences include:
588                
589                1. Processing of parameters on responses (i.e. the endOfSequence and
590                   enumerationContext parameters are returned for open and pull operations).
591                
592                2. Numeric arguments (Uint32 and Uint64 include the option of NULL in some
593                   cases so they are packaged inside classes Uint32Arg and Uint64Arg in the
594                   client api.
595                
596                3. The association and reference operations ONLY process instances.  They do
597                   not include the capability to return classes like reference and associator
598                   do and therefore return CIMInstance rather than CIMObject.
599                
600                4. Paths are returned in all cases (i.e OpenEnumerateInstances and
601                   PullInstancesWithPath where they were not with EnumeratInstances.
602                
603                5. The client must maintain state between operations in a sequence (using
604                   the enumerationContext parameter).
605                
606 karl  1.1.2.1  TBD- Are there more differences.
607                
608                
609                SERVER
610                
611                The Pegasus server attempts to always deliver the requested number of objects
612                for any open or pull request (the specification allows for the server to
613                deliver less than the requested number of objects and specifically to return
614                zero objects on open).  We felt that it was worth any extra cost in processing
615                to provide the client with exactly what it had requested.
616                
617                The pegasus server always closes an enumeration sequence upon receipt of any
618                error from the providers, repository, etc. Therefore the server will reject
619 karl  1.1.2.2  any request that has continueOnError = true;
620                
621                Expansion to allow the continue on error may be added in a future version.
622                In any case, the whole purpose of the continue on error is really to allow
623                input from good providers to be mixed with providers that return errors so
624                that generally this would mean simply changing the logic in the return mechanism 
625                to not shutdown when an error is received from any given provider.
626                
627                Generally we do not believe that the providers need to do much more in the
628                future to support the continueOnError other than possibly allowing the provider
629                to continue processing after it has received an error.
630 karl  1.1.2.1  
631                PROVIDERS
632                
633                This implementation requires NO changes to the existing providers.  The
634                provider APIs operate just as they do with the original operations.
635                
636                Because the server processing is different however, there may be some
637                behavior differences primarily because the client now controls the speed of
638                delivery of objects.
639                
640                In previous versions of Pegasus, the server attempts to deliver objects as
641                rapidly as then can be put on the network.  In the case of HTTP chunked requests
642                they are delivered in chunks of about 100 objects. The primary delay for the
643                providers was the processing of each segment through the server.  The server
644                is blocked so that no other segment can proceed through the server until that
645                segment is processed and sent on the network.
646                In the case of non-chunkedresponses, they are completely gathered in the serve
647                and then delivered as one non-chunked response. There were no delays for the
648                providers, just lots of possible memory use in the server.
649                
650                The responses from providers (delivered through the deliver(...) interface are
651 karl  1.1.2.1  gathered into segments of about 100 objects and this group of objects is moved
652                through the server to be delivered to the client.
653                
654                However with the inclusion of the pull operations,   The segments of objects
655                from the providers are cached in the server response path until the 
656                maxObjectCount for that request (open or pull) and that number returned in a
657                non-chunked response. Thus, if the client is slow to issue pull requests,
658                the providers might be delayed at some point to reduce memory usage in the
659                server (the delay appears as slow response tothe deliver operation).
660                
661                In other words, the time to process large sets of responses from the provider
662                now depends on the speed of handling the client.
663                
664                It is important to remember in developing providers that the Pegasus server
665                can most efficiently process responses if they are passed from the provider
666                to the server individually or in small arrays of objects rather than the
667                provider gathering very large arrays of objects and sending them to the
668                server.
669                
670 karl  1.1.2.2  NEXT GENERATION PROVIDERS
671                KS_TODO
672                
673 karl  1.1.2.1  CONFIGURATION PARAMETERS
674                
675                The server includes several configuration parameters to set limits on the
676                processing of pull operations.  All of these configuration parameters are
677                compile time parameters rather than runtime.
678                
679                1. Maximum value of minimum interoperation time.  This parameter defines the
680                maximum time allowed between the return of an open or pull response and 
681                the receipt of the next pull or a close operation before the server may 
682                close the enumeration.  The specification allows the server to set a 
683                maximum interoperation time and refuse open requests that with requested 
684                operationTimeout greater than that time.  
685                CIM_ERR_INVALID_OPERATION_TIMEOUT
686                
687                This value is set with the Pegasus environment variable
688                PEGASUS_PULL....
689                
690                2. Maximum objects returned in a single open or pull operation.  The server
691                can set a maximum limit on the number of objects that can be returned in
692                a single open or pull oepration with the maxObjectCount parameter.
693                
694 karl  1.1.2.1  3. Whether the server allows 0 as an interoperation timeout value. The value
695                zero is s special value for the interoperationTimeout in that it tells the
696                server to not timeout any enumeration sequence.
697                
698                With this value for interoperationTimeout, the only way to close an 
699                enumeration sequence is to complete all of the pulls or issue the close.  
700                If for some reason the sequence is not completed, that enumeration context 
701                would remain open indefinitly.  Since in Pegasus any open enumeration 
702                context uses resources (the context object and any provider resposnes that 
703                have not yet been issued in a response) it would appear that most 
704                platforms would not want to allow the existence of enumeration contexts 
705                that cannot be closed by the server.  
706                
707                4, maximum consecutive pull requests with 0 maxObjectCount.  The use of the
708                pull operation with maxObjectCount set to zero could be used to keep an
709                enumeration context open indefinitly (this tells the server to restart the
710                interoperationTimeout but not send any objects in the response). Therefore the
711                specification allows for the server setting maximum limits on this behavior
712                and returning the error CIM_ERR_SERVER_LIMITS_EXCEEDED if this limit is
713                exceeded.
714                Note that this is maximum CONSECUTIVE pulls so that issuing a pull with
715 karl  1.1.2.1  a non-zero count resets this counter.
716                
717                KS-TBD - Is this really logical since we can still block by just issuing
718                lots of zero request and an occansional request for one object.
719                
720                Pegaus sets the value of this limit to 1000 and allows the implementer to
721                modify it with the PEGASUS_MAXIMUM_ZERO_OBJECTCOUNT environment variable.
722                
723                5. Default operationTimeout - 
724                
725                The default of this parameter is to refuse operat
726                
727                In the current release of Pegasus these are all compile time parameters.
728 karl  1.1.2.11 
729                
730                NOTES On working with task branch.
731                
732                Merge out Process
733                
734                   To keep our TASK branch in sync with the current head of tree we need
735                   to do a regular merge out.  the TaskMakefile contains the makefile
736                   procedures to do this efficiently.  NOTE: Following these procedures is
737                   important in that you are merging out new material each time you do
738                   the merge out.  If you were just to repeatedly merge out, you would be
739                   merging previously merged changes a second time causing a real mess.
740                
741                    Start with new directory and put TaskMakefile above pegasus (needed so you
742                    have this file for the initial operations.  
743                
744                      make -f TaskMakefile branch_merge_out BNAME=PEP317-pullop  ## takes a long time
745                
746                   This checks out current head, merges it into task branch and sets tags
747                   for the mergeout.  Note that at the end of this step this work is
748                   part of the TASK... branch.
749 karl  1.1.2.11 
750                   NOW check for conflicts, errors, etc. that resulted from the merge.
751                   Look for conflict flags, compare the results (I use linux merge as a
752                   good graphic compare tool) and build and test. When you are satisfied
753                   that the merge out is clean, you can commit the results to the TASK...
754                   branch
755                   
756                   To commit the work to  this into Task branch
757                
758                      make -f mak/TaskMakefile branch_merge_out_commit BNAME=PEP317-pullop
759                
760                  or manually commit and finish as follows
761                
762                    cvs commit
763                    make -f mak/TaskMakefile  branch_merge_out_finish BNAME=PEP317-pullop
764                
765                ## This last step is important since it cleans up temporary tags to prepare
766                   you for the next checkout
767                   
768                COMPARE TASKBRANCH WITH HEAD
769                
770 karl  1.1.2.11     In a new pegasus work space do same as above for merge out.
771                
772                    make -f TaskMakefile BNAME=PEP317-pullop
773                
774                    This produces a result which is all of the head merged into the branch.
775                    A diff of this is all the new changes to the head of tree that you will
776                    include into the merge.
777                

No CVS admin address has been configured
Powered by
ViewCVS 0.9.2