fres/cbroker/fcb.c

   1 /**************************************************************************/
   2 /* ---------------------------------------------------------------------- */
   3 /* Copyright (C) 2006 - 2008 FRESCOR consortium partners:                 */
   4 /*                                                                        */
   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                */
  11 /*   ENEA                                   SWEDEN                        */
  12 /*   Thales Communication S.A.              FRANCE                        */
  13 /*   Visual Tools S.A.                      SPAIN                         */
  14 /*   Rapita Systems Ltd                     UK                            */
  15 /*   Evidence                               ITALY                         */
  16 /*                                                                        */
  17 /*   See http://www.frescor.org for a link to partners' websites          */
  18 /*                                                                        */
  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.                                               */
  23 /*                                                                        */
  24 /*                                                                        */
  25 /*  This file is part of FRSH (FRescor ScHeduler)                         */
  26 /*                                                                        */
  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.                                              */
  37 /*                                                                        */
  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 /**************************************************************************/
  46
  47 /**
  48  * @file   fcb.c
  49  * @author Michal Sojka <sojkam1@fel.cvut.cz>
  50  * @date   Mon Oct 20 18:00:18 2008
  51  *
  52  * @brief  FRESCOR Contract Broker
  53  *
  54  *
  55  */
  56 #include <forb.h>
  57 #include <fcb.h>
  58 #include <error.h>
  59 #include <errno.h>
  60 #include <stdio.h>
  61 #include <ul_gavlcust.h>
  62 #include <string.h>
  63 #include <ul_log.h>
  64 #include <forb/server_id.h>
  65 #include <fres_contract.h>
  66 #include "fcb_config.h"
  67
  68 #ifdef CONFIG_FCB_INET
  69 #include <forb/proto_inet.h>
  70 #endif
  71
  72 UL_LOG_CUST(ulogd_fcb);
  73 ul_log_domain_t ulogd_fcb = {UL_LOGL_MSG, "fcb"};
  74
  75
  76 /**
  77  * Resource identification
  78  */
  79 struct res_key {
  80         frsh_resource_type_t type;
  81         frsh_resource_id_t id;
  82 };
  83
  84 /**
  85  * Registered resource
  86  */
  87 struct resource {
  88         gavl_node_t node;
  89         struct res_key key;
  90         fres_resource_manager mng; /**< Object reference of the resource manager */
  91         gavl_cust_root_field_t allocators; /**< Registered allocators for this resource (from multiple applications/nodes) */
  92 };
  93
  94 /**
  95  * Resource allocator registered in different nodes/applications
  96  */
  97 struct res_alloc {
  98         gavl_node_t node;
  99         forb_server_id app;
 100         fres_resource_allocator ra;
 101 };
 102
 103 struct fcb_contract {
 104         fres_contract_id_t id;
 105         gavl_node_t node;
 106         struct fres_contract *user_contract;
 107 };
 108
 109 /**
 110  * Contract broker data
 111  */
 112 struct fcb {
 113         gavl_cust_root_field_t resources; /**< Registered resources */
 114         gavl_cust_root_field_t contracts; /**< Contracts negotiated by this FCB */
 115 };
 116
 117 struct fcb_contract *fcb_contract_new(fres_contract_id_t *id)
 118 {
 119         struct fcb_contract *fcb_contract;
 120
 121         fcb_contract = malloc(sizeof(*fcb_contract));
 122         if (!fcb_contract) {
 123                 return NULL;
 124         }
 125         memset(fcb_contract, 0, sizeof(*fcb_contract));
 126         fcb_contract->id = *id;
 127
 128         return fcb_contract;
 129 }
 130
 131 void fcb_contract_destroy(struct fcb_contract *fcb_contract)
 132 {
 133         if (fcb_contract->user_contract) {
 134                 fres_contract_destroy(fcb_contract->user_contract);
 135         }
 136         free(fcb_contract);
 137 }
 138
 139 static inline int res_key_cmp(const struct res_key *a,
 140                               const struct res_key *b)
 141 {
 142         if (a->type < b->type) {
 143                 return -1;
 144         } else if (a->type > b->type) {
 145                 return +1;
 146         } else if (a->id < b->id) {
 147                 return -1;
 148         } else if (a->id > b->id) {
 149                 return +1;
 150         } else {
 151                 return 0;
 152         }
 153 }
 154
 155 /* Container for registered resources */
 156 GAVL_CUST_NODE_INT_DEC(fcb_resource   /* cust_prefix */,                \
 157                        struct fcb     /* cust_root_t */,                \
 158                        struct resource/* cust_item_t */,                \
 159                        struct res_key /* cust_key_t */,                 \
 160                        resources      /* cust_root_node */,             \
 161                        node           /* cust_item_node */,             \
 162                        key            /* cust_item_key */,              \
 163                        res_key_cmp    /* cust_cmp_fnc */);
 164
 165 GAVL_CUST_NODE_INT_IMP(fcb_resource   /* cust_prefix */,                \
 166                        struct fcb     /* cust_root_t */,                \
 167                        struct resource/* cust_item_t */,                \
 168                        struct res_key /* cust_key_t */,                 \
 169                        resources      /* cust_root_node */,             \
 170                        node           /* cust_item_node */,             \
 171                        key            /* cust_item_key */,              \
 172                        res_key_cmp    /* cust_cmp_fnc */);
 173
 174 /* Container for allocators registered for a given resource */
 175 GAVL_CUST_NODE_INT_DEC(fcb_alloc        /* cust_prefix */,              \
 176                        struct resource  /* cust_root_t */,              \
 177                        struct res_alloc /* cust_item_t */,              \
 178                        forb_server_id   /* cust_key_t */,               \
 179                        allocators       /* cust_root_node */,           \
 180                        node             /* cust_item_node */,           \
 181                        app              /* cust_item_key */,            \
 182                        fres_contract_id_cmp /* cust_cmp_fnc */);
 183
 184 GAVL_CUST_NODE_INT_IMP(fcb_alloc        /* cust_prefix */,              \
 185                        struct resource   /* cust_root_t */,             \
 186                        struct res_alloc /* cust_item_t */,              \
 187                        forb_server_id   /* cust_key_t */,               \
 188                        allocators       /* cust_root_node */,           \
 189                        node             /* cust_item_node */,           \
 190                        app              /* cust_item_key */,            \
 191                        forb_server_id_cmp /* cust_cmp_fnc */);
 192
 193 /* Container for negotiated contracts */
 194 GAVL_CUST_NODE_INT_DEC(fcb_contract         /* cust_prefix */,          \
 195                        struct fcb           /* cust_root_t */,          \
 196                        struct fcb_contract  /* cust_item_t */,          \
 197                        fres_contract_id_t   /* cust_key_t */,           \
 198                        contracts            /* cust_root_node */,       \
 199                        node                 /* cust_item_node */,       \
 200                        id                   /* cust_item_key */,        \
 201                        fres_contract_id_cmp /* cust_cmp_fnc */);
 202
 203 #if 1
 204 GAVL_CUST_NODE_INT_IMP(fcb_contract         /* cust_prefix */,          \
 205                        struct fcb           /* cust_root_t */,          \
 206                        struct fcb_contract  /* cust_item_t */,          \
 207                        fres_contract_id_t   /* cust_key_t */,           \
 208                        contracts            /* cust_root_node */,       \
 209                        node                 /* cust_item_node */,       \
 210                        id                   /* cust_item_key */,        \
 211                        fres_contract_id_cmp /* cust_cmp_fnc */);
 212 #else
 213 #include "fcb_contract_gavl.inc"
 214 #endif
 215
 216
 217 #define o2fcb(o) (struct fcb*)forb_instance_data(o)
 218
 219 static struct resource *
 220 get_resource(const struct fcb *fcb, const struct fres_contract *contract)
 221 {
 222         fres_block_resource *block_res;
 223         struct res_key res_key;
 224         struct resource *resource;
 225
 226         block_res = fres_contract_get_resource(contract);
 227         if (!block_res) {
 228                 ul_logerr("No resource specified\n");
 229                 return NULL;
 230         }
 231         res_key.type = block_res->resource_type;
 232         res_key.id = block_res->resource_id;
 233
 234         resource = fcb_resource_find(fcb, &res_key);
 235         if (!resource) {
 236                 ul_logerr("No resource manager for %d.%d registered\n",
 237                           res_key.type, res_key.id);
 238                 return NULL;
 239         }
 240         return resource;
 241 }
 242
 243 CORBA_long
 244 negotiate_contract(fres_contract_broker obj,
 245                    const fres_contract_ptr contract,
 246                    fres_contract_id_t* id,
 247                    CORBA_Environment *ev)
 248 {
 249         struct fcb *fcb = o2fcb(obj);
 250         struct resource *resource;
 251         struct res_alloc *ra;
 252         int ret;
 253         forb_server_id app;
 254         fres_contract_ptr contract_seq_buf;
 255         fres_contract_ptr_seq contracts;
 256         fres_contract_ptr_seq *schedulable_contracts;
 257         fres_contract_id_seq ids;
 258         struct fcb_contract *fcb_contract;
 259
 260         resource = get_resource(fcb, contract);
 261         if (!resource) {
 262                 ret = FRSH_ERR_RESOURCE_ID_INVALID;
 263                 goto err;
 264         }
 265
 266         forb_uuid_generate((forb_uuid_t *)id);
 267         contract->id = *id;
 268
 269         forb_get_req_source(obj, &app);
 270         ra = fcb_alloc_find(resource, &app);
 271         if (!ra) {
 272                 char str[60];
 273                 forb_server_id_to_string(str, &app, sizeof(str));
 274                 ul_logerr("No resource allocator found for %d.%d and %s\n",
 275                           resource->key.type, resource->key.id, str);
 276                 ret = -1;
 277                 goto err;
 278         }
 279
 280         fcb_contract = fcb_contract_new(id);
 281         fcb_contract->user_contract = fres_contract_duplicate(contract);
 282
 283         /* Reserve contract */
 284         contracts._length = 1;
 285         contract_seq_buf = contract;
 286         contracts._buffer = &contract_seq_buf;
 287         ret = fres_resource_manager_reserve_contracts(resource->mng, &contracts, ev);
 288         if (forb_exception_occurred(ev) || ret < 0) {
 289                 goto err_free_fcb_contract;
 290         }
 291         if (ret == 1) {
 292                 ul_logmsg("Contract was not accepted\n");
 293                 goto err_free_fcb_contract;
 294         }
 295
 296         /* Commit contract */
 297         ids._length = ids._maximum = 1;
 298         ids._buffer = id;
 299         fres_resource_manager_commit_contracts(resource->mng, &ids,
 300                                                &schedulable_contracts, ev);
 301         if (forb_exception_occurred(ev)) {
 302                 ret = FRES_ERR_FORB_EXCEPTION;
 303                 goto err_free_fcb_contract;
 304         }
 305
 306         /* Create VRes */
 307         ret = fres_resource_allocator_change_vreses(ra->ra, schedulable_contracts, ev);
 308         if (CORBA_sequence_get_release(schedulable_contracts)) {
 309                 int i;
 310                 for (i=0; i<schedulable_contracts->_length; i++) {
 311                         fres_contract_destroy(schedulable_contracts->_buffer[i]);
 312                 }
 313                 forb_free(schedulable_contracts->_buffer);
 314         }
 315         forb_free(schedulable_contracts);
 316         if (forb_exception_occurred(ev)) {
 317                 ret = FRES_ERR_FORB_EXCEPTION;
 318                 goto err_cancel_reservation;
 319         }
 320         if (ret != 0) {
 321                 ul_logmsg("VRes was not created\n");
 322                 goto err_cancel_reservation;
 323         }
 324
 325         /* Store the negotiated contract for later reference */
 326         fcb_contract_insert(fcb, fcb_contract);
 327
 328         return 0;
 329
 330 err_cancel_reservation:
 331         fres_resource_manager_cancel_contracts(resource->mng, &ids, ev);
 332 err_free_fcb_contract:
 333         fcb_contract_destroy(fcb_contract);
 334 err:
 335         return ret;
 336 }
 337
 338 CORBA_long cancel_contract(fres_contract_broker obj,
 339                            const fres_contract_id_t* id,
 340                            CORBA_Environment *ev)
 341 {
 342         struct fcb *fcb = o2fcb(obj);
 343         struct fcb_contract *fcb_contract;
 344         struct resource *resource;
 345         struct res_alloc *ra;
 346         fres_contract_id_t id_buffer[1] = { *id };
 347         fres_contract_id_seq ids;
 348         forb_server_id app;
 349         int ret;
 350
 351         fcb_contract = fcb_contract_find(fcb, &id_buffer[0]); /* FIXME: id */
 352         if (!fcb_contract) {
 353                 ret = FRSH_ERR_NOT_CONTRACTED_VRES;
 354                 goto err;
 355         }
 356
 357         resource = get_resource(fcb, fcb_contract->user_contract);
 358         if (!resource) {
 359                 ret = FRSH_ERR_RESOURCE_ID_INVALID;
 360                 goto err;
 361         }
 362
 363         forb_get_req_source(obj, &app);
 364         ra = fcb_alloc_find(resource, &app);
 365         if (!ra) {
 366                 char str[60];
 367                 forb_server_id_to_string(str, &app, sizeof(str));
 368                 ul_logerr("No resource allocator found for %d.%d and %s\n",
 369                           resource->key.type, resource->key.id, str);
 370                 ret = -1;
 371                 goto err;
 372         }
 373
 374         ids._length = ids._maximum = 1;
 375         ids._buffer = id_buffer;
 376         ret = fres_resource_allocator_cancel_vreses(ra->ra, &ids, ev);
 377         if (ret) {
 378                 ul_logerr("Cannot cancel vres\n");
 379                 goto err;
 380         }
 381         fres_resource_manager_cancel_contracts(resource->mng, &ids, ev);
 382
 383         return 0;
 384 err:
 385         return ret;
 386 }
 387
 388 CORBA_long register_resource(fres_contract_broker obj,
 389                             const frsh_resource_type_t restype,
 390                             const frsh_resource_id_t resid,
 391                             const fres_resource_desc *desc,
 392                             CORBA_Environment *ev)
 393 {
 394         struct fcb *fcb = o2fcb(obj);
 395         struct resource *res, *res2;
 396
 397         res = malloc(sizeof(*res));
 398         if (!res) goto err;
 399         memset(res, 0, sizeof(*res));
 400         res->key.type = restype;
 401         res->key.id = resid;
 402         res2 = fcb_resource_find(fcb, &res->key);
 403         if (res2) {
 404                 if (forb_object_is_stale(res2->mng)) {
 405                         ul_logmsg("Removing stale manager for resource %d.%d\n",
 406                                   restype, resid);
 407                         forb_object_release(res2->mng);
 408                         fcb_resource_delete(fcb, res2);
 409                         /* TODO: Delete also all allocators associated
 410                          * with this stale resource manager. */
 411                         free(res);
 412                         res = res2;
 413                 } else {
 414                         ul_logerr("Resource manager %d.%d already registered\n",
 415                                   restype, resid);
 416                         goto free_err;
 417                 }
 418         }
 419         res->mng = forb_object_duplicate(desc->manager);
 420
 421         fcb_alloc_init_root_field(res);
 422         ul_logmsg("Registering manager for resource %d.%d\n",
 423                   restype, resid);
 424         fcb_resource_insert(fcb, res);
 425         return 0;
 426 free_err:
 427         free(res);
 428 err:
 429         return -1;
 430 }
 431
 432
 433 CORBA_long register_allocator(fres_contract_broker obj,
 434                               const frsh_resource_type_t restype,
 435                               const frsh_resource_id_t resid,
 436                               const fres_resource_allocator ra_obj,
 437                               CORBA_Environment *ev)
 438 {
 439         struct fcb *fcb = o2fcb(obj);
 440         struct resource *res;
 441         struct res_alloc *ra;
 442         struct res_key resource;
 443         forb_server_id server_id;
 444         char server_id_str[40];
 445
 446         forb_get_server_id(ra_obj, &server_id);
 447         forb_server_id_to_string(server_id_str, &server_id, sizeof(server_id_str));
 448         ul_logmsg("Registering allocator for resource %d.%d in app %s\n",
 449                   restype, resid, server_id_str);
 450
 451         resource.type = restype;
 452         resource.id = resid;
 453         res = fcb_resource_find(fcb, &resource);
 454         if (!res) {
 455                 ul_logerr("No manager found for %d.%d. Unable to register the allocator!\n",
 456                           restype, resid);
 457                 goto err;
 458         }
 459         ra = fcb_alloc_find(res, &server_id);
 460         if (ra) {
 461                 char *str = forb_object_to_string(ra_obj);
 462                 ul_logerr("Allocator from already registered (%s)\n",
 463                           str);
 464                 forb_free(str);
 465                 goto err;
 466         }
 467         ra = malloc(sizeof(*ra));
 468         if (!ra) {
 469                 goto err;
 470         }
 471         ra->app = server_id;
 472         ra->ra = forb_object_duplicate(ra_obj);
 473         fcb_alloc_insert(res, ra);
 474         return 0;
 475 err:
 476         return -1;
 477 }
 478
 479 #ifdef CONFIG_FCB_INET
 480 static int register_inet_port(forb_orb orb)
 481 {
 482         forb_port_t *port = forb_malloc(sizeof(*port));
 483         int ret;
 484         struct in_addr listen_on;
 485
 486         if (!port)
 487                 return -1;
 488         memset(port, 0, sizeof(*port));
 489         listen_on.s_addr = INADDR_ANY;
 490         ret = forb_inet_port_init(&port->desc, listen_on);
 491         if (ret) error(1, errno, "INET port initialization failed");
 492         ret = forb_register_port(orb, port);
 493         if (ret) error(1, errno /* TODO: FOSA errno */,
 494                        "INET port registration failed");
 495         return 0;
 496 }
 497 #endif
 498
 499 struct forb_fres_contract_broker_impl impl = {
 500         .negotiate_contract = negotiate_contract,
 501         .cancel_contract = cancel_contract,
 502         .register_resource = register_resource,
 503         .register_allocator = register_allocator,
 504 };
 505
 506 int main(int argc, char *argv[])
 507 {
 508         forb_orb orb;
 509         struct fcb fcb_data;
 510         fres_contract_broker fcb;
 511         forb_executor_t executor;
 512         int ret;
 513
 514         orb = forb_init(&argc, &argv, "fcb");
 515         if (!orb) error(1, errno, "FORB initialization failed");
 516
 517 #ifdef CONFIG_FCB_INET
 518         ret = register_inet_port(orb);
 519         if (ret) error(1, errno, "INET port registration failed");
 520 #endif
 521
 522         fcb_resource_init_root_field(&fcb_data);
 523
 524         fcb = forb_fres_contract_broker_new(orb, &impl, &fcb_data);
 525         if (!fcb) error(1, errno, "forb_fres_contract_broker_new failed");
 526
 527         /* Prepare executor before we register the fcb reference,
 528          * so that no reuqests are lost */
 529         ret = forb_executor_init(&executor);
 530         if (ret) error(1, errno, "forb_executor_init failed");
 531
 532         ret = forb_executor_register_object(&executor, fcb);
 533         if (ret) error(1, errno, "forb_executor_register_object failed");
 534
 535         ret = forb_register_reference(fcb, fres_contract_broker_reg_name);
 536         if (ret) error(1, errno, "forb_register_reference() failed");
 537
 538         ul_logmsg("Waiting for requests\n");
 539         ret = forb_executor_run(&executor);
 540         if (ret) error(1, errno, "forb_executor_run failed");
 541
 542         return 0;
 543 }