1 /**************************************************************************/
2 /* ---------------------------------------------------------------------- */
3 /* Copyright (C) 2006 - 2008 FRESCOR consortium partners: */
5 /* Universidad de Cantabria, SPAIN */
6 /* University of York, UK */
7 /* Scuola Superiore Sant'Anna, ITALY */
8 /* Kaiserslautern University, GERMANY */
9 /* Univ. Politécnica Valencia, SPAIN */
10 /* Czech Technical University in Prague, CZECH REPUBLIC */
12 /* Thales Communication S.A. FRANCE */
13 /* Visual Tools S.A. SPAIN */
14 /* Rapita Systems Ltd UK */
17 /* See http://www.frescor.org for a link to partners' websites */
19 /* FRESCOR project (FP6/2005/IST/5-034026) is funded */
20 /* in part by the European Union Sixth Framework Programme */
21 /* The European Union is not liable of any use that may be */
22 /* made of this code. */
25 /* This file is part of FRSH (FRescor ScHeduler) */
27 /* FRSH is free software; you can redistribute it and/or modify it */
28 /* under terms of the GNU General Public License as published by the */
29 /* Free Software Foundation; either version 2, or (at your option) any */
30 /* later version. FRSH is distributed in the hope that it will be */
31 /* useful, but WITHOUT ANY WARRANTY; without even the implied warranty */
32 /* of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU */
33 /* General Public License for more details. You should have received a */
34 /* copy of the GNU General Public License along with FRSH; see file */
35 /* COPYING. If not, write to the Free Software Foundation, 675 Mass Ave, */
36 /* Cambridge, MA 02139, USA. */
38 /* As a special exception, including FRSH header files in a file, */
39 /* instantiating FRSH generics or templates, or linking other files */
40 /* with FRSH objects to produce an executable application, does not */
41 /* by itself cause the resulting executable application to be covered */
42 /* by the GNU General Public License. This exception does not */
43 /* however invalidate any other reasons why the executable file might be */
44 /* covered by the GNU Public License. */
45 /**************************************************************************/
49 * @author Michal Sojka <sojkam1@fel.cvut.cz>
50 * @date Mon Oct 20 18:00:18 2008
52 * @brief FRESCOR Contract Broker
56 #define WITH_C99 /* For ul_gsa.h iterators */
57 #include <semaphore.h>
60 #include <forb/config.h>
62 #include <fcb_contact_info.h>
66 #include <ul_gavlcust.h>
67 #include <ul_gsacust.h>
70 #include <ul_logreg.h>
71 #include <forb/server_id.h>
72 #include <fres_contract.h>
73 #include "fcb_config.h"
74 #include <fosa_clocks_and_timers.h>
75 #include "contract_log.h"
76 #if CONFIG_FCB_INET && !CONFIG_FORB_PROTO_INET_DEFAULT
77 #include <forb/proto_inet.h>
80 #define COMPILE_TIME_ASSERT(cond, msg) \
81 typedef char msg[(cond) ? 1 : -1]
84 UL_LOG_CUST(ulogd_fcb);
85 ul_log_domain_t ulogd_fcb = {UL_LOGL_MSG, "main"};
86 UL_LOGREG_SINGLE_DOMAIN_INIT_FUNCTION(init_ulogd_fcb, ulogd_fcb);
88 bool opt_daemon = false;
89 char *opt_pidfile = NULL;
90 fosa_abs_time_t start_time;
92 /** List of contracts to be newly reserved or changed by resource manager */
93 struct reservation_list {
94 ul_list_head_t fcb_contracts;
99 * Resource identification
102 frsh_resource_type_t type;
103 frsh_resource_id_t id;
107 * Registered resource
113 fres_resource_manager mng; /**< Object reference of the resource manager */
114 gavl_cust_root_field_t allocators; /**< Registered allocators for this resource (from multiple applications/nodes) */
115 ul_list_head_t sc_contracts; /**< Negotiated contracts with spare capacity for this resource */
116 struct reservation_list rl; /**< Temporary list of contracts to be reserved on this resource */
120 * Resource allocator registered in different nodes/applications
125 fres_resource_allocator ra;
128 struct fcb_transaction;
130 struct fcb_contract {
131 fres_contract_id_t id;
132 struct res_alloc *ra; /**< Allocator for this contract TODO: Remove contract if allocator is destroyed */
133 gavl_node_t node_fcb;
134 ul_list_node_t node_sc;
135 ul_list_node_t node_reservation;
136 struct fcb_transaction *transaction;
141 fosa_abs_time_t end_of_stability_period;
142 struct fres_contract *user_contract; /* The contract sent by user. Set after sucessfull neotiation. */
143 struct fres_contract *requested_contract; /* User request for the contract. Set by prepare_reservation_requests() in the beginning of negotiation. */
144 struct fres_contract *to_be_reserved_contract;
145 struct fres_contract *schedulable_contract;
148 struct fcb_transaction {
151 gsa_array_field_t contracts;
155 * Contract broker data
158 fres_contract_id_t contract_counter;
159 gavl_cust_root_field_t resources; /**< Registered resources */
160 gavl_cust_root_field_t contracts; /**< Contracts negotiated by this FCB */
161 gavl_cust_root_field_t transactions; /**< Transactions negotiated by this FCB */
164 struct fcb_contract *fcb_contract_new(fres_contract_id_t *id)
166 struct fcb_contract *fcb_contract;
168 fcb_contract = malloc(sizeof(*fcb_contract));
172 memset(fcb_contract, 0, sizeof(*fcb_contract));
173 fcb_contract->id = *id;
178 void fcb_contract_destroy(struct fcb_contract *fcb_contract)
180 if (fcb_contract->user_contract) {
181 fres_contract_destroy(fcb_contract->user_contract);
183 if (fcb_contract->to_be_reserved_contract) {
184 fres_contract_destroy(fcb_contract->to_be_reserved_contract);
186 if (fcb_contract->requested_contract) {
187 fres_contract_destroy(fcb_contract->requested_contract);
189 if (fcb_contract->schedulable_contract) {
190 fres_contract_destroy(fcb_contract->requested_contract);
196 unsorted(const void *a, const void *b)
199 /* Unordered dynamic array of contracts in transaction */
200 GSA_CUST_DEC(tran_contract /* cust_prefix */,
201 struct fcb_transaction /* cust_array_t */,
202 struct fcb_contract/* cust_item_t */,
203 fres_contract_id_t /* cust_key_t */,
204 contracts /* cust_array_field */,
205 id /* cust_item_key */,
206 unsorted /* cust_cmp_fnc */);
208 GSA_CUST_IMP(tran_contract /* cust_prefix */,
209 struct fcb_transaction /* cust_array_t */,
210 struct fcb_contract/* cust_item_t */,
211 fres_contract_id_t /* cust_key_t */,
212 contracts /* cust_array_field */,
213 id /* cust_item_key */,
214 unsorted /* cust_cmp_fnc */,
215 true /* cust_ins_fl */);
217 struct fcb_transaction *fcb_transaction_new(char *name)
219 struct fcb_transaction *fcb_transaction;
221 fcb_transaction = malloc(sizeof(*fcb_transaction));
222 if (!fcb_transaction) {
225 memset(fcb_transaction, 0, sizeof(*fcb_transaction));
226 fcb_transaction->name = strdup(name);
228 tran_contract_init_array_field(fcb_transaction);
230 return fcb_transaction;
233 void fcb_transaction_destroy(struct fcb_transaction *fcb_transaction)
235 free(fcb_transaction->name);
236 free(fcb_transaction);
239 static inline int res_key_cmp(const struct res_key *a,
240 const struct res_key *b)
242 if (a->type < b->type) {
244 } else if (a->type > b->type) {
246 } else if (a->id < b->id) {
248 } else if (a->id > b->id) {
255 /* Container for registered resources */
256 GAVL_CUST_NODE_INT_DEC(fcb_resource /* cust_prefix */, \
257 struct fcb /* cust_root_t */, \
258 struct resource/* cust_item_t */, \
259 struct res_key /* cust_key_t */, \
260 resources /* cust_root_node */, \
261 node /* cust_item_node */, \
262 key /* cust_item_key */, \
263 res_key_cmp /* cust_cmp_fnc */);
265 GAVL_CUST_NODE_INT_IMP(fcb_resource /* cust_prefix */, \
266 struct fcb /* cust_root_t */, \
267 struct resource/* cust_item_t */, \
268 struct res_key /* cust_key_t */, \
269 resources /* cust_root_node */, \
270 node /* cust_item_node */, \
271 key /* cust_item_key */, \
272 res_key_cmp /* cust_cmp_fnc */);
274 /* Container for allocators registered for a given resource */
275 GAVL_CUST_NODE_INT_DEC(fcb_alloc /* cust_prefix */, \
276 struct resource /* cust_root_t */, \
277 struct res_alloc /* cust_item_t */, \
278 forb_server_id /* cust_key_t */, \
279 allocators /* cust_root_node */, \
280 node /* cust_item_node */, \
281 app /* cust_item_key */, \
282 fres_contract_id_cmp /* cust_cmp_fnc */);
284 GAVL_CUST_NODE_INT_IMP(fcb_alloc /* cust_prefix */, \
285 struct resource /* cust_root_t */, \
286 struct res_alloc /* cust_item_t */, \
287 forb_server_id /* cust_key_t */, \
288 allocators /* cust_root_node */, \
289 node /* cust_item_node */, \
290 app /* cust_item_key */, \
291 forb_server_id_cmp /* cust_cmp_fnc */);
293 /* Container for contracts with spare capacity negotiated for a given resource */
294 UL_LIST_CUST_DEC(sc_contracts /* cust_prefix */, \
295 struct resource /* cust_head_t */, \
296 struct fcb_contract /* cust_item_t */, \
297 sc_contracts /* cust_head_field */, \
298 node_sc /* cust_node_field */);
300 UL_LIST_CUST_DEC(reservation_list /* cust_prefix */, \
301 struct reservation_list /* cust_head_t */, \
302 struct fcb_contract /* cust_item_t */, \
303 fcb_contracts /* cust_head_field */, \
304 node_reservation /* cust_node_field */);
306 /* Container for negotiated contracts */
307 GAVL_CUST_NODE_INT_DEC(fcb_contract /* cust_prefix */, \
308 struct fcb /* cust_root_t */, \
309 struct fcb_contract /* cust_item_t */, \
310 fres_contract_id_t /* cust_key_t */, \
311 contracts /* cust_root_node */, \
312 node_fcb /* cust_item_node */, \
313 id /* cust_item_key */, \
314 fres_contract_id_cmp /* cust_cmp_fnc */);
317 GAVL_CUST_NODE_INT_IMP(fcb_contract /* cust_prefix */, \
318 struct fcb /* cust_root_t */, \
319 struct fcb_contract /* cust_item_t */, \
320 fres_contract_id_t /* cust_key_t */, \
321 contracts /* cust_root_node */, \
322 node_fcb /* cust_item_node */, \
323 id /* cust_item_key */, \
324 fres_contract_id_cmp /* cust_cmp_fnc */);
326 #include "fcb_contract_gavl.inc"
330 fcb_transaction_cmp(char * const *a, char * const *b)
331 { return strcmp(*a, *b); }
333 GAVL_CUST_NODE_INT_DEC(fcb_transaction /* cust_prefix */, \
334 struct fcb /* cust_root_t */, \
335 struct fcb_transaction /* cust_item_t */, \
336 char* /* cust_key_t */, \
337 transactions /* cust_root_node */, \
338 node /* cust_item_node */, \
339 name /* cust_item_key */, \
340 fcb_transaction_cmp /* cust_cmp_fnc */);
342 GAVL_CUST_NODE_INT_IMP(fcb_transaction /* cust_prefix */, \
343 struct fcb /* cust_root_t */, \
344 struct fcb_transaction /* cust_item_t */, \
345 char* /* cust_key_t */, \
346 transactions /* cust_root_node */, \
347 node /* cust_item_node */, \
348 name /* cust_item_key */, \
349 fcb_transaction_cmp /* cust_cmp_fnc */);
352 gsa_array_field_t array;
355 GSA_CUST_DEC(res_array /* cust_prefix */,
356 struct res_array /* cust_array_t */,
357 struct resource /* cust_item_t */,
358 struct res_key /* cust_key_t */,
359 array /* cust_array_field */,
360 key /* cust_item_key */,
361 res_key_cmp /* cust_cmp_fnc */);
363 GSA_CUST_IMP(res_array /* cust_prefix */,
364 struct res_array /* cust_array_t */,
365 struct resource /* cust_item_t */,
366 struct res_key /* cust_key_t */,
367 array /* cust_array_field */,
368 key /* cust_item_key */,
369 res_key_cmp /* cust_cmp_fnc */,
370 true /* cust_ins_fl */);
374 #define o2fcb(o) (struct fcb*)forb_instance_data(o)
376 static struct res_key*
377 get_res_key(const struct fres_contract *contract, struct res_key *key)
379 fres_block_resource *block_res;
381 block_res = fres_contract_get_resource(contract);
383 ul_logerr("No resource specified\n");
386 key->type = block_res->resource_type;
387 key->id = block_res->resource_id;
392 static struct res_key*
393 get_fc_res_key(const struct fcb_contract *fc, struct res_key *key)
395 if (fc->user_contract)
396 get_res_key(fc->user_contract, key);
398 get_res_key(fc->requested_contract, key);
403 * Fills in an array of fcb_contracts according to requests submited
404 * by an application through negotiate_contracts() or
405 * negotiate_transaction(). For every contract in @a contracts, there
406 * is allocated one fcb_contract in @a fcb_contracts array.
409 * @param fcb_contracts Where to store pointers to fcb_contracts
410 * @param contracts Contracts submited for negotiation
411 * @param num Number of contracts in contracts (which is the same as the number in fcb_contracts).
413 * @return Zero on success, non-zero error code on error.
416 prepare_fcb_contracts(struct fcb *fcb, struct fcb_contract *fcb_contracts[],
417 struct fres_contract *contracts[], int num)
420 struct fcb_contract *fc;
422 for (i=0; i<num; i++) {
423 struct fres_contract *c = contracts[i];
425 if (fres_contract_id_is_empty(&c->id)) {
426 /* Normal negotiation request */
427 COMPILE_TIME_ASSERT(sizeof(c->id) == sizeof(fcb->contract_counter),
428 wrong_size_of_contract_id);
429 c->id = ++fcb->contract_counter;
430 fc = fcb_contract_new(&c->id);
433 fcb_contracts[i] = fc;
434 log_contract("Negotiation request", i, c);
436 fc = fcb_contract_find(fcb, &c->id);
439 fres_contract_id_to_string(str, &c->id, sizeof(str));
440 ul_logerr("Attempt to change unknown contract %s\n", str);
441 return FRES_ERR_NOTHING_TO_RENEGOTIATE;
443 fcb_contracts[i] = fc;
444 if (fres_contract_get_num_blocks(c) == 0) {
446 log_contract("Cancelation request", i, fc->user_contract);
449 log_contract("Renegotiation request", i, fc->user_contract);
453 fc->requested_contract = c;
459 * Ensure that all contracts belong to the same resource and find
460 * resource allocators for the contracts.
463 * @param fcb_contracts Array of fcb_contracts prepared by prepare_fcb_contracts()
464 * @param num Number of contracts in @a fcb_contracts
465 * @param resource Resource for which negotiation is being done.
466 * @param app Application which requests negotiation
469 check_and_setup_resource(struct fcb *fcb, struct fcb_contract *fcb_contracts[],
470 struct resource **resource,
475 struct res_alloc *ra;
476 struct res_key key, key2 = {-1,-1};
478 for (i=0; i<num; i++) {
479 struct fcb_contract *fc = fcb_contracts[i];
481 if (!get_fc_res_key(fc, &key))
482 return FRSH_ERR_RESOURCE_ID_INVALID;
484 /* Check that all contracts are for the same resource */
487 *resource = fcb_resource_find(fcb, &key);
489 ul_logerr("No resource manager for %d.%d registered\n",
491 return FRES_ERR_NO_RESOURCE_MANAGER;
493 /* Find allocator for this request */
494 ra = fcb_alloc_find(*resource, app);
497 forb_server_id_to_string(str, app, sizeof(str));
498 ul_logerr("No resource allocator found for %d.%d and %s\n",
499 (*resource)->key.type, (*resource)->key.id, str);
500 return FRES_ERR_NO_RESOURCE_ALLOCATOR;
503 else if (key.type != key2.type ||
505 ul_logerr("Contract #%d differs in resource!\n", i);
506 return FRSH_ERR_RESOURCE_ID_INVALID;
514 * Prepares a list of contracts to pass to resource manager for (re)reserving.
516 * @todo Needs to be changed for compatibility with transactions.
518 * @param resource Resource for which to rebalance capacity and negotiate new contracts
519 * @param fcb_contract New requests to negotiate
520 * @param num The number of elements in @a fcb_contract
521 * @param[out] rl List with changed contracts to be commited
524 prepare_reservation_list(struct resource *resource,
525 struct fcb_contract *fcb_contract[], int num)
529 struct fcb_contract *fc;
531 reservation_list_init_head(&resource->rl);
532 resource->rl.length = 0;
533 for (i=0; i<num; i++) {
534 assert(fcb_contract[i]->requested_contract != NULL);
535 reservation_list_insert(&resource->rl, fcb_contract[i]);
536 resource->rl.length++;
538 fosa_clock_get_time(CLOCK_REALTIME, &now);
539 ul_list_for_each(sc_contracts, resource, fc) {
540 if (fosa_abs_time_smaller(fc->end_of_stability_period, now) &&
541 fc->requested_contract == NULL) /* Do not insert contract inserted above */
543 reservation_list_insert(&resource->rl, fc);
544 resource->rl.length++;
550 reserve_resource(struct resource *resource)
553 fres_contract_ptr_seq contracts;
554 struct fres_contract *c;
555 struct fcb_contract *fc;
556 CORBA_Environment ev;
558 if (!forb_sequence_alloc_buf(&contracts, resource->rl.length)) {
562 forb_sequence_length(&contracts) = resource->rl.length;
565 /* Prepare FORB sequence */
566 ul_list_for_each(reservation_list, &resource->rl, fc) {
568 if (fc->to_be_reserved_contract)
569 /* Contract without spare capacity */
570 c = fc->to_be_reserved_contract;
571 else if (fc->requested_contract)
572 c = fc->requested_contract;
574 forb_sequence_elem(&contracts, i++) = c;
577 /* Reserve contract */
578 ret = fres_resource_manager_reserve_contracts(resource->mng, &contracts, &ev);
579 if (forb_exception_occurred(&ev)) {
580 ret = fres_forbex2err(&ev);
581 ul_logerr("FORB exception when reserving contracts\n");
585 ul_logerr("Contract reservation error %d\n", ret);
586 ret = FRES_ERR_ADMISSION_TEST;
591 ret = FRSH_ERR_CONTRACT_REJECTED;
595 forb_sequence_free_buf(&contracts, forb_no_destructor);
603 * @param resource Resource for which to rebalance capacity and negotiate new contracts
604 * @param rl List with changed contracts to be commited
606 * @return Zero on success, non-zero error code on error
609 rebalance_spare_capacity_and_reserve(struct resource *resource)
612 struct reservation_list *rl = &resource->rl;
613 struct fcb_contract *fc;
614 fres_block_spare_capacity *s;
616 /* Initialize optimization */
617 ul_list_for_each(reservation_list, rl, fc) {
618 fc->to_be_reserved_contract =
619 fc->requested_contract ? fres_contract_duplicate(fc->requested_contract) :
620 fc->user_contract ? fres_contract_duplicate(fc->user_contract) :
622 assert(fc->to_be_reserved_contract != NULL);
624 s = fres_contract_get_spare_capacity(fc->to_be_reserved_contract);
625 if (s && s->granularity == FRSH_GR_DISCRETE) {
626 fc->sc_variant.initial = s->variants._length - 1;
627 fc->sc_variant.try = fc->sc_variant.initial;
631 bool all_combinations_tried;
632 int criterion, best_criterion = -1;
633 struct fcb_contract *fcb_changed;
634 /* Exhaustive search. Try all combinations of spare capacity
635 * variants and find the one with best creterion. */
637 all_combinations_tried = true;
640 /* Prepare spare capacity variant */
641 ul_list_for_each(reservation_list, rl, fc) {
642 s = fres_contract_get_spare_capacity(fc->to_be_reserved_contract);
643 /* TODO: Simulate continuous granularity by discretization */
644 if (s && s->granularity == FRSH_GR_DISCRETE) {
645 fres_container_copy(fc->to_be_reserved_contract->container,
646 forb_sequence_elem(&s->variants, fc->sc_variant.try));
647 criterion += fc->sc_variant.try;
649 if (fcb_changed == NULL) {
650 /* Chnage tried variant for the next round */
651 fc->sc_variant.try = fc->sc_variant.try > 0 ?
652 fc->sc_variant.try - 1 :
653 s->variants._length - 1;
654 /* Do not change other
655 * contracts unless we have
656 * tried all variants */
657 if (fc->sc_variant.try != fc->sc_variant.initial) {
661 if (fc->sc_variant.try != fc->sc_variant.initial)
662 all_combinations_tried = false;
666 if (criterion > best_criterion) {
667 ret = reserve_resource(resource);
670 best_criterion = criterion;
672 case FRSH_ERR_CONTRACT_REJECTED:
678 } while (!all_combinations_tried);
680 if (best_criterion == -1) {
681 ret = FRSH_ERR_CONTRACT_REJECTED;
683 /* At least some variant succeeded */
685 sc_contracts_init_head(resource);
686 ul_list_for_each(reservation_list, rl, fc) {
687 s = fres_contract_get_spare_capacity(fc->to_be_reserved_contract);
688 if (s && s->granularity == FRSH_GR_DISCRETE) {
689 sc_contracts_insert(resource, fc);
694 ul_list_for_each(reservation_list, rl, fc) {
695 fres_contract_destroy(fc->to_be_reserved_contract);
696 fc->to_be_reserved_contract = NULL;
702 * Create/change VReses according to @a schedulable_contracts.
704 * There might be more allocators for schedulable contracts, so merge
705 * adjacent vreses with the same allocator together and create/change
706 * them in one step. Also the order of schedulable contracts might be
707 * different from the initial order od ids in commit_contracts()
708 * therefore we have to search for every contract.
711 change_vreses(struct fcb *fcb, fres_contract_ptr_seq *schedulable_contracts)
713 struct res_alloc *last_ra = NULL;
714 fres_contract_ptr_seq vreses;
716 CORBA_Environment ev;
718 if (!forb_sequence_alloc_buf(&vreses, schedulable_contracts->_length)) {
723 for (i=0; i<schedulable_contracts->_length; i++) {
724 struct fcb_contract *fc;
725 struct fres_contract *sc = schedulable_contracts->_buffer[i];
727 log_contract("Changing VRES", i, sc);
729 fc = fcb_contract_find(fcb, &sc->id);
732 if (true /* TODO: if the schedulable contract is changed */) {
733 if (last_ra != fc->ra) {
734 if (vreses._length) {
735 ret = fres_resource_allocator_change_vreses(last_ra->ra,
737 if (forb_exception_occurred(&ev)) {
738 ret = fres_forbex2err(&ev);
745 vreses._buffer[vreses._length] = sc;
752 ret = fres_resource_allocator_change_vreses(last_ra->ra,
754 if (forb_exception_occurred(&ev))
755 ret = fres_forbex2err(&ev);
758 forb_sequence_free_buf(&vreses, forb_no_destructor);
763 free_fcb_contracts(struct fcb_contract *fcb_contracts[], int num)
766 struct fcb_contract *fc;
767 for (i=0; i<num; i++) {
768 fc = fcb_contracts[i];
769 if (fc && !fc->user_contract) {
770 fc->requested_contract = NULL; /* Destroyed by FORB */
771 fcb_contract_destroy(fc);
778 commit_resource(struct resource *resource,
779 fres_contract_ptr_seq **schedulable_contracts)
782 fres_contract_id_seq commit_ids;
784 struct fcb_contract *fc;
785 CORBA_Environment ev;
787 if (!forb_sequence_alloc_buf(&commit_ids, resource->rl.length)) {
792 commit_ids._length = resource->rl.length;
794 ul_list_for_each(reservation_list, &resource->rl, fc) {
795 forb_sequence_elem(&commit_ids, i) = fc->id;
799 fres_resource_manager_commit_contracts(resource->mng, &commit_ids,
800 schedulable_contracts, &ev);
801 if (forb_exception_occurred(&ev)) {
802 ret = fres_forbex2err(&ev);
807 forb_sequence_free_buf(&commit_ids, forb_no_destructor);
812 int cancel_reservations(struct resource *resource)
815 fres_contract_id_seq commit_ids;
817 struct fcb_contract *fc;
818 CORBA_Environment ev;
820 if (!forb_sequence_alloc_buf(&commit_ids, resource->rl.length)) {
825 commit_ids._length = resource->rl.length;
827 ul_list_for_each(reservation_list, &resource->rl, fc) {
828 forb_sequence_elem(&commit_ids, i) = fc->id;
832 fres_resource_manager_cancel_reservations(resource->mng, &commit_ids, &ev);
833 if (forb_exception_occurred(&ev)) {
834 ret = fres_forbex2err(&ev);
840 forb_sequence_free_buf(&commit_ids, forb_no_destructor);
845 /* Add new contracts to our fcb database for later
846 * reference. Canceled contracts are removed below. */
848 fcb_remember_contracts(struct fcb *fcb,
849 struct fcb_contract **fcb_contracts, int num)
851 struct fcb_contract *fc;
854 for (i=0; i<num; i++) {
855 fc = fcb_contracts[i];
857 if (fc->user_contract) {
858 if (fres_contract_get_num_blocks(fc->requested_contract) > 0) {
860 fres_contract_destroy(fc->user_contract);
861 fc->user_contract = fres_contract_duplicate(fc->requested_contract);
862 /* Note: requested_contract is also
863 * pointed by contracts parameter and
864 * will be freed by FORB. */
865 fc->requested_contract = NULL;
868 /* Insert new contracts */
869 fcb_contract_insert(fcb, fcb_contracts[i]);
870 fc->user_contract = fres_contract_duplicate(fc->requested_contract);
871 fc->requested_contract = NULL;
872 /* See the note above. */
879 fcb_remember_schedulable_contracts(struct fcb *fcb,
880 fres_contract_ptr_seq *schedulable_contracts)
882 struct fcb_contract *fc;
884 for (i=0; i<schedulable_contracts->_length; i++) {
885 struct fres_contract *sc = schedulable_contracts->_buffer[i];
886 fc = fcb_contract_find(fcb, &sc->id);
888 fres_contract_destroy(fc->schedulable_contract);
889 fc->schedulable_contract = fres_contract_duplicate(sc);
890 assert(fc->schedulable_contract);
896 reject_transactions(struct fcb_contract *fcb_contracts[], int num)
899 for (i = 0; i < num; i++) {
900 if (fcb_contracts[i]->transaction)
901 return FRES_ERR_VRES_PART_OF_TRANSACTION;
907 negotiate_contracts(fres_contract_broker obj,
908 const fres_contract_ptr_seq* contracts,
909 fres_contract_id_seq** ids_out,
910 CORBA_Environment *ev)
912 struct fcb *fcb = o2fcb(obj);
913 struct resource *resource = NULL;
916 fres_contract_ptr_seq *schedulable_contracts;
917 struct fcb_contract **fcb_contracts;
919 int num = contracts->_length;
921 /* Prepare output sequence for the case we return eariler with
923 forb_sequence_alloc(*ids_out, 0);
925 ev->major = FORB_EX_NO_MEMORY;
928 CORBA_sequence_set_release(*ids_out, CORBA_TRUE);
930 forb_get_req_source(obj, &app);
932 fcb_contracts = malloc(sizeof(fcb_contracts[0])*num);
933 if (!fcb_contracts) {
937 memset(fcb_contracts, 0, sizeof(fcb_contracts[0])*num);
939 ret = prepare_fcb_contracts(fcb, fcb_contracts,
940 contracts->_buffer, num);
942 goto err_free_fcb_contracts;
944 ret = reject_transactions(fcb_contracts, num);
946 goto err_free_fcb_contracts;
947 ret = check_and_setup_resource(fcb, fcb_contracts, &resource,
950 goto err_free_fcb_contracts;
952 prepare_reservation_list(resource, fcb_contracts, num);
954 /* Reserve contracts */
955 ret = rebalance_spare_capacity_and_reserve(resource);
957 if (ret == FRSH_ERR_CONTRACT_REJECTED) {
958 ul_logmsg("Contract(s) was/were rejected\n");
961 fres_strerror(ret, msg, sizeof(msg));
962 ul_logerr("Reservation error: %s\n", msg);
964 goto err_free_fcb_contracts;
967 /* Commit contracts */
968 ret = commit_resource(resource, &schedulable_contracts);
970 goto err_cancel_reservation;
972 fcb_remember_contracts(fcb, fcb_contracts, num);
973 fcb_remember_schedulable_contracts(fcb, schedulable_contracts);
975 ret = change_vreses(fcb, schedulable_contracts);
977 goto err_cancel_reservation;
979 forb_sequence_free(schedulable_contracts, fres_contract_ptr_destroy);
981 ul_logerr("VRes was not created\n");
982 goto err_cancel_contracts;
986 /* Return IDs and delete canceled contracts from out database */
987 if (!forb_sequence_alloc_buf(*ids_out, num)) {
988 ev->major = FORB_EX_NO_MEMORY;
989 goto err_cancel_contracts;
991 (*ids_out)->_length = num;
992 for (i=0; i<num; i++) {
993 struct fcb_contract *fc = fcb_contracts[i];
994 forb_sequence_elem(*ids_out, i) = fc->id;
996 if (fc->requested_contract &&
997 fres_contract_get_num_blocks(fc->requested_contract) == 0) {
998 fcb_contract_delete(fcb, fc);
999 /* Note: requested_contract is also pointed by
1000 * contracts parameter and will be freed by FORB. */
1001 fc->requested_contract = NULL;
1002 fcb_contract_destroy(fc);
1007 err_cancel_contracts:
1009 goto err_free_fcb_contracts;
1010 err_cancel_reservation:
1011 cancel_reservations(resource);
1012 err_free_fcb_contracts:
1013 free_fcb_contracts(fcb_contracts, num);
1018 void redistribute_spare_capacity(fres_contract_broker obj,
1019 const frsh_resource_type_t restype,
1020 const frsh_resource_id_t resid,
1021 CORBA_Environment *ev)
1023 struct fcb *fcb = o2fcb(obj);
1024 struct res_key key = {restype, resid };
1025 struct resource *resource;
1027 resource = fcb_resource_find(fcb, &key);
1029 prepare_reservation_list(resource, NULL, 0);
1031 /* forb_sequence_alloc(ids, rl.length); */
1032 /* if (!ids || !ids->_buffer) { */
1033 /* ev->major = FORB_EX_NO_MEMORY; */
1034 /* goto err_free_fcb_contracts; */
1036 /* CORBA_sequence_set_release(ids, CORBA_TRUE); */
1037 /* *ids_out = ids; /\* ids is freed by FORB *\/ */
1040 rebalance_spare_capacity_and_reserve(resource);
1044 CORBA_long register_resource(fres_contract_broker obj,
1045 const frsh_resource_type_t restype,
1046 const frsh_resource_id_t resid,
1047 const fres_resource_desc *desc,
1048 CORBA_Environment *ev)
1050 struct fcb *fcb = o2fcb(obj);
1051 struct resource *res, *res2;
1053 res = malloc(sizeof(*res));
1055 memset(res, 0, sizeof(*res));
1056 res->key.type = restype;
1057 res->key.id = resid;
1058 res2 = fcb_resource_find(fcb, &res->key);
1060 if (forb_object_is_stale(res2->mng)) {
1061 ul_logmsg("Removing stale manager for resource %d.%d\n",
1063 forb_object_release(res2->mng);
1064 fcb_resource_delete(fcb, res2);
1065 /* TODO: Delete also all allocators associated
1066 * with this stale resource manager. */
1070 ul_logerr("Resource manager %d.%d already registered\n",
1075 res->mng = forb_object_duplicate(desc->manager);
1076 res->name = desc->name;
1078 fcb_alloc_init_root_field(res);
1079 sc_contracts_init_head(res);
1080 ul_logmsg("Registering manager for resource \"%s\" (%d.%d)\n",
1081 res->name, restype, resid);
1082 fcb_resource_insert(fcb, res);
1091 CORBA_long register_allocator(fres_contract_broker obj,
1092 const frsh_resource_type_t restype,
1093 const frsh_resource_id_t resid,
1094 const fres_resource_allocator ra_obj,
1095 CORBA_Environment *ev)
1097 struct fcb *fcb = o2fcb(obj);
1098 struct resource *res;
1099 struct res_alloc *ra;
1100 struct res_key resource;
1101 forb_server_id server_id;
1102 char server_id_str[40];
1105 forb_get_server_id(ra_obj, &server_id);
1106 forb_server_id_to_string(server_id_str, &server_id, sizeof(server_id_str));
1107 ul_logmsg("Registering allocator for resource %d.%d in app %s\n",
1108 restype, resid, server_id_str);
1110 resource.type = restype;
1111 resource.id = resid;
1112 res = fcb_resource_find(fcb, &resource);
1114 ul_logerr("No manager found for %d.%d. Unable to register the allocator!\n",
1116 ret = FRES_ERR_NO_RESOURCE_MANAGER;
1119 ra = fcb_alloc_find(res, &server_id);
1121 char *str = forb_object_to_string(ra_obj);
1122 ul_logerr("Allocator from already registered (%s)\n",
1125 ret = FRES_ERR_ALLOCATOR_ALREADY_REGISTERED;
1128 ra = malloc(sizeof(*ra));
1133 ra->app = server_id;
1134 ra->ra = forb_object_duplicate(ra_obj);
1135 fcb_alloc_insert(res, ra);
1141 void get_resources(fres_contract_broker obj, fres_resource_seq** resources, CORBA_Environment *ev)
1143 struct fcb *fcb = o2fcb(obj);
1144 fres_resource_seq *seq;
1145 struct resource *res;
1148 seq = malloc(sizeof(*seq));
1150 ev->major = FORB_EX_NO_MEMORY;
1153 memset(seq, 0, sizeof(*seq));
1156 gavl_cust_for_each(fcb_resource, fcb, res) {
1160 seq->_buffer = CORBA_sequence_fres_resource_allocbuf(n);
1165 gavl_cust_for_each(fcb_resource, fcb, res) {
1166 seq->_buffer[n].restype = res->key.type;
1167 seq->_buffer[n].resid = res->key.id;
1168 seq->_buffer[n].desc.manager = res->mng;
1169 seq->_buffer[n].desc.name = res->name;
1177 transaction_has_spare_capacity(const fres_transaction_t* transaction)
1179 struct fres_contract **c;
1180 forb_sequence_foreach(&transaction->contracts, c)
1181 if (fres_contract_get_spare_capacity(*c))
1187 transaction_get_resources(struct fcb *fcb, struct fcb_contract *fc[],
1188 int num, struct res_array *res_array)
1191 struct resource *resource;
1195 for (i = 0; i < num; i++) {
1196 get_fc_res_key(fc[i], &key);
1197 resource = fcb_resource_find(fcb, &key);
1198 ret = res_array_insert(res_array, resource);
1200 ret = FRSH_ERR_INTERNAL_ERROR;
1210 negotiate_transaction(fres_contract_broker _obj,
1211 const fres_transaction_t* transaction,
1212 CORBA_Environment *ev)
1214 struct fcb *fcb = o2fcb(_obj);
1215 struct fcb_contract **fcb_contracts, *fc;
1216 const fres_contract_ptr_seq* user_contracts = &transaction->contracts;
1217 int i, ret, num = user_contracts->_length;
1218 struct res_array res_array;
1220 struct resource *resource;
1221 fres_contract_ptr_seq *schedulable_contracts;
1222 struct fcb_transaction *ft;
1224 ul_logmsg("Negotiating transaction '%s' with %d contracts\n", transaction->name, num);
1225 if (transaction_has_spare_capacity(transaction)) {
1226 ret = FRES_ERR_SPARE_CAPACITY_NOT_SUPPORTED;
1230 fcb_contracts = malloc(sizeof(*fcb_contracts)*num);
1231 if (!fcb_contracts) {
1235 memset(fcb_contracts, 0, sizeof(*fcb_contracts)*num);
1237 ret = prepare_fcb_contracts(fcb, fcb_contracts,
1238 user_contracts->_buffer, num);
1240 goto err_free_fcb_contracts;
1242 res_array_init_array_field(&res_array);
1243 ret = transaction_get_resources(fcb, fcb_contracts, num, &res_array);
1245 gsa_cust_for_each(res_array, &res_array, resource) {
1246 reservation_list_init_head(&resource->rl);
1247 resource->rl.length = 0;
1248 for (i = 0; i < num; i++) {
1249 fc = fcb_contracts[i];
1250 get_fc_res_key(fc, &key);
1251 if (res_key_cmp(&key, &resource->key) == 0) {
1252 reservation_list_insert(&resource->rl, fc);
1253 resource->rl.length++;
1257 gsa_cust_for_each(res_array, &res_array, resource) {
1258 ret = reserve_resource(resource);
1260 ul_logerr("Reservation failed\n");
1261 goto err_cancel_reservation;
1264 fcb_remember_contracts(fcb, fcb_contracts, num);
1265 gsa_cust_for_each(res_array, &res_array, resource) {
1266 ret = commit_resource(resource, &schedulable_contracts);
1268 ul_logerr("Commit failed\n");
1269 goto err_cancel_reservation;
1271 fcb_remember_schedulable_contracts(fcb, schedulable_contracts);
1272 forb_sequence_free(schedulable_contracts, fres_contract_ptr_destroy);
1275 ft = fcb_transaction_new(transaction->name);
1278 goto err_cancel_reservation;
1280 enum { NONE, CANCELATION, NEGOTIATION } op = NONE;
1281 for (i = 0; i < num; i++) {
1282 fc = fcb_contracts[i];
1283 if (fc->requested_contract &&
1284 fres_contract_get_num_blocks(fc->requested_contract) == 0) {
1285 assert(i == 0 || op == CANCELATION);
1287 /* TODO: Review and test transaction cancelation!!! */
1288 fcb_contract_delete(fcb, fc);
1289 /* Note: requested_contract is also pointed by
1290 * contracts parameter and will be freed by FORB. */
1291 fc->requested_contract = NULL;
1292 fcb_contract_destroy(fc);
1294 assert(i == 0 || op == NEGOTIATION);
1296 tran_contract_insert_at(ft, fc, i);
1297 fc->transaction = ft;
1302 fcb_transaction_insert(fcb, ft);
1305 fcb_transaction_delete(fcb, ft);
1306 fcb_transaction_destroy(ft);
1311 res_array_delete_all(&res_array);
1313 err_cancel_reservation:
1314 gsa_cust_for_each(res_array, &res_array, resource) {
1315 cancel_reservations(resource);
1317 res_array_delete_all(&res_array);
1318 err_free_fcb_contracts:
1319 free_fcb_contracts(fcb_contracts, num);
1325 wait_transaction(fres_contract_broker _obj,
1326 const CORBA_char * name,
1327 fres_transaction_t** transaction,
1328 CORBA_Environment *ev)
1330 return FRSH_ERR_NOT_IMPLEMENTED;
1334 allocate_transaction_vres(fres_contract_broker _obj,
1335 const CORBA_char * name,
1336 const CORBA_long index,
1337 fres_contract_id_t *id,
1338 CORBA_Environment *ev)
1340 struct fcb *fcb = o2fcb(_obj);
1341 struct fcb_transaction *ft;
1342 struct fcb_contract *fc;
1344 struct res_alloc *ra;
1345 char * const *n = (char * const *)&name;
1347 struct resource *resource;
1348 fres_contract_ptr_seq vreses;
1349 CORBA_Environment ev2;
1351 #define GOTO(label, error) do { ret = (error); goto label; } while(0)
1353 ul_logmsg("Allocate transaction VRES '%s'[%d]\n", name, index);
1355 ft = fcb_transaction_find(fcb, n);
1356 if (!ft) GOTO(err, FRES_ERR_TRANSACTION_NOT_FOUND);
1358 fc = tran_contract_indx2item(ft, index);
1359 if (!fc) GOTO(err, FRSH_ERR_TOO_LARGE);
1361 if (!get_fc_res_key(fc, &key))
1362 GOTO(err, FRSH_ERR_RESOURCE_ID_INVALID);
1363 resource = fcb_resource_find(fcb, &key);
1365 GOTO(err, FRES_ERR_NO_RESOURCE_MANAGER);
1367 forb_get_req_source(_obj, &app);
1368 /* Find allocator for the requested VRES */
1369 ra = fcb_alloc_find(resource, &app);
1372 forb_server_id_to_string(str, &app, sizeof(str));
1373 ul_logerr("No resource allocator found for %d.%d and %s\n",
1374 resource->key.type, resource->key.id, str);
1375 GOTO(err, FRES_ERR_NO_RESOURCE_ALLOCATOR);
1379 if (!forb_sequence_alloc_buf(&vreses, 1))
1382 assert(fc->schedulable_contract);
1383 forb_sequence_elem(&vreses, 0) = fc->schedulable_contract;
1384 forb_sequence_length(&vreses) = 1;
1385 ret = fres_resource_allocator_change_vreses(ra->ra, &vreses, &ev2);
1386 ul_logerr("Err = %d\n", ret);
1387 if (forb_exception_occurred(&ev2))
1388 GOTO(err_free, fres_forbex2err(&ev2));
1395 forb_sequence_free_buf(&vreses, forb_no_destructor);
1401 #if CONFIG_FCB_INET && !CONFIG_FORB_PROTO_INET_DEFAULT
1402 static int register_inet_port(forb_orb orb)
1404 forb_port_t *port = forb_malloc(sizeof(*port));
1406 struct in_addr listen_on;
1410 memset(port, 0, sizeof(*port));
1411 listen_on.s_addr = INADDR_ANY;
1412 ret = forb_inet_port_init(&port->desc, listen_on, 0);
1415 ret = forb_register_port(orb, port);
1420 struct forb_fres_contract_broker_impl impl = {
1421 .negotiate_contracts = negotiate_contracts,
1422 .register_resource = register_resource,
1423 .register_allocator = register_allocator,
1424 .redistribute_spare_capacity = redistribute_spare_capacity,
1425 .get_resources = get_resources,
1426 .negotiate_transaction = negotiate_transaction,
1427 .wait_transaction = wait_transaction,
1428 .allocate_transaction_vres = allocate_transaction_vres,
1431 void peer_discovery_callback(const forb_orb peer_orb, const char *orb_id)
1433 forb_server_id server_id;
1434 char server_id_str[sizeof(forb_server_id)*2+1];
1436 forb_get_server_id(peer_orb, &server_id);
1437 forb_server_id_to_string(server_id_str, &server_id, sizeof(server_id_str));
1439 ul_logmsg("peer discovered: %s (orb_id '%s')\n", server_id_str, orb_id);
1445 if (strcmp(orb_id, "org.frescor.fcb") == 0) {
1446 fosa_abs_time_t now;
1447 fosa_rel_time_t delay;
1448 fosa_clock_get_time(CLOCK_REALTIME, &now);
1449 delay = fosa_abs_time_extract_interval(start_time, now);
1450 ul_logmsg("node joined: %s (time %ld ms)\n", server_id_str,
1451 fosa_rel_time_to_msec(delay));
1455 void peer_dead_callback(const forb_orb peer_orb, const char *orb_id)
1459 static struct option long_opts[] = {
1460 { "daemon", optional_argument, NULL, 'd' },
1461 { "loglevel", required_argument, NULL, 'l' },
1468 printf("usage: fcb [ options ]\n");
1469 printf(" -d, --daemon [pid-file] go to background after FORB initialization\n");
1470 printf(" -l, --loglevel <number>|<domain>=<number>,...\n");
1473 int print_log_domain(ul_log_domain_t *domain, void *context)
1475 printf("%s = %d\n", domain->name, domain->level);
1479 int main(int argc, char *argv[])
1482 struct fcb fcb_data;
1483 fres_contract_broker fcb;
1484 forb_executor_t executor;
1486 forb_init_attr_t attr = {
1487 .orb_id = "org.frescor.fcb",
1488 .peer_discovery_callback = peer_discovery_callback,
1489 .peer_dead_callback = peer_dead_callback,
1490 .fixed_tcp_port = FCB_TCP_PORT,
1491 #ifdef CONFIG_FORB_PROTO_INET_DEFAULT
1492 .fixed_server_id = FCB_SERVER_ID,
1493 .redistribute_hellos = true,
1498 while ((opt = getopt_long(argc, argv, "d::l:", &long_opts[0], NULL)) != EOF) {
1501 if (*optarg == '?') {
1502 ul_logreg_for_each_domain(print_log_domain, NULL);
1507 ret = ul_log_domain_arg2levels(optarg);
1509 error(1, EINVAL, "Error parsing -l argument at char %d\n", ret);
1514 opt_pidfile = optarg;
1519 exit(opt == 'h' ? 0 : 1);
1523 memset(&fcb_data, 0, sizeof(fcb_data));
1524 fosa_clock_get_time(CLOCK_REALTIME, &start_time);
1527 forb_daemon_prepare(opt_pidfile);
1529 orb = forb_init(&argc, &argv, &attr);
1530 if (!orb) error(1, errno, "FORB initialization failed");
1532 #if CONFIG_FCB_INET && !CONFIG_FORB_PROTO_INET_DEFAULT
1533 ret = register_inet_port(orb);
1534 if (ret) error(0, errno, "INET port registration failed");
1537 fcb_resource_init_root_field(&fcb_data);
1538 fcb_contract_init_root_field(&fcb_data);
1539 fcb_transaction_init_root_field(&fcb_data);
1541 fcb = forb_fres_contract_broker_new(orb, &impl, &fcb_data);
1542 if (!fcb) error(1, errno, "forb_fres_contract_broker_new failed");
1544 /* Prepare executor before we register the fcb reference,
1545 * so that no reuqests are lost */
1546 ret = forb_executor_init(&executor);
1547 if (ret) error(1, errno, "forb_executor_init failed");
1549 ret = forb_executor_register_object(&executor, fcb);
1550 if (ret) error(1, errno, "forb_executor_register_object failed");
1552 ret = forb_register_reference(fcb, fres_contract_broker_reg_name);
1553 if (ret) error(1, errno, "forb_register_reference() failed");
1555 ul_logmsg("Waiting for requests\n");
1557 forb_daemon_ready();
1559 ret = forb_executor_run(&executor);
1560 if (ret) error(1, errno, "forb_executor_run failed");