UNPACK(3PVM)

💖 UNPACK(3PVM) — bestie, it's time to unload 💖

okay so this is pvm_unpack, from PVM Version 3.4, living in section 3PVM. it's the receiving half of the pack/unpack situationship, and she is iconic for it. 🌸

---

✨ NAME ✨

pvm_unpack — Unpack the active message buffer into arrays of prescribed data type. yes queen, take that buffer and pour it into ur arrays 💅

---

🎀 SYNOPSIS 🎀

C

int info = pvm_unpackf( const char *fmt, ... )
int info = pvm_upkbyte( char *xp, int nitem, int stride)
int info = pvm_upkcplx( float *cp, int nitem, int stride)
int info = pvm_upkdcplx( double *zp, int nitem, int stride)
int info = pvm_upkdouble( double *dp, int nitem, int stride)
int info = pvm_upkfloat( float *fp, int nitem, int stride)
int info = pvm_upkint( int *ip, int nitem, int stride)
int info = pvm_upkuint( unsigned int *ip, int nitem, int stride )
int info = pvm_upkushort( unsigned short *ip, int nitem, int stride )
int info = pvm_upkulong( unsigned long *ip, int nitem, int stride )
int info = pvm_upklong( long *ip, int nitem, int stride)
int info = pvm_upkshort( short *jp, int nitem, int stride)
int info = pvm_upkstr( char *sp )

Fortran

call pvmfunpack( what, xp, nitem, stride, info )

---

🫶 PARAMETERS 🫶

• fmt — a printf-like format expression telling the function what to pack. (there's a whole discussion on this below, keep scrolling bestie)
• nitem — the total number of items to be unpacked. not bytes. ITEMS. do not come for me with bytes. 😭
• stride — the stride used when packing the items. like, for example, if stride = 2 in pvm_upkcplx, then every other complex number gets unpacked. every other one. she's selective. 💅
• xp — pointer to the beginning of a block of bytes. can be any data type, but it has to match the corresponding pack data type, fr fr.
• cp — complex array at least nitem*stride items long.
• zp — double precision complex array at least nitem*stride items long.
• dp — double precision real array at least nitem*stride items long.
• fp — real array at least nitem*stride items long.
• ip — integer array at least nitem*stride items long.
• jp — integer*2 array at least nitem*stride items long.
• sp — pointer to a null terminated character string.
• what — integer specifying the type of data being unpacked. the menu is:
  • STRING — 0
  • BYTE1 — 1
  • INTEGER2 — 2
  • INTEGER4 — 3
  • REAL4 — 4
  • COMPLEX8 — 5
  • REAL8 — 6
  • COMPLEX16 — 7
• info — integer status code returned by the routine. values less than zero mean something went wrong. anything under zero = not the vibe. 💀

---

🌈 DESCRIPTION 🌈

each of the pvm_upk* routines unpacks an array of the given data type out of the active receive buffer. the arguments for each routine are: a pointer to the array you're unpacking into, nitem which is the total number of items to unpack, and stride which is the stride to use when unpacking. simple. clean. she ate.

the one exception is pvm_upkstr(), which by definition unpacks a NULL terminated character string and therefore does not need nitem or stride arguments. she's low maintenance like that. the Fortran routine pvmfunpack( STRING, ... ) expects nitem to be the number of characters in the string and stride to be 1.

if the unpacking goes well, info will be 0. if some error occurs then info will be < 0. no in-between, no nuance, periodt.

a single variable (not an array!!) can be unpacked by setting nitem = 1 and stride = 1. one item, one stride, main character energy. 👑

the routine pvm_unpackf() uses a printf-like format expression to specify what and how to unpack data from the receive buffer. all variables are passed as addresses. here's the BNF-like description of the format syntax, and I'm putting it here verbatim because she's sacred:

format : null | init | format fmt
init : null | '%' '+'
fmt : '%' count stride modifiers fchar
fchar : 'c' | 'd' | 'f' | 'x' | 's'
count : null | [0-9]+ | '*'
stride : null | '.' ( [0-9]+ | '*' )
modifiers : null | modifiers mchar
mchar : 'h' | 'l' | 'u'

Formats:

• + — means initsend — must match an int (how) in the param list.
• c — pack/unpack bytes
• d — integer
• f — float
• x — complex float
• s — string

Modifiers:

• h — short (int)
• l — long (int, float, complex float)
• u — unsigned (int)

'*' count or stride must match an int in the param list. ok bestie, remember that one, it's giving ✨plot twist✨.

future extensions to the what argument in pvmfunpack will include 64 bit types when XDR encoding of these types is available. in the meantime, users should be aware that precision can be lost when passing data from a 64 bit machine like a Cray to a 32 bit machine like a SPARCstation. as a mnemonic, the what argument name includes the number of bytes of precision to expect. by setting encoding to PVMRAW (see pvmfinitsend) data can be transferred between two 64 bit machines with full precision even if the PVM configuration is heterogeneous. slay for the 64 bit girlies 💖

messages should be unpacked exactly like they were packed to insure data integrity. packing integers and unpacking them as floats will often fail because a type encoding will have occurred transferring the data between heterogeneous hosts. packing 10 integers and 100 floats then trying to unpack only 3 integers and the 100 floats will also fail. match the energy you packed with, bestie, that's the rule. 🙈

---

🦋 EXAMPLES 🦋

C:

info = pvm_recv( tid, msgtag );
info = pvm_upkstr( string );
info = pvm_upkint( &size, 1, 1 );
info = pvm_upkint( array, size, 1 );
info = pvm_upkdouble( matrix, size*size, 1 );

int count, *iarry;
double darry[4];
   pvm_unpackf("%d", &count);
   pvm_unpackf("%*d %4lf", count, iarry, darry);

Fortran:

CALL PVMFRECV( TID, MSGTAG, INFO );
CALL PVMFUNPACK( INTEGER4, NSIZE, 1, 1, INFO )
CALL PVMFUNPACK( STRING, STEPNAME, 8, 1, INFO )
CALL PVMFUNPACK( REAL4, A(5,1), NSIZE, NSIZE , INFO )

---

💀 ERRORS 💀

• PvmNoData — reading beyond the end of the receive buffer. most likely cause is trying to unpack more items than were originally packed into the buffer. bestie you cannot take out more than you put in, that's not how the bank works 😭
• PvmBadMsg — the received message can not be decoded. most likely because the hosts are heterogeneous and the user specified an incompatible encoding. try setting the encoding to PvmDataDefault (see pvm_mkbuf). fixable, don't spiral.
• PvmNoBuf — there is no active receive buffer to unpack. nothing to unpack, girl. the buffer is empty. she's not here. 🫠

---

👑 SEE ALSO 👑

pvm_pack(3PVM) pvm_send(3PVM), pvm_recv(3PVM), pvm_pkmesg(3PVM)

---

and that's the whole page, babe 🎀 this was UNPACK(3PVM) from PVM Version 3.4, dated 30 August, 1993 — yes she's vintage, yes she still serves, vintage is a vibe. now go unpack something responsibly. mwah. 💜✨🦋