bsched.h

Go to the documentation of this file.

/*
 * $Id: bsched.h,v 1.10 2005/09/26 20:21:48 rmanfredi Exp $
 *
 * Copyright (c) 2002-2003, Raphael Manfredi
 *
 *----------------------------------------------------------------------
 * This file is part of gtk-gnutella.
 *
 *  gtk-gnutella is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  gtk-gnutella is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with gtk-gnutella; if not, write to the Free Software
 *  Foundation, Inc.:
 *      59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *----------------------------------------------------------------------
 */

#ifndef _core_bsched_h_
#define _core_bsched_h_

#include "sockets.h"        /* For enum socket_type */

#include "lib/inputevt.h"
#include "lib/tm.h"
#include "if/core/hosts.h"  /* For gnet_host_t */
#include "if/core/nodes.h"  /* For node_peer_t */
#include "if/core/bsched.h"

struct bsched {
    tm_t last_period;               
    GList *sources;                 
    GSList *stealers;               
    gchar *name;                    
    gint count;                     
    gint type;                      
    gint flags;                     
    gint period;                    
    gint min_period;                
    gint max_period;                
    gint period_ema;                
    gint bw_per_second;             
    gint bw_max;                    
    gint bw_actual;                 
    gint bw_last_period;            
    gint bw_last_capped;            
    gint bw_slot;                   
    gint bw_ema;                    
    gint bw_stolen;                 
    gint bw_stolen_ema;             
    gint bw_delta;                  
    gint bw_unwritten;              
    gint bw_capped;                 
    gint last_used;                 
    gint current_used;              
    gboolean looped;                
};

/*
 * Scheduling types.
 */

#define BS_T_STREAM     1               
#define BS_T_RANDOM     2               
/*
 * Scheduling flags.
 */

#define BS_F_ENABLED        0x00000001  
#define BS_F_READ           0x00000002  
#define BS_F_WRITE          0x00000004  
#define BS_F_NOBW           0x00000008  
#define BS_F_FROZEN_SLOT    0x00000010  
#define BS_F_CHANGED_BW     0x00000020  
#define BS_F_CLEARED        0x00000040  
#define BS_F_DATA_READ      0x00000080  
#define BS_F_RW             (BS_F_READ|BS_F_WRITE)

#define bsched_bps(b)       ((b)->bw_last_period * 1000 / (b)->period)
#define bsched_pct(b)       (bsched_bps(b) * 100 / (1+(b)->bw_per_second))
#define bsched_avg_bps(b)   ((b)->bw_ema * 1000 / (b)->period)
#define bsched_avg_pct(b)   (bsched_avg_bps(b) * 100 / (1+(b)->bw_per_second))

#define bsched_bwps(b)      ((b)->bw_per_second)
#define bsched_saturated(b) ((b)->bw_actual > (b)->bw_max)

#define bsched_enabled(b)   ((b)->flags & BS_F_ENABLED)

struct bws_set {
    bsched_t *out;          
    bsched_t *in;           
    bsched_t *gout;         
    bsched_t *gin;          
    bsched_t *gout_udp;     
    bsched_t *gin_udp;      
    bsched_t *glout;        
    bsched_t *glin;         
};

typedef struct sendfile_ctx {
    void *map;
    off_t map_start, map_end;
} sendfile_ctx_t;


struct iovec;
extern struct bws_set bws;

/*
 * Public interface.
 */

bsched_t *bsched_make(gchar *name,
    gint type, guint32 mode, gint bandwidth, gint period);
void bsched_init(void);
void bsched_shutdown(void);
void bsched_close(void);
void bsched_set_peermode(node_peer_t mode);
void bsched_enable(bsched_t *bs);
void bsched_disable(bsched_t *bs);
void bsched_enable_all(void);
bio_source_t *bsched_source_add(bsched_t *bs, wrap_io_t *wio, guint32 flags,
    inputevt_handler_t callback, gpointer arg);
void bsched_source_remove(bio_source_t *bio);
void bsched_set_bandwidth(bsched_t *bs, gint bandwidth);
bio_source_t *bsched_source_add(bsched_t *bs, wrap_io_t *wio, guint32 flags,
    inputevt_handler_t callback, gpointer arg);
void bio_add_callback(bio_source_t *bio,
    inputevt_handler_t callback, gpointer arg);
void bio_remove_callback(bio_source_t *bio);
ssize_t bio_write(bio_source_t *bio, gconstpointer data, size_t len);
ssize_t bio_writev(bio_source_t *bio, struct iovec *iov, gint iovcnt);
ssize_t bio_sendto(bio_source_t *bio, gnet_host_t *to,
    gconstpointer data, size_t len);
ssize_t bio_sendfile(sendfile_ctx_t *ctx, bio_source_t *bio, gint in_fd,
    off_t *offset, size_t len);
ssize_t bio_read(bio_source_t *bio, gpointer data, size_t len);
ssize_t bio_readv(bio_source_t *bio, struct iovec *iov, gint iovcnt);
ssize_t bws_write(bsched_t *bs, wrap_io_t *wio, gconstpointer data, size_t len);
ssize_t bws_read(bsched_t *bs, wrap_io_t *wio, gpointer data, size_t len);
void bsched_timer(void);

void bws_sock_connect(enum socket_type type);
void bws_sock_connected(enum socket_type type);
void bws_sock_accepted(enum socket_type type);
void bws_sock_connect_timeout(enum socket_type type);
void bws_sock_connect_failed(enum socket_type type);
void bws_sock_closed(enum socket_type type, gboolean remote);
gboolean bws_can_connect(enum socket_type type);

void bws_udp_count_written(gint len);
void bws_udp_count_read(gint len);

gboolean bsched_enough_up_bandwidth(void);

void bsched_config_steal_http_gnet(void);
void bsched_config_steal_gnet(void);

#endif  /* _core_bsched_h_ */

/* vi: set ts=4 sw=4 cindent: */

---