5#ifndef LINE_LANG_LQN_LQN_BUILDER_H
6#define LINE_LANG_LQN_LQN_BUILDER_H
55 p.mult = sched == SchedStrategy::INF ? std::numeric_limits<double>::infinity() : mult;
56 m_.procs.push_back(p);
57 return m_.procs.size() - 1;
62 const std::string& on_processor,
double repl = 1.0) {
67 t.mult = sched == SchedStrategy::INF ? std::numeric_limits<double>::infinity() : mult;
69 t.proc_slot = find_proc(on_processor);
70 m_.tasks.push_back(t);
71 return m_.tasks.size() - 1;
83 m_.tasks[find_task(task_name)].thinktime = d;
95 const std::string& on_processor, std::size_t nitems,
99 throw InputError(
"LqnBuilder::cache_task: '" + name +
"' caches no item");
101 throw InputError(
"LqnBuilder::cache_task: '" + name +
"' has no cache list");
103 for (std::size_t i = 0; i < itemcap.size(); ++i) total += itemcap[i];
104 if (total <= 0 ||
static_cast<std::size_t
>(total) >= nitems)
105 throw InputError(
"LqnBuilder::cache_task: '" + name +
106 "' has a total capacity that is not between 1 and nitems-1; "
107 "a cache that holds every item never misses");
108 const std::size_t t =
task(name, mult, sched, on_processor, repl);
109 m_.tasks[t].nitems = nitems;
110 m_.tasks[t].itemcap = itemcap;
111 m_.tasks[t].replacestrat = replacestrat;
127 throw InputError(
"LqnBuilder::setup_time: '" + task_name +
"' has no setup time");
130 "LqnBuilder::setup_time: '" + task_name +
131 "' has a setup time but no delay-off time; a server that never shuts down pays "
132 "the setup at most once and the reference declines to model it");
133 detail::RawTask<T>& t = m_.tasks[find_task(task_name)];
135 t.delayofftime = delayoff;
145 std::size_t
item_entry(
const std::string& name,
const std::string& on_task,
146 std::size_t cardinality,
const std::vector<T>& popularity) {
147 if (cardinality == 0)
148 throw InputError(
"LqnBuilder::item_entry: '" + name +
"' indexes no item");
149 if (popularity.size() != cardinality)
150 throw InputError(
"LqnBuilder::item_entry: '" + name +
151 "' needs one popularity per item");
152 const std::size_t e =
entry(name, on_task);
153 m_.entries[e].cardinality = cardinality;
154 m_.entries[e].popularity = popularity;
159 std::size_t
entry(
const std::string& name,
const std::string& on_task) {
160 detail::RawEntry<T> e;
162 e.task_slot = find_task(on_task);
163 m_.entries.push_back(e);
164 return m_.entries.size() - 1;
169 detail::RawEntry<T>& e = m_.entries[find_entry(entry_name)];
170 e.has_arrival =
true;
176 const std::string& on_task) {
177 detail::RawActivity<T> a;
181 a.task_slot = find_task(on_task);
183 m_.acts.push_back(a);
184 return m_.acts.size() - 1;
188 void bound_to(
const std::string& act,
const std::string& entry_name) {
189 m_.acts[find_act(act)].bound_to_entry = entry_name;
193 void sync_call(
const std::string& act,
const std::string& dest_entry,
const T& mean) {
194 m_.acts[find_act(act)].sync_calls.push_back({dest_entry, mean});
198 void async_call(
const std::string& act,
const std::string& dest_entry,
const T& mean) {
199 m_.acts[find_act(act)].async_calls.push_back({dest_entry, mean});
212 const std::vector<std::string>& dest_entries,
const T& mean) {
214 "sync_call_round_robin");
218 void sync_call_jsq(
const std::string& act,
const std::vector<std::string>& dest_entries,
230 void forward(
const std::string& src_entry,
const std::string& dest_entry,
const T& prob) {
231 detail::RawEntry<T>& e = m_.entries[find_entry(src_entry)];
232 e.fwd_dest.push_back(dest_entry);
233 e.fwd_prob.push_back(prob);
237 void replies_to(
const std::string& act,
const std::string& entry_name) {
238 m_.entries[find_entry(entry_name)].reply_activities.push_back(act);
243 m_.acts[find_act(act)].thinktime = d;
249 void serial(
const std::string& pre,
const std::string& post) {
250 detail::RawPrecedence<T> p;
251 p.pretype = PrecedenceType::PRE_SEQ;
252 p.posttype = PrecedenceType::POST_SEQ;
253 p.preacts.push_back(pre);
254 p.postacts.push_back(post);
259 void and_fork(
const std::string& pre,
const std::vector<std::string>& posts) {
260 detail::RawPrecedence<T> p;
261 p.pretype = PrecedenceType::PRE_SEQ;
262 p.posttype = PrecedenceType::POST_AND;
263 p.preacts.push_back(pre);
269 void and_join(
const std::vector<std::string>& pres,
const std::string& post,
270 std::size_t quorum = 0) {
271 detail::RawPrecedence<T> p;
272 p.pretype = PrecedenceType::PRE_AND;
273 p.posttype = PrecedenceType::POST_SEQ;
275 p.postacts.push_back(post);
280 add_prec(pres.at(0), p);
284 void or_fork(
const std::string& pre,
const std::vector<std::string>& posts,
285 const std::vector<T>& probs) {
286 if (posts.size() != probs.size())
287 throw InputError(
"LqnBuilder::or_fork: one probability per branch is required");
288 detail::RawPrecedence<T> p;
289 p.pretype = PrecedenceType::PRE_SEQ;
290 p.posttype = PrecedenceType::POST_OR;
291 p.preacts.push_back(pre);
293 p.postparams = probs;
304 void cache_access(
const std::string& pre,
const std::string& hit,
const std::string& miss) {
305 detail::RawPrecedence<T> p;
306 p.pretype = PrecedenceType::PRE_SEQ;
307 p.posttype = PrecedenceType::POST_CACHE;
308 p.preacts.push_back(pre);
309 p.postacts.push_back(hit);
310 p.postacts.push_back(miss);
315 void or_join(
const std::vector<std::string>& pres,
const std::string& post) {
316 detail::RawPrecedence<T> p;
317 p.pretype = PrecedenceType::PRE_OR;
318 p.posttype = PrecedenceType::POST_SEQ;
320 p.postacts.push_back(post);
323 add_prec(pres.at(0), p);
333 void loop(
const std::string& pre,
const std::vector<std::string>& body,
334 const std::string& end,
const T& count) {
335 detail::RawPrecedence<T> p;
336 p.pretype = PrecedenceType::PRE_SEQ;
337 p.posttype = PrecedenceType::POST_LOOP;
338 p.preacts.push_back(pre);
340 p.postacts.push_back(end);
341 p.postparams.assign(body.size(), count);
355 void add_constraint(
const std::string& elem,
const std::vector<std::string>& operands,
356 const std::vector<T>& coeffs,
const T& cap) {
357 if (operands.size() != coeffs.size())
358 throw InputError(
"LqnBuilder::add_constraint: one coefficient per operand is required");
359 if (operands.empty())
360 throw InputError(
"LqnBuilder::add_constraint: the constraint names no operand");
361 for (std::size_t i = 0; i < operands.size(); ++i)
362 for (std::size_t j = i + 1; j < operands.size(); ++j)
363 if (operands[i] == operands[j])
364 throw InputError(
"LqnBuilder::add_constraint: operand '" + operands[i] +
366 detail::RawLinConRow<T> row;
367 row.names = operands;
370 linconrows_of(elem).push_back(row);
380 if (A.
rows() != b.size())
381 throw InputError(
"LqnBuilder::set_constraint: A and b disagree on the number of rows");
382 for (std::size_t i = 0; i < m_.tasks.size(); ++i)
383 if (m_.tasks[i].name == elem) {
384 m_.tasks[i].lincon_A = A;
385 m_.tasks[i].lincon_b = b;
388 for (std::size_t i = 0; i < m_.procs.size(); ++i)
389 if (m_.procs[i].name == elem) {
390 m_.proc_lincon[i] = std::make_pair(A, b);
393 throw InputError(
"LqnBuilder::set_constraint: unknown task or processor '" + elem +
"'");
401 assert_rate_dependent(elem,
"Load");
403 throw InputError(
"LqnBuilder::set_load_dependence: alpha is empty");
405 m_.tasks[find_task(elem)].lldscaling = alpha;
407 m_.proc_lldscaling[find_proc(elem)] = alpha;
417 const std::vector<T>& peak) {
418 assert_rate_dependent(elem,
"Class");
419 assert_dependence_handle(beta, peak,
"Class");
421 const std::size_t t = find_task(elem);
422 m_.tasks[t].cdscaling = beta;
423 m_.tasks[t].cdscalingpeak = peak;
425 const std::size_t p = find_proc(elem);
426 m_.proc_cdscaling[p] = beta;
427 m_.proc_cdscalingpeak[p] = peak;
436 const std::vector<T>& peak) {
437 assert_rate_dependent(elem,
"Joint");
438 assert_dependence_handle(eta, peak,
"Joint");
439 assert_no_pools(elem,
"a joint dependence");
441 const std::size_t t = find_task(elem);
442 m_.tasks[t].jdscaling = eta;
443 m_.tasks[t].jdscalingpeak = peak;
445 const std::size_t p = find_proc(elem);
446 m_.proc_jdscaling[p] = eta;
447 m_.proc_jdscalingpeak[p] = peak;
462 const std::vector<std::string>& compatible,
const T& rate) {
463 assert_rate_dependent(elem,
"Compatibility");
466 throw InputError(
"LqnBuilder::add_server_type: pool '" + pool +
467 "' must hold at least one server");
468 if (compatible.empty())
469 throw InputError(
"LqnBuilder::add_server_type: pool '" + pool +
470 "' is compatible with no operand, so it can never serve");
471 detail::RawServerPool<T> sp;
475 sp.compatible = compatible;
476 raw_pools_of(elem).push_back(sp);
487 std::size_t find_proc(
const std::string& n)
const {
488 for (std::size_t i = 0; i < m_.
procs.size(); ++i)
489 if (m_.
procs[i].name == n)
return i;
490 throw InputError(
"LqnBuilder: unknown processor '" + n +
"'");
492 std::size_t find_task(
const std::string& n)
const {
493 for (std::size_t i = 0; i < m_.
tasks.size(); ++i)
494 if (m_.
tasks[i].name == n)
return i;
495 throw InputError(
"LqnBuilder: unknown task '" + n +
"'");
497 std::size_t find_entry(
const std::string& n)
const {
498 for (std::size_t i = 0; i < m_.
entries.size(); ++i)
499 if (m_.
entries[i].name == n)
return i;
500 throw InputError(
"LqnBuilder: unknown entry '" + n +
"'");
502 std::size_t find_act(
const std::string& n)
const {
503 for (std::size_t i = 0; i < m_.acts.size(); ++i)
504 if (m_.acts[i].name == n)
return i;
505 throw InputError(
"LqnBuilder: unknown activity '" + n +
"'");
508 std::vector<detail::RawLinConRow<T>>& linconrows_of(
const std::string& n) {
509 for (std::size_t i = 0; i < m_.tasks.size(); ++i)
510 if (m_.tasks[i].name == n)
return m_.tasks[i].linconrows;
511 for (std::size_t i = 0; i < m_.procs.size(); ++i)
512 if (m_.procs[i].name == n)
return m_.proc_linconrows[i];
513 throw InputError(
"LqnBuilder: unknown task or processor '" + n +
"'");
516 bool is_task(
const std::string& n)
const {
517 for (std::size_t i = 0; i < m_.tasks.size(); ++i)
518 if (m_.tasks[i].name == n)
return true;
523 std::vector<detail::RawServerPool<T>>& raw_pools_of(
const std::string& n) {
524 for (std::size_t i = 0; i < m_.tasks.size(); ++i)
525 if (m_.tasks[i].name == n)
return m_.tasks[i].pools;
526 for (std::size_t i = 0; i < m_.procs.size(); ++i)
527 if (m_.procs[i].name == n)
return m_.proc_pools[i];
528 throw InputError(
"LqnBuilder: unknown task or processor '" + n +
"'");
535 void assert_rate_dependent(
const std::string& elem,
const char* what)
const {
538 for (std::size_t i = 0; i < m_.tasks.size() && !found; ++i)
539 if (m_.tasks[i].name == elem) {
540 sched = m_.tasks[i].sched;
543 for (std::size_t i = 0; i < m_.procs.size() && !found; ++i)
544 if (m_.procs[i].name == elem) {
545 sched = m_.procs[i].sched;
550 "-dependence can only be set on a Task or a Host, which are the only "
551 "elements that become server stations in a layer; '" +
552 elem +
"' is neither");
553 if (sched != SchedStrategy::PS && sched != SchedStrategy::FCFS)
555 "-dependence supported only for processor sharing (PS) and "
556 "first-come first-serve (FCFS) servers, but '" +
557 elem +
"' is scheduled otherwise");
561 void assert_dependence_handle(
const CdScaling<T>& f,
const std::vector<T>& peak,
562 const char* what)
const {
564 throw InputError(std::string(what) +
"-dependence needs a handle");
567 "-dependence needs a peak rate per operand, which normalizes "
568 "utilization as U = T*S/peak");
572 void assert_no_pools(
const std::string& elem,
const char* what) {
573 if (!raw_pools_of(elem).empty())
574 throw InputError(
"LqnBuilder: '" + elem +
"' already declares server pools, which are "
575 "themselves a rate law, so it cannot also take " + what);
578 void assert_no_jd(
const std::string& elem) {
580 for (std::size_t i = 0; i < m_.tasks.size(); ++i)
581 if (m_.tasks[i].name == elem && m_.tasks[i].jdscaling) has =
true;
582 for (std::size_t i = 0; i < m_.procs.size(); ++i)
583 if (m_.procs[i].name == elem && m_.proc_jdscaling.count(i)) has =
true;
585 throw InputError(
"LqnBuilder: '" + elem +
"' already declares a joint dependence, so "
586 "it cannot also declare server pools, which are a rate law of their "
591 void add_prec(
const std::string& anchor_act,
const detail::RawPrecedence<T>& p) {
592 m_.tasks[m_.acts[find_act(anchor_act)].task_slot].precedences.push_back(p);
601 void add_call_group(
const std::string& act,
const std::vector<std::string>& dest_entries,
603 if (dest_entries.size() < 2)
604 throw InputError(std::string(
"LqnBuilder::") + who +
605 " needs at least two target entries: a group of one is not a "
606 "dispatch decision");
607 const T share = T(mean / num_traits<T>::from_int(
int(dest_entries.size())));
608 for (
const std::string& d : dest_entries)
sync_call(act, d, share);
609 m_.acts[find_act(act)].call_groups.push_back(std::make_pair(rs, dest_entries));
void sync_call_jsq(const std::string &act, const std::vector< std::string > &dest_entries, const T &mean)
As above, with the least loaded target taking the call (synchCallJSQ).
void bound_to(const std::string &act, const std::string &entry_name)
Bind an activity to an entry: it is the entry's first activity.
std::size_t activity(const std::string &name, const Distrib< T > &hostdem, const std::string &on_task)
Add an activity on a task, with its host demand.
LqnStruct< T > build() const
Flatten into the struct SolverLN consumes.
void act_think_time(const std::string &act, const Distrib< T > &d)
An activity think time, in series with the host demand.
void loop(const std::string &pre, const std::vector< std::string > &body, const std::string &end, const T &count)
pre -> body, repeated count times in expectation, then -> end.
void open_arrival(const std::string &entry_name, const Distrib< T > &d)
An open arrival stream at an entry.
void setup_time(const std::string &task_name, const Distrib< T > &setup, const Distrib< T > &delayoff)
A SetupTask: a server that powers down when idle and pays to restart.
std::size_t processor(const std::string &name, double mult, SchedStrategy sched, double repl=1.0)
Add a processor.
void set_joint_dependence(const std::string &elem, const CdScaling< T > &eta, const std::vector< T > &peak)
elem.setJointDependence(eta, peak): the non-product-form handle, read at the whole per-operand vector...
void replies_to(const std::string &act, const std::string &entry_name)
Mark an activity as the one that replies to an entry.
void forward(const std::string &src_entry, const std::string &dest_entry, const T &prob)
Forwarding: whenever src_entry is invoked, with probability prob the request is handed onward to dest...
void and_fork(const std::string &pre, const std::vector< std::string > &posts)
pre -> every post, concurrently.
void cache_access(const std::string &pre, const std::string &hit, const std::string &miss)
ActivityPrecedence.CacheAccess(pre, {hit, miss}).
std::size_t cache_task(const std::string &name, double mult, SchedStrategy sched, const std::string &on_processor, std::size_t nitems, const std::vector< int > &itemcap, ReplacementStrategy replacestrat, double repl=1.0)
A CacheTask: a task whose entries are looked up in a cache of nitems.
void set_constraint(const std::string &elem, const Matrix< T > &A, const std::vector< T > &b)
The positional form, elem.setConstraint(A, b).
void add_constraint(const std::string &elem, const std::vector< std::string > &operands, const std::vector< T > &coeffs, const T &cap)
elem.addConstraint(operands, coeffs, cap): sum(coeffs .
void async_call(const std::string &act, const std::string &dest_entry, const T &mean)
An asynchronous call from an activity to an entry of another task.
void and_join(const std::vector< std::string > &pres, const std::string &post, std::size_t quorum=0)
all pres (or quorum of them) -> post.
void serial(const std::string &pre, const std::string &post)
pre -> post, a plain sequence.
void sync_call(const std::string &act, const std::string &dest_entry, const T &mean)
A synchronous call from an activity to an entry of another task.
void set_class_dependence(const std::string &elem, const CdScaling< T > &beta, const std::vector< T > &peak)
elem.setClassDependence(beta, peak): the product-form handle, whose argument is the per-OPERAND popul...
void think_time(const std::string &task_name, const Distrib< T > &d)
Set a task's think time.
const LqnModel< T > & model() const
void sync_call_round_robin(const std::string &act, const std::vector< std::string > &dest_entries, const T &mean)
ONE synchronous call per invocation, its destination CYCLING over the targets in the order given (syn...
void add_server_type(const std::string &elem, const std::string &pool, double count, const std::vector< std::string > &compatible, const T &rate)
elem.addServerType(ServerType(pool, count, compatible)): one pool of COUNT identical servers,...
void or_fork(const std::string &pre, const std::vector< std::string > &posts, const std::vector< T > &probs)
pre -> one of the posts, with the given branch probabilities.
void set_load_dependence(const std::string &elem, const std::vector< T > &alpha)
elem.setLoadDependence(alpha): alpha(n) scales the rate of the layer station of ELEM when it holds n ...
void or_join(const std::vector< std::string > &pres, const std::string &post)
any of the pres -> post.
std::size_t item_entry(const std::string &name, const std::string &on_task, std::size_t cardinality, const std::vector< T > &popularity)
An ItemEntry: the entry a cache read enters, over cardinality items.
std::size_t entry(const std::string &name, const std::string &on_task)
Add an entry on a task.
std::size_t task(const std::string &name, double mult, SchedStrategy sched, const std::string &on_processor, double repl=1.0)
Add a task on a processor.
The exception types the port throws.
.lqnx -> LqnStruct, a port of matlab/src/lang/layered/@LayeredNetwork/parseXML.m followed by ....
SchedStrategy
Scheduling disciplines, with the values of MATLAB SchedStrategy.
RoutingStrategy
Routing strategies, with the values of MATLAB RoutingStrategy.
std::function< std::vector< T >(const std::vector< T > &)> CdScaling
A class-dependent scaling map, sn.cdscaling.
ReplacementStrategy
Cache replacement policies, with the values of MATLAB ReplacementStrategy.
LqnStruct< T > lqn_finalize(const LqnModel< T > &m)
Port of @LayeredNetwork/getStruct.m: flatten the model into its struct.
static Distrib immediate()
The Immediate singleton.
The intermediate model, and the second stage that flattens it.
std::vector< detail::RawTask< T > > tasks
std::vector< detail::RawProc > procs
std::vector< detail::RawEntry< T > > entries