netatalk  4.4.0
Free and Open Source Apple Filing Protocol (AFP) Server
Loading...
Searching...
No Matches
dsi.h File Reference

DSI (Data Stream Interface) protocol definitions modified for the afptest test-suite. More...

#include <sys/types.h>
#include <sys/time.h>
#include <signal.h>
#include <netinet/in.h>

Go to the source code of this file.

Data Structures

struct  dsi_block
struct  DSI

Macros

#define DSI_BLOCKSIZ   16
#define DSI_CMDSIZ   800
#define DSI_DATASIZ   8192
#define DSIFL_REQUEST   0x00
#define DSIFL_REPLY   0x01
#define DSIFL_MAX   0x01
#define DSIOPT_SERVQUANT   0x00
#define DSIOPT_ATTNQUANT   0x01
#define DSIFUNC_CLOSE   1
#define DSIFUNC_CMD   2
#define DSIFUNC_STAT   3
#define DSIFUNC_OPEN   4
#define DSIFUNC_TICKLE   5
#define DSIFUNC_WRITE   6
#define DSIFUNC_ATTN   8
#define DSIFUNC_MAX   8
#define DSIERR_OK   0x0000
#define DSIERR_BADVERS   0xfbd6
#define DSIERR_BUFSMALL   0xfbd5
#define DSIERR_NOSESS   0xfbd4
#define DSIERR_NOSERV   0xfbd3
#define DSIERR_PARM   0xfbd2
#define DSIERR_SERVBUSY   0xfbd1
#define DSIERR_SESSCLOS   0xfbd0
#define DSIERR_SIZERR   0xfbcf
#define DSIERR_TOOMANY   0xfbce
#define DSIERR_NOACK   0xfbcd
#define DSI_DEFQUANT   2
#define DSI_SERVQUANT_MAX   0xffffffffL
#define DSI_SERVQUANT_MIN   0x0004A2E0L
#define DSI_SERVQUANT_DEF   DSI_SERVQUANT_MIN
#define DSI_AFPOVERTCP_PORT   548
#define dsi_wrtreply(a, b)
#define dsi_serverID(x)
#define dsi_send(x)
#define dsi_receive(x)

Typedefs

typedef struct DSI DSI

Functions

DSI * dsi_init (const char *, const char *, const char *, const int, const int, const uint32_t)
void dsi_setstatus (DSI *, uint8_t *, const int)
void dsi_kill (int)
size_t dsi_stream_write (DSI *, void *, const size_t)
size_t dsi_stream_read (DSI *, void *, const size_t)
 Read data from DSI buffer.
int dsi_stream_send (DSI *, void *, size_t)
 write data.
int dsi_stream_receive (DSI *, void *, const size_t, size_t *)
size_t dsi_writeinit (DSI *, void *, const size_t)
size_t dsi_write (DSI *, void *, const size_t)
void dsi_writeflush (DSI *)
ssize_t dsi_readinit (DSI *, void *, const size_t, const size_t, const int)
 streaming i/o for afp_read.
ssize_t dsi_read (DSI *, void *, const size_t)
void dsi_readdone (DSI *)

Detailed Description

DSI (Data Stream Interface) protocol definitions modified for the afptest test-suite.

The interface for the test-suite differts from the libatalk DSI interface in that is retains a statically allocated buffer for commands as well as smaller command and data buffer sizes that fit in 16 bit size fields.

What a DSI packet looks like:

0 32
|-------------------------------|
|flags |command| requestID |
|-------------------------------|
|error code/enclosed data offset|
|-------------------------------|
|total data length |
|-------------------------------|
|reserved field |
|-------------------------------|
flags
static dbd_flags_t flags
Definition cmd_dbd.c:45
data
#define data
Definition hash.c:37
Note
CONVENTION: anything with a dsi_ prefix is kept in network byte order.

Macro Definition Documentation

◆ DSI_AFPOVERTCP_PORT

#define DSI_AFPOVERTCP_PORT   548

default port number

◆ DSI_BLOCKSIZ

#define DSI_BLOCKSIZ   16

◆ DSI_CMDSIZ

#define DSI_CMDSIZ   800

◆ DSI_DATASIZ

#define DSI_DATASIZ   8192

◆ DSI_DEFQUANT

#define DSI_DEFQUANT   2

default attention quantum size

◆ dsi_receive

#define dsi_receive ( x)
Value:
(dsi_stream_receive((x), (x)->commands, \
DSI_CMDSIZ, &(x)->cmdlen))
dsi_stream_receive
int dsi_stream_receive(DSI *)
Read DSI command and data.
Definition dsi_stream.c:662
DSI_CMDSIZ
#define DSI_CMDSIZ
Definition test/testsuite/dsi.h:53

◆ dsi_send

#define dsi_send ( x)
Value:
do { \
(x)->header.dsi_len = htonl((x)->cmdlen); \
dsi_stream_send((x), (x)->commands, (x)->cmdlen); \
} while (0)
header
static void header(void)
Definition speedtest.c:570

◆ dsi_serverID

#define dsi_serverID ( x)
Value:
((x)->serverID++)

◆ DSI_SERVQUANT_DEF

#define DSI_SERVQUANT_DEF   DSI_SERVQUANT_MIN

