include/atalk/dsi.h

Go to the documentation of this file.

/*
 * Copyright (c) 1997 Adrian Sun (asun@zoology.washington.edu)
 * All rights reserved.
 */
 
#ifndef _ATALK_DSI_H
#define _ATALK_DSI_H
 
#include <sys/types.h>
#include <arpa/inet.h>
#include <netinet/in.h>
#include <signal.h>
#include <sys/socket.h>
#include <sys/time.h>
 
#include <atalk/afp.h>
#include <atalk/globals.h>
#include <atalk/server_child.h>

 
#define DSI_BLOCKSIZ 16
struct dsi_block {
    uint8_t dsi_flags;       
    uint8_t dsi_command;     
    uint16_t dsi_requestID;  
    union {
        uint32_t dsi_code;   
        uint32_t dsi_doff;   
    } dsi_data;
    uint32_t dsi_len;        
    uint32_t dsi_reserved;   
};
 
#define DSI_DATASIZ       65536
 
/* child and parent processes might interpret a couple of these
 * differently. */
typedef struct DSI {
    struct DSI *next;             
    AFPObj   *AFPobj;
    int      statuslen;
    char     status[1400];
    char     *signature;
    struct dsi_block        header;
    struct sockaddr_storage server, client;
    struct itimerval        timer;
    int      tickle;            
    int      in_write;          
    int      msg_request;       
    int      down_request;      
 
    uint32_t attn_quantum, datasize, server_quantum;
    uint16_t serverID, clientID;
    uint8_t  *commands; 
    uint8_t  data[DSI_DATASIZ];    
    size_t   datalen, cmdlen;
    off_t    read_count, write_count;
    uint32_t flags;             
    int      socket;            
    int      serversock;        
 
    /* DSI readahead buffer used for buffered reads in dsi_peek */
    size_t   dsireadbuf;        
    char     *buffer;           
    char     *start;            
    char     *eof;              
    char     *end;
 
#ifdef USE_ZEROCONF
    char *zeroconfname;      
    int zeroconf_registered;
#endif
 
    /* protocol specific open/close */
    pid_t (*proto_open)(struct DSI *);
    void (*proto_close)(struct DSI *);
} DSI;
 
/* DSI flags */
#define DSIFL_REQUEST    0x00
#define DSIFL_REPLY      0x01
#define DSIFL_MAX        0x01
 
/* DSI session options */
#define DSIOPT_SERVQUANT 0x00   
#define DSIOPT_ATTNQUANT 0x01   
#define DSIOPT_REPLCSIZE 0x02   
 
/* DSI Commands */
#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       
 
/* DSI Error codes: most of these aren't used. */
#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
 
/* server and client quanta; the server quantum counts write data only */
#define DSI_DEFQUANT        2           
#define DSI_SERVQUANT_MAX   0x10000000  
#define DSI_SERVQUANT_MIN   32000       
#define DSI_SERVQUANT_DEF   0x100000L   
 
/* Write request blocks: FPWrite is 12 bytes, FPWriteExt 20 bytes. */
#define DSI_WROFF_FPWRITE     12
#define DSI_WROFF_FPWRITEEXT  20
 
/* On-wire overhead of an FPWriteExt frame: DSI header + request block. */
#define DSI_FRAME_OVERHEAD_EXT (DSI_BLOCKSIZ + DSI_WROFF_FPWRITEEXT)

#define DSI_QUANTUM_GROWTH_MAX (256 * 1024)

#define DSI_AFPOVERTCP_PORT 548
 
/* DSI session State flags */
#define DSI_DATA             (1 << 0) 
#define DSI_RUNNING          (1 << 1) 
#define DSI_SLEEPING         (1 << 2) 
#define DSI_EXTSLEEP         (1 << 3) 
#define DSI_DISCONNECTED     (1 << 4) 
#define DSI_DIE              (1 << 5) 
#define DSI_NOREPLY          (1 << 6) 
#define DSI_RECONSOCKET      (1 << 7) 
#define DSI_RECONINPROG      (1 << 8) 
#define DSI_AFP_LOGGED_OUT   (1 << 9) 
 
/* basic initialization: dsi_init.c */
extern DSI *dsi_init(AFPObj *obj, const char *hostname, const char *address,
                     const char *port);
extern void dsi_setstatus(DSI *, char *, const size_t);
extern int dsi_tcp_init(DSI *dsi, const char *hostname, const char *address,
                        const char *port);
extern uint32_t dsi_effective_mss(const DSI *);
extern uint32_t dsi_align_quantum(uint32_t configured, uint32_t mss);
extern void dsi_free(DSI *dsi);
 
/* in dsi_getsess.c */
extern int dsi_getsession(DSI *, server_child_t *, const int, afp_child_t **);
extern void dsi_kill(int);
 
 
/* DSI Commands: individual files */
extern void dsi_opensession(DSI *);
extern int  dsi_attention(DSI *, AFPUserBytes);
extern int  dsi_cmdreply(DSI *, const int);
extern int dsi_tickle(DSI *);
extern void dsi_getstatus(DSI *);
extern void dsi_close(DSI *);
 
#define DSI_NOWAIT 1
#define DSI_MSG_MORE 2
 
/* low-level stream commands -- in dsi_stream.c */
extern ssize_t dsi_stream_write(DSI *, void *, const size_t, const int mode);
extern size_t dsi_stream_read(DSI *, void *, const size_t);
extern int dsi_stream_send(DSI *, void *, size_t);
extern int dsi_stream_receive(DSI *);
extern int dsi_disconnect(DSI *dsi);
 
#ifdef WITH_SENDFILE
extern ssize_t dsi_stream_read_file(DSI *, int, off_t off, const size_t len,
                                    const int err);
#endif
 
/* client writes -- dsi_write.c */
extern size_t dsi_writeinit(DSI *, char **);
extern size_t dsi_write(DSI *, void *, const size_t);
extern void   dsi_writeflush(DSI *);
#define dsi_wrtreply(a,b)  dsi_cmdreply(a,b)
 
/* client reads -- dsi_read.c */
extern ssize_t dsi_readinit(DSI *, void *, const size_t, const size_t,
                            const int);
extern ssize_t dsi_read(DSI *, void *, const size_t);
extern void dsi_readdone(DSI *);
 
/* some useful macros */
#define dsi_serverID(x)   ((x)->serverID++)
#define dsi_send(x)       do {                              \
        (x)->header.dsi_len = htonl((x)->cmdlen);           \
        dsi_stream_send((x), (x)->commands, (x)->cmdlen);   \
    } while (0)
 
#endif /* atalk/dsi.h */