/usr/include/ug/xfer.h is in libug-dev 3.12.1-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 | // -*- tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*-
// vi: set et ts=4 sw=2 sts=2:
/****************************************************************************/
/* */
/* File: xfer.h */
/* */
/* Purpose: header file for xfer module */
/* */
/* Author: Klaus Birken */
/* Rechenzentrum Uni Stuttgart */
/* Universitaet Stuttgart */
/* Allmandring 30 */
/* 70550 Stuttgart */
/* internet: birken@rus.uni-stuttgart.de */
/* */
/* */
/* History: 931122 kb begin */
/* 950404 kb copied from dddi.h */
/* 960718 kb introduced lowcomm-layer (sets of messages) */
/* */
/* Remarks: */
/* */
/****************************************************************************/
/* RCS_ID
$Header$
*/
/****************************************************************************/
/* */
/* auto include mechanism and other include files */
/* */
/****************************************************************************/
#ifndef __XFER_H__
#define __XFER_H__
#define DebugXfer 10 /* 0 is all, 10 is off */
#define DebugPack 6 /* off: 6 */
#define DebugUnpack 5 /* off: 5 */
#define DebugCmdMsg 10 /* off: 10 */
#define DebugCplMsg 10 /* off: 10 */
#include "basic/lowcomm.h"
#include "basic/oopp.h" /* for object-orientated style via preprocessor */
#include "sll.h" /* TODO: remove this in future versions */
START_UGDIM_NAMESPACE
#define SUPPORT_RESENT_FLAG
/* define this to use as small types as possible. for debugging, try it
without this define */
#define SMALL_TYPES_BY_CASTS
/****************************************************************************/
/* */
/* defines in the following order */
/* */
/* compile time constants defining static data size (i.e. arrays) */
/* other constants */
/* macros */
/* */
/****************************************************************************/
/* some macros for customizing oopp */
#define _NEWPARAMS
#define _NEWPARAMS_OR_VOID void
#define __INDENT(n) { int i; for(i=0; i<n; i++) fputs(" ",fp);}
#define _PRINTPARAMS , int indent, FILE *fp
#define _PRINTPARAMS_DEFAULT ,0,stdout
#define _INDENT __INDENT(indent)
#define _INDENT1 __INDENT(indent+1)
#define _INDENT2 __INDENT(indent+2)
#define _PRINTNEXT , indent+1, fp
#define _PRINTSAME , indent, fp
/* map memory allocation calls */
/* activate this to allocate memory from freelists */
#ifdef XferMemFromHeap
#define OO_Allocate xfer_AllocHeap
#define OO_Free xfer_FreeHeap
#else
#define OO_Allocate xfer_AllocTmp
#define OO_Free xfer_FreeTmp
#endif
/* extra prefix for all xfer-related data structures and/or typedefs */
/*#define ClassPrefix*/
/* types of 'newness' of incoming object (for xferunpack.c) */
enum XferNewType {
NOTNEW = 0x00, /* object is not new */
PARTNEW = 0x01, /* object has been updated partially */
PRUNEDNEW = 0x02, /* object is new due to PruneDel (see cmdmsg.c)*/
TOTALNEW = 0x04, /* object has been updated completely */
OTHERMSG = 0x08, /* object is taken from another message */
THISMSG = 0x10 /* object is taken from this msg, temp setting */
};
/* overall mode of transfer */
enum XferMode {
XMODE_IDLE = 0, /* waiting for next DDD_XferBegin() */
XMODE_CMDS, /* after DDD_XferBegin(), before DDD_XferEnd() */
XMODE_BUSY /* during DDD_XferEnd() */
};
/****************************************************************************/
#ifdef SMALL_TYPES_BY_CASTS
#define DDD_PRIO_SMALL unsigned char
#define DDD_TYPE_SMALL unsigned char
#else
#define DDD_PRIO_SMALL DDD_PRIO
#define DDD_TYPE_SMALL DDD_TYPE
#endif
/****************************************************************************/
/* */
/* data structures exported by the corresponding source file */
/* */
/****************************************************************************/
/****************************************************************************/
/* XFERADDDATA: description of additional data on sender side */
/****************************************************************************/
typedef struct xferaddinfo {
int addCnt;
DDD_TYPE addTyp;
int addLen; /* length of additional data */
int addNPointers;
int *sizes;
struct xferaddinfo *next;
} XFERADDDATA;
/****************************************************************************/
/* XICopyObj: */
/****************************************************************************/
#define ClassName XICopyObj
Class_Data_Begin
DDD_HDR hdr; /* local obj for which a copy should be created */
DDD_GID gid; /* gid of local object */
DDD_PROC dest; /* proc involved with operation, me -> proc */
DDD_PRIO prio; /* priority for new object copy */
size_t size; /* V1.2: needed for variable-sized objects */
int addLen;
XFERADDDATA *add; /* additional data items */
int flags;
Class_Data_End
void Method(Print) (DefThis _PRINTPARAMS);
int Method(Compare) (ClassPtr, ClassPtr);
#undef ClassName
/* define container class */
#ifndef SetOf /* necessary for inline documentation only */
#define SetOf XICopyObj
#define Set_SegmSize 256
#define Set_BTreeOrder 32
#ifdef XferMemFromHeap
#define ArrayAllocate xfer_AllocHeap
#define NoArrayFree
#endif
#endif
#include "basic/ooppcc.h"
/* usage of flags in XICopyObj */
/* usage of 0x01 while PruneXIDelCpl, temporarily */
#define MASK_CO_SELF 0x00000001
#define CO_SELF(c) (((int)((c)->flags))&MASK_CO_SELF)
#define SET_CO_SELF(c,d) ((c)->flags) = \
((((c)->flags)&(~MASK_CO_SELF)) | ((d)&MASK_CO_SELF))
/* usage of 0x02 for new_owner:
did destination proc know the object's gid before? */
#define MASK_CO_NEWOWNER 0x00000002
#define CO_NEWOWNER(c) (((int)((c)->flags))&MASK_CO_NEWOWNER)
#define SET_CO_NEWOWNER(c) ((c)->flags) = (((c)->flags) | MASK_CO_NEWOWNER)
#define CLEAR_CO_NEWOWNER(c) ((c)->flags) = (((c)->flags)&(~MASK_CO_NEWOWNER))
/****************************************************************************/
/* XIDelObj: */
/****************************************************************************/
/* XIDelCmd represents a XferDeleteObj-cmd by the application program */
typedef struct _XIDelCmd
{
SLL_INFO_WITH_COUNTER(_XIDelCmd);
DDD_HDR hdr;
#ifdef CPP_FRONTEND
DDD_Object *obj;
#endif
} XIDelCmd;
/* include template */
#define T XIDelCmd
#define SLL_WithOrigOrder
#include "sll.ht"
#undef T
/* XIDelObj represents an object-delete-action (cf. XferRegisterDelete()) */
typedef struct _XIDelObj
{
SLL_INFO(_XIDelObj);
DDD_GID gid; /* gid of local object */
/* hdr is explicitly not stored here, because object may be deleted
when this XIDelObj-item is evaluated. */
struct _XIDelCpl *delcpls; /* couplings of deleted object */
} XIDelObj;
/* include template */
#define T XIDelObj
#include "sll.ht"
#undef T
/****************************************************************************/
/* XISetPrio: */
/****************************************************************************/
#define ClassName XISetPrio
Class_Data_Begin
DDD_HDR hdr; /* local obj for which prio should be set */
DDD_GID gid; /* gid of local object */
DDD_PRIO prio; /* new priority */
int is_valid; /* invalid iff there's a DelObj for same gid */
Class_Data_End
void Method(Print) (DefThis _PRINTPARAMS);
int Method(Compare) (ClassPtr, ClassPtr);
#undef ClassName
/* define container class */
#ifndef SetOf /* necessary for inline documentation only */
#define SetOf XISetPrio
#define Set_SegmSize 256
#define Set_BTreeOrder 32
#ifdef XferMemFromHeap
#define ArrayAllocate xfer_AllocHeap
#define NoArrayFree
#endif
#endif
#include "basic/ooppcc.h"
/****************************************************************************/
/* XINewCpl: */
/****************************************************************************/
typedef struct _TENewCpl
{
DDD_GID _gid; /* obj-gid for which new copy will be created */
DDD_PROC _dest; /* destination of new object copy */
DDD_PRIO_SMALL _prio; /* priority of new object copy */
DDD_TYPE_SMALL _type; /* ddd-type of gid for PriorityMerge on receiver*/
} TENewCpl;
#define NewCpl_GetGid(i) ((i)._gid)
#define NewCpl_SetGid(i,d) ((i)._gid = (d))
#define NewCpl_GetDest(i) ((i)._dest)
#define NewCpl_SetDest(i,d) ((i)._dest = (d))
#ifdef SMALL_TYPES_BY_CASTS
#define NewCpl_GetPrio(i) ((DDD_PRIO)(i)._prio)
#define NewCpl_SetPrio(i,d) ((i)._prio = (DDD_PRIO_SMALL)(d))
#define NewCpl_GetType(i) ((DDD_TYPE)(i)._type)
#define NewCpl_SetType(i,d) ((i)._type = (DDD_TYPE_SMALL)(d))
#else
#define NewCpl_GetPrio(i) ((i)._prio)
#define NewCpl_SetPrio(i,d) ((i)._prio = (d))
#define NewCpl_GetType(i) ((i)._type)
#define NewCpl_SetType(i,d) ((i)._type = (d))
#endif
typedef struct _XINewCpl
{
SLL_INFO(_XINewCpl);
DDD_PROC to; /* receiver of this item */
TENewCpl te; /* table entry (for message) */
} XINewCpl;
/* include template */
#define T XINewCpl
#include "sll.ht"
#undef T
/****************************************************************************/
/* XIOldCpl: */
/****************************************************************************/
typedef struct _TEOldCpl
{
DDD_GID gid; /* obj-gid of local copy */
DDD_PROC proc; /* owner of that local object */
DDD_PRIO prio; /* priority of that local object */
} TEOldCpl;
typedef struct _XIOldCpl
{
SLL_INFO(_XIOldCpl);
DDD_PROC to; /* receiver of this item */
TEOldCpl te; /* table entry (for message) */
} XIOldCpl;
/* include template */
#define T XIOldCpl
#include "sll.ht"
#undef T
/****************************************************************************/
/* XIAddCpl: */
/****************************************************************************/
typedef struct _TEAddCpl
{
DDD_GID gid; /* obj-gid of new local object */
DDD_PROC proc; /* owner of new object copy */
DDD_PRIO prio; /* priority of new local object */
} TEAddCpl;
typedef struct _XIAddCpl
{
SLL_INFO(_XIAddCpl);
DDD_PROC to; /* receiver of this item */
TEAddCpl te; /* table entry (for message) */
} XIAddCpl;
/* include template */
#define T XIAddCpl
#include "sll.ht"
#undef T
/****************************************************************************/
/* XIDelCpl: */
/****************************************************************************/
typedef struct _TEDelCpl
{
DDD_GID gid; /* obj-gid of deleted local object */
} TEDelCpl;
typedef struct _XIDelCpl
{
SLL_INFO(_XIDelCpl);
DDD_PROC to; /* receiver of this item */
TEDelCpl te; /* table entry (for message) */
DDD_PRIO prio; /* prio of deleted coupling */
struct _XIDelCpl *next; /* linked list of XIDelCpls */
} XIDelCpl;
/* include template */
#define T XIDelCpl
#include "sll.ht"
#undef T
/****************************************************************************/
/* XIModCpl: */
/****************************************************************************/
typedef struct _TEModCpl
{
DDD_GID gid; /* obj-gid of corresponding object */
DDD_PRIO prio; /* new priority for this obj on sending proc */
} TEModCpl;
typedef struct _XIModCpl
{
SLL_INFO(_XIModCpl);
DDD_PROC to; /* receiver of this item */
TEModCpl te; /* table entry (for message) */
DDD_TYPE typ; /* type of corresponding object */
} XIModCpl;
/* include template */
#define T XIModCpl
#include "sll.ht"
#undef T
/****************************************************************************/
/* XFERMSG: complete description about message on sender side */
/****************************************************************************/
typedef struct _XFERMSG
{
DDD_PROC proc; /* receiver of message */
size_t size; /* size of message data */
struct _XFERMSG *next;
XICopyObjPtr *xferObjArray;
int nObjItems;
XINewCpl **xferNewCpl;
int nNewCpl;
XIOldCpl **xferOldCpl;
int nOldCpl;
int nPointers;
int nObjects;
/* lowcomm message handle */
LC_MSGHANDLE msg_h;
} XFERMSG;
/****************************************************************************/
/* SYMTAB_ENTRY: single entry of symbol table inside message */
/****************************************************************************/
typedef struct
{
DDD_GID gid;
union {
DDD_HDR hdr; /* used on receiver side only */
DDD_OBJ *ref; /* used on sender side only */
} adr; /* undefined during transfer */
} SYMTAB_ENTRY;
/****************************************************************************/
/* OBJTAB_ENTRY: single entry of object table inside message */
/****************************************************************************/
typedef struct
{
int h_offset; /* header offset from beginObjMem */
int addLen; /* length of additional data */
size_t size; /* size of object, ==desc->len for
fixed-sized objects */
DDD_HDR hdr; /* TODO this is probably not used on sender side */
/* TODO: the following data is only used on receiver side */
char is_new;
char oldprio;
} OBJTAB_ENTRY;
/* NOTE: the following macros require the DDD_HEADER being copied
directly into the message! (with its LDATA!) */
#define OTE_HDR(objmem,ote) ((DDD_HDR)(((char *)(objmem))+((ote)->h_offset)))
#define OTE_OBJ(objmem,ote) OBJ_OBJ(OTE_HDR(objmem,ote))
#define OTE_GID(objmem,ote) OBJ_GID(OTE_HDR(objmem,ote))
#define OTE_PRIO(objmem,ote) OBJ_PRIO(OTE_HDR(objmem,ote))
#define OTE_TYPE(objmem,ote) OBJ_TYPE(OTE_HDR(objmem,ote))
#define OTE_ATTR(objmem,ote) OBJ_ATTR(OTE_HDR(objmem,ote))
/****************************************************************************/
/* DELTAB_ENTRY: single entry of deletion table inside message */
/****************************************************************************/
typedef struct {
DDD_GID gid;
DDD_PROC proc;
} DELTAB_ENTRY;
/****************************************************************************/
/* XFER_PER_PROC: data needed on a per-proc basis during xfer */
/****************************************************************************/
typedef struct _XFER_PER_PROC
{
int dummy; /* not used yet */
} XFER_PER_PROC;
/****************************************************************************/
/* XFER_GLOBALS: global data for xfer module */
/****************************************************************************/
typedef struct _XFER_GLOBALS
{
/* mode of xfer module */
enum XferMode xferMode;
/* description for object message */
LC_MSGTYPE objmsg_t;
LC_MSGCOMP symtab_id, objtab_id;
LC_MSGCOMP newcpl_id, oldcpl_id;
LC_MSGCOMP objmem_id;
/* entry points for global sets */
XICopyObjSet *setXICopyObj;
XISetPrioSet *setXISetPrio;
/* flag for memory control (heap or no heap) */
int useHeap;
/* MarkKey for memory management */
long theMarkKey;
} XFER_GLOBALS;
/* one instance of XFER_GLOBALS */
extern XFER_GLOBALS xferGlobals;
/****************************************************************************/
/****************************************************************************/
/* */
/* function declarations */
/* */
/****************************************************************************/
/* supp.c */
XFERADDDATA *NewXIAddData (void);
void FreeAllXIAddData (void);
int *AddDataAllocSizes(int);
void xfer_SetTmpMem (int);
void *xfer_AllocTmp (size_t);
void *xfer_AllocHeap (size_t);
void xfer_FreeTmp (void *);
void xfer_FreeHeap (void *);
void *xfer_AllocSend (size_t);
void xfer_FreeSend (void *);
/* and others, via template mechanism */
/* cplmsg.c */
void CommunicateCplMsgs (XIDelCpl **, int,
XIModCpl **, int, XIAddCpl **, int, DDD_HDR *, int);
void CplMsgInit (void);
void CplMsgExit (void);
/* cmdmsg.c */
int PruneXIDelCmd (XIDelCmd **, int, XICopyObjPtrArray *);
void CmdMsgInit (void);
void CmdMsgExit (void);
/* xfer.c, used only by cmds.c */
XICopyObj **CplClosureEstimate(XICopyObjPtrArray *, int *);
int PrepareObjMsgs(XICopyObjPtrArray *, XINewCpl **, int,
XIOldCpl **, int, XFERMSG **, size_t *);
void ExecLocalXIDelCmd(XIDelCmd **, int);
void ExecLocalXISetPrio(XISetPrioPtrArray *, XIDelObj **,int, XICopyObj **,int);
void ExecLocalXIDelObj(XIDelObj **, int, XICopyObj **,int);
void PropagateCplInfos(XISetPrio **, int, XIDelObj **, int,
TENewCpl *, int);
enum XferMode XferMode (void);
int XferStepMode(enum XferMode);
/* pack.c, used only by cmds.c */
RETCODE XferPackMsgs (XFERMSG *);
/* unpack.c, used only by cmds.c */
void XferUnpack (LC_MSGHANDLE *, int, const DDD_HDR *, int,
XISetPrioPtrArray *, XIDelObj **, int,
XICopyObjPtrArray *, XICopyObj **, int);
/* ctrl.c */
void XferDisplayMsg (const char *comment, LC_MSGHANDLE);
END_UGDIM_NAMESPACE
#endif
|