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

No CVS admin address has been configured
Powered by
ViewCVS 0.9.2