/***************************************************************
 *
 * Copyright (C) 2014-2015, Condor Team, Computer Sciences Department,
 * University of Wisconsin-Madison, WI.
 * 
 * Licensed under the Apache License, Version 2.0 (the "License"); you
 * may not use this file except in compliance with the License.  You may
 * obtain a copy of the License at
 * 
 *    http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 ***************************************************************/

#ifndef __EXPR_ANALYZE_H__
#define __EXPR_ANALYZE_H__


enum {
	detail_smart_unparse_expr    = 0x01, // show unparsed expressions at analyze step when needed
	detail_always_unparse_expr   = 0x02, // always show unparsed expressions at each analyze step
	detail_show_all_subexprs     = 0x04, // show all sub expressions, with prefixes for pruned subs
	detail_show_ifthenelse       = 0x08, // show sub expressions of ifthenelse functions

	detail_diagnostic            = 0x40, // show steps of expression analysis to stdout
	detail_dump_intermediates    = 0x80, // dump intermediate work buffers to stdout. (verbose diagnostic)

	detail_analyze_each_sub_expr = 0x100, // analyze each sub expression, not just the top level ones.
	detail_always_analyze_req    = 0x200, // always analyze requirements, (better analize does this)
	detail_dont_show_job_attrs   = 0x400, // suppress display of job attributes in verbose analyze
	detail_inline_std_slot_exprs = 0x800, // inline WithinResourceLimits and IsValidCheckpointPlatform in addition to START
	detail_suppress_tall_heading = 0x1000, // suppress 2-tall headings e.g "Jobs\nMatched"
	detail_append_to_buf         = 0x2000, // don't clear the buffer before writing analysis.

	detail_better                = 0x10000, // -better rather than  -analyze was specified.
};

// the match descriminator allows matches to be categorized and
// reported as multiple columns
class AnalysisMatchDescriminator {
public:
	virtual int column_width() = 0;
	virtual const char * header1(std::string & buf, const char * target) = 0;
	virtual const char * header2(std::string & buf) = 0;
	virtual const char * bar(std::string & buf) = 0;
	virtual void clear(int ary[2], ClassAd *ad) = 0;
	virtual int add(int ary[2], ClassAd* ad) = 0;
	virtual int count(int ary[2]) = 0;
	virtual const char * print(std::string & buf, int ary[2]) = 0;
	virtual const char * print(std::string & buf, const char * val) = 0;
};

// a default match descriminator that uses only the first match counter slot
class DefaultAnalysisMatchDescriminator : public AnalysisMatchDescriminator {
public:
	virtual int column_width() { return 9; }
	virtual const char * header1(std::string & buf, const char * target) { formatstr(buf,"%5ss",target); return buf.c_str(); }
	virtual const char * header2(std::string & /*buf*/) { return " Matched "; }
	virtual const char * bar(std::string & /*buf*/) { return "---------"; }
	virtual void clear(int ary[2], ClassAd * /*ad*/) { ary[0] = 0; }
	virtual int add(int ary[2], ClassAd* /*ad*/) { ary[0] += 1; return ary[0]; }
	virtual int count(int ary[2]) { return ary[0]; }
	virtual const char * print(std::string & buf, int ary[2]) { formatstr(buf,"%9d",ary[0]); return buf.c_str(); }
	virtual const char * print(std::string & buf, const char * val) { formatstr(buf,"%9s", val); return buf.c_str(); }
};

typedef struct {
	int console_width;
	int detail_mask; // one or more of above detail_* flags
	const char * expr_label;
	const char * request_type_name;
	const char * target_type_name;
	AnalysisMatchDescriminator * match_descrim;
} anaFormattingOptions;