default server quantum

◆ DSI_SERVQUANT_MAX

#define DSI_SERVQUANT_MAX   0xffffffffL

server quantum

◆ DSI_SERVQUANT_MIN

#define DSI_SERVQUANT_MIN   0x0004A2E0L

minimum server quantum

◆ dsi_wrtreply

#define dsi_wrtreply ( a,
b )
Value:
dsi_cmdreply(a,b)
dsi_cmdreply
int dsi_cmdreply(DSI *, const int)
Definition dsi_cmdreply.c:19

◆ DSIERR_BADVERS

#define DSIERR_BADVERS   0xfbd6

◆ DSIERR_BUFSMALL

#define DSIERR_BUFSMALL   0xfbd5

◆ DSIERR_NOACK

#define DSIERR_NOACK   0xfbcd

◆ DSIERR_NOSERV

#define DSIERR_NOSERV   0xfbd3

◆ DSIERR_NOSESS

#define DSIERR_NOSESS   0xfbd4

◆ DSIERR_OK

#define DSIERR_OK   0x0000

◆ DSIERR_PARM

#define DSIERR_PARM   0xfbd2

◆ DSIERR_SERVBUSY

#define DSIERR_SERVBUSY   0xfbd1

◆ DSIERR_SESSCLOS

#define DSIERR_SESSCLOS   0xfbd0

◆ DSIERR_SIZERR

#define DSIERR_SIZERR   0xfbcf

◆ DSIERR_TOOMANY

#define DSIERR_TOOMANY   0xfbce

◆ DSIFL_MAX

#define DSIFL_MAX   0x01

◆ DSIFL_REPLY

#define DSIFL_REPLY   0x01

◆ DSIFL_REQUEST

#define DSIFL_REQUEST   0x00

◆ DSIFUNC_ATTN

#define DSIFUNC_ATTN   8

DSIAttention

◆ DSIFUNC_CLOSE

#define DSIFUNC_CLOSE   1

DSICloseSession

◆ DSIFUNC_CMD

#define DSIFUNC_CMD   2

DSICommand

◆ DSIFUNC_MAX

#define DSIFUNC_MAX   8

largest command

◆ DSIFUNC_OPEN

#define DSIFUNC_OPEN   4

DSIOpenSession

◆ DSIFUNC_STAT

#define DSIFUNC_STAT   3

DSIGetStatus

◆ DSIFUNC_TICKLE

#define DSIFUNC_TICKLE   5

DSITickle

◆ DSIFUNC_WRITE

#define DSIFUNC_WRITE   6

DSIWrite

◆ DSIOPT_ATTNQUANT

#define DSIOPT_ATTNQUANT   0x01

attention quantum

◆ DSIOPT_SERVQUANT

#define DSIOPT_SERVQUANT   0x00

server request quantum

Typedef Documentation

◆ DSI

typedef struct DSI DSI

Function Documentation

◆ dsi_init()

DSI * dsi_init ( const char * ,
const char * ,
const char * ,
const int ,
const int ,
const uint32_t  )
extern

basic initialization: dsi_init.c

◆ dsi_kill()

void dsi_kill ( int )
extern

◆ dsi_read()

ssize_t dsi_read ( DSI * dsi,
void * buf,
const size_t buflen )
extern

send off the data

◆ dsi_readdone()

void dsi_readdone ( DSI * dsi)
extern

◆ dsi_readinit()

ssize_t dsi_readinit ( DSI * dsi,
void * buf,
const size_t buflen,
const size_t size,
const int err )
extern

streaming i/o for afp_read.

this is all from the perspective of the client. it basically does the reverse of dsi_write. on first entry, it will send off the header plus whatever is in its command buffer. it returns the amount of stuff still to be read (constrained by the buffer size).

◆ dsi_setstatus()

void dsi_setstatus ( DSI * ,
uint8_t * ,
const int  )
extern

◆ dsi_stream_read()

size_t dsi_stream_read ( DSI * dsi,
void * data,
const size_t length )
extern

Read data from DSI buffer.

Essentially a loop around buf_read() to ensure "length" bytes are read from dsi->buffer and/or the socket.

Returns
length on success, some value smaller than length indicates an error

◆ dsi_stream_receive()

int dsi_stream_receive ( DSI * ,
void * ,
const size_t ,
size_t *  )
extern

◆ dsi_stream_send()

int dsi_stream_send ( DSI * dsi,
void * buf,
size_t length )
extern

write data.

Returns
0 on failure.
Note
this assumes that dsi_len will never cause an overflow in the data buffer.

◆ dsi_stream_write()

size_t dsi_stream_write ( DSI * ,
void * ,
const size_t  )
extern

◆ dsi_write()

size_t dsi_write ( DSI * dsi,
void * buf,
const size_t buflen )
extern

fill up buf and then return. this should be called repeatedly until all the data has been read. i block alarm processing during the transfer to avoid sending unnecessary tickles.

◆ dsi_writeflush()

void dsi_writeflush ( DSI * dsi)
extern

flush any unread buffers.

◆ dsi_writeinit()

size_t dsi_writeinit ( DSI * dsi,
void * buf,
const size_t buflen )
extern