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

No CVS admin address has been configured
Powered by
ViewCVS 0.9.2