// This is the function you probably want to call.  
// It does match analysis of all of the clauses in the given attribute of the request ad
// against all of the target ads and appends the analysis to the given return_buf.
// typical use would be
//    AnalyzeRequirementsForEachTarget(jobAd, ATTR_REQUIREMENTS, attrs, &startdAds[0], startdAds.size(), ...
// or
//    ClassAd::References attrs; attrs.insert(ATTR_START);
//    AnalyzeRequirementsForEachTarget(slotClassAd, ATTR_REQUIREMENTS, attrs, &jobAds[0], jobAds.size(), ...
//
void AnalyzeRequirementsForEachTarget(
	ClassAd *request,
	const char * attrConstraint, // must be an attribute in the request ad
	classad::References & inline_attrs, // expand these attrs inline
	std::vector<ClassAd*> targets,
	std::string & return_buf,
	const anaFormattingOptions & fmt);

const char * PrettyPrintExprTree(classad::ExprTree *tree, std::string & temp_buffer, int indent, int width);

const char * PrintNumberedExprTreeClauses(
	std::string & out,
	ClassAd* ad, const char * attrRequirements,
	classad::References & inline_attrs,
	anaFormattingOptions & fmt);

class AnalSubExpr;
int AnalyzeThisSubExpr(
	ClassAd *myad,
	classad::ExprTree* expr,
	const classad::References * inline_attrs, // expand attrs with these names inline
	std::vector<AnalSubExpr> & clauses, // out: clauses are appended to this list as analysis proceeds.
	bool & varres, bool must_store,
	int depth,
	const anaFormattingOptions & fmt);

void AddReferencedAttribsToBuffer(
	ClassAd * request,
	const char * expr_string, // expression string or attribute name
	classad::References & hidden_refs, // don't print these even if they appear in the trefs list
	classad::References & trefs, // out, returns target refs
	bool raw_values, // unparse referenced values if true, print evaluated referenced values if false
	const char * pindent,
	std::string & return_buf);

class QuantizingAccumulator {
public:
	QuantizingAccumulator(int val, int num) : accum(val), quantized(val), allocs(num) {}
	QuantizingAccumulator& operator+=(size_t val) { Add(val); return *this; }
	QuantizingAccumulator& operator+=(int val) { Add(val); return *this; }
	size_t Value(size_t * pquan=NULL, size_t * pcount=NULL) {
		if (pquan) *pquan = quantized;
		if (pcount) *pcount = allocs;
		return accum;
	}
private:
	void Add(size_t val) { 
		accum += val; 
	#ifdef WIN32
		// from expermentation with vs2012 (32 bit), memory allocation does NOT return consecutive allocations
		// but the smallest obserable difference shows that the allocator adds 8 and then quantizes by 8
		quantized += 8 + ((val + 7) & ~7);
	#else
		// from http://web.eecs.utk.edu/~huangj/cs360/360/notes/Malloc1/lecture.html
		// linux malloc adds 8 then quantizes to 8 bytes
		quantized += 8 + ((val + 7) & ~7);
	#endif
		++allocs;
	}
	size_t accum;
	size_t quantized;
	size_t allocs;
};

// returns count of characters added to return_buf
int AddTargetAttribsToBuffer(
	classad::References & trefs, // in, target refs (probably returned by AddReferencedAttribsToBuffer)
	ClassAd * request,
	ClassAd * target,
	bool raw_values, // unparse referenced values if true, print evaluated referenced values if false
	const char * pindent,
	std::string & return_buf,
	std::string & target_name); // returns the name of the target classad i.e. Job 23.0 or Slot1@host

// this functions walk the given classad data structure and determines the memory consumed into
// the given QuantizingAccumulator. The effects of classad caching/compression are ignored by these functions.
// the return value is the same as accum.Value().
size_t AddExprTreeMemoryUse (const classad::ExprTree* tree, QuantizingAccumulator & accum, int & num_skipped);
size_t AddClassadMemoryUse (const classad::ClassAd* cad, QuantizingAccumulator & accum, int & num_skipped);
size_t AddClassadMemoryUse (const classad::ExprList* list, QuantizingAccumulator & accum, int & num_skipped);


#endif//__EXPR_ANALYZE_H__
