HTCondorWiki: Class Ad Conversion Todo

Page History

ClassAd Conversion Todo List

This is the set of tasks that need to be done to convert from old to new ClassAds. Code changes for this ToDo list should be associated with ticket #619.

There are two lists. The first list contains items that can be done without affecting Condor current usage of old ClassAds. This mainly consists of adding compatibility functions to new ClassAds that emulate the API of old ClassAds. The second list contains items that will break Condor's usage of old ClassAds. These are mainly changing callsites for old {ClassAd} methods that can't be easily emulated through a compatibility function. This second list should be performed within a short time period once we're ready to 'pull the trigger' on converting to new ClassAds.

Pre-Flag Day Tasks

Check in Varghese's ClassAdList class that works with new ClassAds. DONE
Add a method to Varghese's new ClassAdList to move an ad from one list to another. DONE
Add or fix compatibility for following old ClassAd methods:
- Block #1 [3 days]:
  - ClassAd::Assign() DONE
  - ClassAd::LookupString(MyString) DONE
  - ClassAd::Insert(const char*) DONE
  - ClassAd::Insert(const char*,ExprTree*) DONE
  - ClassAd::Lookup() DONE
  - ClassAd::put() Theoretically code complete, needs testing.
  - ClassAd::initFromStream() Theoretically code complete, needs testing.
  - ClassAd::AssignExpr() DONE
  - ClassAd::clear() DONE
  - ClassAd::EvalString(const char*, const class AttrList*, char**) INCOMPLETE
  - ClassAd::EvalString(const char*, const class AttrList*, MyString&) INCOMPLETE
  - ClassAd::NextNameOriginal() DONE
  - ClassAd::ResetName() DONE
- Block #2 [4 days]:
  - ClassAd::sPrintExpr() DONE
  - ClassAd::NextExpr() DONE
  - ClassAd::NextDirtyExpr() DONE
  - ClassAd::SetDirtyFlag() DONE, needs callsite changes
  - ClassAd::GetDirtyFlag() DONE, needs callsite changes
  - ClassAd::ClearAllDirtyFlags() DONE
  - ClassAd::GetReferences() INCOMPLETE
  - ClassAd::ChainCollapse() DONE
  - ClassAd::EscapeStringValue() INCOMPLETE, will need callsite changes
  - ClassAd::CopyAttribute() DONE, needs callsite changes
  - ClassAd::fPrintAsXML() DONE
  - ClassAd::sPrintAsXML() DONE
  - ClassAd::IsValidAttrValue() DONE
  - ExprTree::DeepCopy() DONE
Write helper functions for these methods which we can't emulate transparently [4 hours]:
- ExprTree::PrintToNewStr() DONE
- ExprTree::PrintToStr() DONE
- ExprTree::EvalTree() DONE, needs callsite changes
Write compatibility versions of these free-standing functions that are part of old ClassAds:
- int Parse(const char*s, MyString&name, ExprTree*&tree, int*pos = NULL) DONE
- int ParseClassAdRvalExpr(const char*s, ExprTree*&tree, int*pos = NULL) DONE
- const char * ExprTreeToString( ExprTree*expr ) DONE
- bool EvalBool(ClassAd *ad, const char *constraint)
- bool EvalBool(AttrList * ad, ExprTree * tree)
- bool ClassAdsAreSame( ClassAd * ad1, ClassAd * ad2, StringList * ignored_attrs=NULL, bool verbose=false )
- bool IsAMatch(const ClassAd * ad1, const ClassAd * ad2)
- bool IsAHalfMatch(const ClassAd * request, const ClassAd * offer)
Add ClassAds functions that are in old ClassAds but not in new ClassAds [2 days]:
- Note: these are known as FunctionStringlistFOO, and are in condor_ast.cpp
- stringListSize()
- stringListSum()
- stringListAve()
- stringListMin()
- stringListMax()
- stringListMember()
- stringListIMember()
- stringListRegexpMember()

Flag Day Tasks

Change most or all references to ClassAd and AttrList with CompatClassAd [4 hours].
Swap in Varghese's new ClassAdList class [?].
Fix up the one or two callsites in matchmaker.cpp that move an ad from one ClassAdList to another [4 hours].
The following methods will need some fixing at the callsites [5 days]:
- ExprTree::RArg() DONE
- ExprTree::LArg() DONE
- ExprTree::PrintToNewStr() DONE
- ExprTree::EvalTree() DONE
- ClassAd(char*,char) DONE
- ExprTree::PrintToStr() DONE
- ExprTree::MyType()
- ClassAd::ExchangeExpressions() DONE
- ClassAd::unchain() DONE
- ClassAd::RestoreChain() DONE
- AttrList::put()
- AttrList::initFromStream()

Post-Flag Day Tasks

As time permits, rewrite callsites to make CompatClassAd unnecessary. The modified callsites can either use native new ClassAd methods or newly-written free-standing functions.
- Replace all usage of attribute CurrentTime with ClassAd function time(). This can start before the flag day.