2 * Copyright (c) 2012, Intel Corporation
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions are
8 * * Redistributions of source code must retain the above copyright notice,
9 * this list of conditions and the following disclaimer.
10 * * Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
13 * * Neither the name of Intel Corporation nor the names of its contributors
14 * may be used to endorse or promote products derived from this software
15 * without specific prior written permission.
17 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
21 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
23 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
35 #include <murphy/common/mm.h>
36 #include <murphy/common/hashtbl.h>
37 #include <murphy/common/utils.h>
38 #include <murphy/common/log.h>
40 #include <murphy-db/mqi.h>
42 #include <murphy/resource/manager-api.h>
43 #include <murphy/resource/client-api.h>
44 #include <murphy/resource/config-api.h>
46 #include "resource-owner.h"
47 #include "application-class.h"
48 #include "resource-set.h"
51 #include "resource-lua.h"
53 #define NAME_LENGTH 24
56 #define ZONE_NAME_IDX 1
57 #define CLASS_NAME_IDX 2
59 #define FIRST_ATTRIBUTE_IDX 4
63 const char *zone_name;
64 const char *class_name;
66 mrp_attr_value_t attrs[MQI_COLUMN_MAX];
69 static mrp_resource_owner_t resource_owners[MRP_ZONE_MAX * MRP_RESOURCE_MAX];
70 static mqi_handle_t owner_tables[MRP_RESOURCE_MAX];
72 static mrp_resource_owner_t *get_owner(uint32_t, uint32_t);
73 static void reset_owners(uint32_t, mrp_resource_owner_t *);
74 static bool grant_ownership(mrp_resource_owner_t *, mrp_zone_t *,
75 mrp_application_class_t *, mrp_resource_set_t *,
77 static bool advice_ownership(mrp_resource_owner_t *, mrp_zone_t *,
78 mrp_application_class_t *, mrp_resource_set_t *,
81 static void manager_start_transaction(mrp_zone_t *);
82 static void manager_end_transaction(mrp_zone_t *);
84 static void delete_resource_owner(mrp_zone_t *, mrp_resource_t *);
85 static void insert_resource_owner(mrp_zone_t *, mrp_application_class_t *,
86 mrp_resource_set_t *, mrp_resource_t *);
87 static void update_resource_owner(mrp_zone_t *, mrp_application_class_t *,
88 mrp_resource_set_t *, mrp_resource_t *);
89 static void set_attr_descriptors(mqi_column_desc_t *, mrp_resource_t *);
92 int mrp_resource_owner_create_database_table(mrp_resource_def_t *rdef)
94 MQI_COLUMN_DEFINITION_LIST(base_coldefs,
95 MQI_COLUMN_DEFINITION( "zone_id" , MQI_UNSIGNED ),
96 MQI_COLUMN_DEFINITION( "zone_name" , MQI_VARCHAR(NAME_LENGTH) ),
97 MQI_COLUMN_DEFINITION( "application_class", MQI_VARCHAR(NAME_LENGTH) ),
98 MQI_COLUMN_DEFINITION( "resource_set_id" , MQI_UNSIGNED )
101 MQI_INDEX_DEFINITION(indexdef,
102 MQI_INDEX_COLUMN( "zone_id" )
105 static bool initialized = false;
108 mqi_column_def_t coldefs[MQI_COLUMN_MAX + 1];
109 mqi_column_def_t *col;
117 for (i = 0; i < MRP_RESOURCE_MAX; i++)
118 owner_tables[i] = MQI_HANDLE_INVALID;
122 MRP_ASSERT(sizeof(base_coldefs) < sizeof(coldefs),"too many base columns");
123 MRP_ASSERT(rdef, "invalid argument");
124 MRP_ASSERT(rdef->id < MRP_RESOURCE_MAX, "confused with data structures");
125 MRP_ASSERT(owner_tables[rdef->id] == MQI_HANDLE_INVALID,
126 "owner table already exist");
128 snprintf(name, sizeof(name), "%s_owner", rdef->name);
129 for (p = name; (c = *p); p++) {
130 if (!isascii(c) || (!isalnum(c) && c != '_'))
134 j = MQI_DIMENSION(base_coldefs) - 1;
135 memcpy(coldefs, base_coldefs, j * sizeof(mqi_column_def_t));
137 for (i = 0; i < rdef->nattr && j < MQI_COLUMN_MAX; i++, j++) {
139 atd = rdef->attrdefs + i;
141 col->name = atd->name;
142 col->type = atd->type;
143 col->length = (col->type == mqi_string) ? NAME_LENGTH : 0;
147 memset(coldefs + j, 0, sizeof(mqi_column_def_t));
149 table = MQI_CREATE_TABLE(name, MQI_TEMPORARY, coldefs, indexdef);
151 if (table == MQI_HANDLE_INVALID) {
152 mrp_log_error("Can't create table '%s': %s", name, strerror(errno));
156 owner_tables[rdef->id] = table;
161 void mrp_resource_owner_recalc(uint32_t zoneid)
163 mrp_resource_owner_update_zone(zoneid, NULL, 0);
166 void mrp_resource_owner_update_zone(uint32_t zoneid,
167 mrp_resource_set_t *reqset,
172 mrp_resource_set_t *rset;
176 mrp_resource_owner_t oldowners[MRP_RESOURCE_MAX];
177 mrp_resource_owner_t backup[MRP_RESOURCE_MAX];
179 mrp_application_class_t *class;
180 mrp_resource_set_t *rset;
182 mrp_resource_def_t *rdef;
183 mrp_resource_mgr_ftbl_t *ftbl;
184 mrp_resource_owner_t *owner, *old, *owners;
185 mrp_resource_mask_t mask;
186 mrp_resource_mask_t mandatory;
187 mrp_resource_mask_t grant;
188 mrp_resource_mask_t advice;
189 void *clc, *rsc, *rc;
195 mrp_resource_event_t notify;
197 uint32_t nevent, maxev;
198 event_t *events, *ev, *lastev;
199 mqi_handle_t trans_handle;
201 MRP_ASSERT(zoneid < MRP_ZONE_MAX, "invalid argument");
203 zone = mrp_zone_find_by_id(zoneid);
205 MRP_ASSERT(zone, "zone is not defined");
207 if (!(maxev = mrp_get_resource_set_count()))
211 events = mrp_alloc(sizeof(event_t) * maxev);
213 MRP_ASSERT(events, "Memory alloc failure. Can't update zone");
215 reset_owners(zoneid, oldowners);
216 manager_start_transaction(zone);
218 rcnt = mrp_resource_definition_count();
221 while ((class = mrp_application_class_iterate_classes(&clc))) {
224 while ((rset=mrp_application_class_iterate_rsets(class,zoneid,&rsc))) {
225 force_release = false;
226 mandatory = rset->resource.mask.mandatory;
231 switch (rset->state) {
233 case mrp_resource_acquire:
234 while ((res = mrp_resource_set_iterate_resources(rset, &rc))) {
237 owner = get_owner(zoneid, rid);
239 backup[rid] = *owner;
241 if (grant_ownership(owner, zone, class, rset, res))
242 grant |= ((mrp_resource_mask_t)1 << rid);
244 if (owner->rset != rset)
245 force_release |= owner->modal;
248 owners = get_owner(zoneid, 0);
249 if ((grant & mandatory) == mandatory &&
250 mrp_resource_lua_veto(zone, rset, owners, grant, reqset))
255 /* rollback, ie. restore the backed up state */
257 while ((res=mrp_resource_set_iterate_resources(rset,&rc))){
260 mask = (mrp_resource_mask_t)1 << rid;
261 owner = get_owner(zoneid, rid);
262 *owner = backup[rid];
264 if ((grant & mask)) {
265 if ((ftbl = rdef->manager.ftbl) && ftbl->free)
266 ftbl->free(zone, res, rdef->manager.userdata);
269 if (advice_ownership(owner, zone, class, rset, res))
275 if ((advice & mandatory) != mandatory)
278 mrp_resource_lua_set_owners(zone, owners);
282 case mrp_resource_release:
283 while ((res = mrp_resource_set_iterate_resources(rset, &rc))) {
286 owner = get_owner(zoneid, rid);
288 if (advice_ownership(owner, zone, class, rset, res))
289 advice |= ((mrp_resource_mask_t)1 << rid);
291 if ((advice & mandatory) != mandatory)
302 replyid = (reqset == rset && reqid == rset->request.id) ? reqid:0;
306 move = (rset->state != mrp_resource_release);
307 notify = move ? MRP_RESOURCE_EVENT_RELEASE : 0;
308 changed = move || rset->resource.mask.grant;
309 rset->state = mrp_resource_release;
310 rset->resource.mask.grant = 0;
313 if (grant == rset->resource.mask.grant) {
314 if (rset->state == mrp_resource_acquire &&
315 !grant && rset->dont_wait.current)
317 rset->state = mrp_resource_release;
318 rset->dont_wait.current = rset->dont_wait.client;
320 notify = MRP_RESOURCE_EVENT_RELEASE;
325 rset->resource.mask.grant = grant;
328 if (rset->state != mrp_resource_release &&
329 !grant && rset->auto_release.current)
331 rset->state = mrp_resource_release;
332 rset->auto_release.current = rset->auto_release.client;
334 notify = MRP_RESOURCE_EVENT_RELEASE;
341 mrp_resource_set_notify(rset, notify);
344 if (advice != rset->resource.mask.advice) {
345 rset->resource.mask.advice = advice;
349 if (replyid || changed) {
350 ev = events + nevent++;
352 ev->replyid = replyid;
359 manager_end_transaction(zone);
361 for (lastev = (ev = events) + nevent; ev < lastev; ev++) {
365 mrp_application_class_move_resource_set(rset);
367 mrp_resource_set_updated(rset);
369 /* first we send out the revoke/deny events
370 * followed by the grants (in the next for loop)
372 if (rset->event && !rset->resource.mask.grant)
373 rset->event(ev->replyid, rset, rset->user_data);
376 for (lastev = (ev = events) + nevent; ev < lastev; ev++) {
379 if (rset->event && rset->resource.mask.grant)
380 rset->event(ev->replyid, rset, rset->user_data);
385 trans_handle = MQI_HANDLE_INVALID;
387 for (rid = 0; rid < rcnt; rid++) {
388 owner = get_owner(zoneid, rid);
389 old = oldowners + rid;
391 if (owner->class != old->class ||
392 owner->rset != old->rset ||
393 owner->res != old->res )
395 if (trans_handle == MQI_HANDLE_INVALID)
396 trans_handle = MQI_BEGIN;
399 delete_resource_owner(zone,old->res);
401 insert_resource_owner(zone,owner->class,owner->rset,owner->res);
403 update_resource_owner(zone,owner->class,owner->rset,owner->res);
407 if (trans_handle != MQI_HANDLE_INVALID)
408 MQI_COMMIT(trans_handle);
411 int mrp_resource_owner_print(char *buf, int len)
413 #define PRINT(fmt, args...) if (p<e) { p += snprintf(p, e-p, fmt , ##args); }
416 mrp_resource_owner_t *owner;
417 mrp_application_class_t *class;
418 mrp_resource_set_t *rset;
420 mrp_resource_def_t *rdef;
428 MRP_ASSERT(buf, "invalid argument");
430 rcnt = mrp_resource_definition_count();
431 zcnt = mrp_zone_count();
435 PRINT("Resource owners:\n");
437 for (zid = 0; zid < zcnt; zid++) {
438 zone = mrp_zone_find_by_id(zid);
441 PRINT(" Zone %u:\n", zid);
444 PRINT(" Zone %s:", zone->name);
445 p += mrp_zone_attribute_print(zone, p, e-p);
449 for (rid = 0; rid < rcnt; rid++) {
450 if (!(rdef = mrp_resource_definition_find_by_id(rid)))
453 PRINT(" %-15s: ", rdef->name);
455 owner = get_owner(zid, rid);
457 if (!(class = owner->class) ||
458 !(rset = owner->rset ) ||
459 !(res = owner->res ) )
464 MRP_ASSERT(rdef == res->def, "confused with data structures");
466 PRINT("%-15s", class->name);
468 p += mrp_resource_attribute_print(res, p, e-p);
481 static mrp_resource_owner_t *get_owner(uint32_t zone, uint32_t resid)
483 MRP_ASSERT(zone < MRP_ZONE_MAX && resid < MRP_RESOURCE_MAX,
486 return resource_owners + (zone * MRP_RESOURCE_MAX + resid);
489 static void reset_owners(uint32_t zone, mrp_resource_owner_t *oldowners)
491 mrp_resource_owner_t *owners = get_owner(zone, 0);
492 size_t size = sizeof(mrp_resource_owner_t) * MRP_RESOURCE_MAX;
496 memcpy(oldowners, owners, size);
498 memset(owners, 0, size);
500 for (i = 0; i < MRP_RESOURCE_MAX; i++)
501 owners[i].share = true;
504 static bool grant_ownership(mrp_resource_owner_t *owner,
506 mrp_application_class_t *class,
507 mrp_resource_set_t *rset,
510 mrp_resource_def_t *rdef = res->def;
511 mrp_resource_mgr_ftbl_t *ftbl = rdef->manager.ftbl;
512 bool set_owner = false;
522 do { /* not a loop */
523 if (!owner->class && !owner->rset) {
524 /* nobody owns this, so grab it */
529 if (owner->class == class && owner->rset == rset) {
530 /* we happen to already own it */
534 if (rdef->shareable && owner->share) {
535 /* OK, someone else owns it but
536 the owner is ready to share it with us */
544 if (ftbl && ftbl->allocate) {
545 if (!ftbl->allocate(zone, res, rdef->manager.userdata))
550 owner->class = class;
553 owner->modal = class->modal;
556 owner->share = class->share && res->shared;
561 static bool advice_ownership(mrp_resource_owner_t *owner,
563 mrp_application_class_t *class,
564 mrp_resource_set_t *rset,
567 mrp_resource_def_t *rdef = res->def;
568 mrp_resource_mgr_ftbl_t *ftbl = rdef->manager.ftbl;
580 do { /* not a loop */
581 if (!owner->class && !owner->rset)
582 /* nobody owns this */
586 /* someone else owns it but it can be shared */
589 if (owner->class == class) {
590 if (owner->rset->class.priority == rset->class.priority &&
591 class->order == MRP_RESOURCE_ORDER_LIFO)
592 /* same class and resource goes to the last one who asks it */
600 if (ftbl && ftbl->advice) {
601 if (!ftbl->advice(zone, res, rdef->manager.userdata))
608 static void manager_start_transaction(mrp_zone_t *zone)
610 mrp_resource_def_t *rdef;
611 mrp_resource_mgr_ftbl_t *ftbl;
614 while ((rdef = mrp_resource_definition_iterate_manager(&cursor))) {
615 ftbl = rdef->manager.ftbl;
617 MRP_ASSERT(ftbl, "confused with data structures");
620 ftbl->init(zone, rdef->manager.userdata);
624 static void manager_end_transaction(mrp_zone_t *zone)
626 mrp_resource_def_t *rdef;
627 mrp_resource_mgr_ftbl_t *ftbl;
630 while ((rdef = mrp_resource_definition_iterate_manager(&cursor))) {
631 ftbl = rdef->manager.ftbl;
633 MRP_ASSERT(ftbl, "confused with data structures");
636 ftbl->commit(zone, rdef->manager.userdata);
641 static void delete_resource_owner(mrp_zone_t *zone, mrp_resource_t *res)
643 static uint32_t zone_id;
645 MQI_WHERE_CLAUSE(where,
646 MQI_EQUAL( MQI_COLUMN(0), MQI_UNSIGNED_VAR(zone_id) )
649 mrp_resource_def_t *rdef;
652 MRP_ASSERT(res, "invalid argument");
657 if ((n = MQI_DELETE(owner_tables[rdef->id], where)) != 1)
658 mrp_log_error("Could not delete resource owner");
661 static void insert_resource_owner(mrp_zone_t *zone,
662 mrp_application_class_t *class,
663 mrp_resource_set_t *rset,
666 mrp_resource_def_t *rdef = res->def;
670 owner_row_t *rows[2];
671 mqi_column_desc_t cdsc[FIRST_ATTRIBUTE_IDX + MQI_COLUMN_MAX + 1];
673 MRP_ASSERT(FIRST_ATTRIBUTE_IDX + rdef->nattr <= MQI_COLUMN_MAX,
674 "too many attributes for a table");
676 row.zone_id = zone->id;
677 row.zone_name = zone->name;
678 row.class_name = class->name;
679 row.rset_id = rset->id;
680 memcpy(row.attrs, res->attrs, rdef->nattr * sizeof(mrp_attr_value_t));
683 cdsc[i].cindex = ZONE_ID_IDX;
684 cdsc[i].offset = MQI_OFFSET(owner_row_t, zone_id);
687 cdsc[i].cindex = ZONE_NAME_IDX;
688 cdsc[i].offset = MQI_OFFSET(owner_row_t, zone_name);
691 cdsc[i].cindex = CLASS_NAME_IDX;
692 cdsc[i].offset = MQI_OFFSET(owner_row_t, class_name);
695 cdsc[i].cindex = RSET_ID_IDX;
696 cdsc[i].offset = MQI_OFFSET(owner_row_t, rset_id);
698 set_attr_descriptors(cdsc + (i+1), res);
703 if ((n = MQI_INSERT_INTO(owner_tables[rdef->id], cdsc, rows)) != 1)
704 mrp_log_error("can't insert row into owner table");
707 static void update_resource_owner(mrp_zone_t *zone,
708 mrp_application_class_t *class,
709 mrp_resource_set_t *rset,
712 static uint32_t zone_id;
714 MQI_WHERE_CLAUSE(where,
715 MQI_EQUAL( MQI_COLUMN(0), MQI_UNSIGNED_VAR(zone_id) )
718 mrp_resource_def_t *rdef = res->def;
722 mqi_column_desc_t cdsc[FIRST_ATTRIBUTE_IDX + MQI_COLUMN_MAX + 1];
726 MRP_ASSERT(1 + rdef->nattr <= MQI_COLUMN_MAX,
727 "too many attributes for a table");
729 row.class_name = class->name;
730 row.rset_id = rset->id;
731 memcpy(row.attrs, res->attrs, rdef->nattr * sizeof(mrp_attr_value_t));
734 cdsc[i].cindex = CLASS_NAME_IDX;
735 cdsc[i].offset = MQI_OFFSET(owner_row_t, class_name);
738 cdsc[i].cindex = RSET_ID_IDX;
739 cdsc[i].offset = MQI_OFFSET(owner_row_t, rset_id);
741 set_attr_descriptors(cdsc + (i+1), res);
744 if ((n = MQI_UPDATE(owner_tables[rdef->id], cdsc, &row, where)) != 1)
745 mrp_log_error("can't update row in owner table");
749 static void set_attr_descriptors(mqi_column_desc_t *cdsc, mrp_resource_t *res)
751 mrp_resource_def_t *rdef = res->def;
755 for (i = j = 0; j < rdef->nattr; j++) {
756 switch (rdef->attrdefs[j].type) {
757 case mqi_string: o = MQI_OFFSET(owner_row_t,attrs[j].string); break;
758 case mqi_integer: o = MQI_OFFSET(owner_row_t,attrs[j].integer); break;
759 case mqi_unsignd: o = MQI_OFFSET(owner_row_t,attrs[j].unsignd); break;
760 case mqi_floating: o = MQI_OFFSET(owner_row_t,attrs[j].floating);break;
761 default: /* skip this */ continue;
764 cdsc[i].cindex = FIRST_ATTRIBUTE_IDX + j;
777 * indent-tabs-mode: nil