[thirdparty/squid.git] / src / DiskIO / DiskDaemon / DiskdIOStrategy.h


/*
 * $Id: DiskdIOStrategy.h,v 1.1 2004/12/20 16:30:38 robertc Exp $
 *
 * DEBUG: section 79    Squid-side DISKD I/O functions.
 * AUTHOR: Duane Wessels
 *
 * SQUID Web Proxy Cache          http://www.squid-cache.org/
 * ----------------------------------------------------------
 *
 *  Squid is the result of efforts by numerous individuals from
 *  the Internet community; see the CONTRIBUTORS file for full
 *  details.   Many organizations have provided support for Squid's
 *  development; see the SPONSORS file for full details.  Squid is
 *  Copyrighted (C) 2001 by the Regents of the University of
 *  California; see the COPYRIGHT file for full details.  Squid
 *  incorporates software developed and/or copyrighted by other
 *  sources; see the CREDITS file for full details.
 *
 *  This program 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.
 *  
 *  This program 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 this program; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.
 *
 * Copyright (c) 2003, Robert Collins <robertc@squid-cache.org>
 */

#ifndef __STORE_DISKDIOSTRATEGY_H__
#define __STORE_DISKDIOSTRATEGY_H__

/*
 * magic2 is the point at which we start blocking on msgsnd/msgrcv.
 * If a queue has magic2 (or more) messages away, then we read the
 * queue until the level falls below magic2.  Recommended value
 * is 75% of SHMBUFS. magic1 is the number of messages away which we
 * stop allowing open/create for.
 */

struct diomsg;

class SharedMemory
{

public:
    void put(off_t);

    void *get
    (off_t *);

    void init (int ikey, int magic2);

    int nbufs;

    char *buf;

    char *inuse_map;

    int id;
};

#include "DiskIO/DiskIOStrategy.h"

class DiskFile;

class DiskdFile;

class ReadRequest;

class DiskdIOStrategy : public DiskIOStrategy
{

public:
    DiskdIOStrategy();
    virtual bool shedLoad();
    virtual int load();
    virtual RefCount<DiskFile> newFile(char const *path);
    virtual void unlinkFile (char const *);
    virtual ConfigOption *getOptionTree() const;
    virtual void init();
    virtual void sync();
    virtual int callback();
    virtual void statfs(StoreEntry & sentry)const;
    int send(int mtype, int id, DiskdFile *theFile, int size, int offset, off_t shm_offset, RefCountable_ *);
    /* public for accessing return address's */
    SharedMemory shm;

private:
    static size_t newInstance();
    static size_t nextInstanceID;
    void openFailed();
    bool optionQ1Parse(char const *option, const char *value, int reconfiguring);
    void optionQ1Dump(StoreEntry * e) const;
    bool optionQ2Parse(char const *option, const char *value, int reconfiguring);
    void optionQ2Dump(StoreEntry * e) const;
    int send(int mtype, int id, RefCount<storeIOState> sio, int size, int offset, off_t shm_offset);
    void handle(diomsg * M);
    void unlinkDone(diomsg * M);
    int magic1;
    int magic2;
    int away;
    int smsgid;
    int rmsgid;
    int wfd;
    size_t instanceID;
};

#define SHMBUF_BLKSZ SM_PAGE_SIZE


struct diskd_stats_t
{
    int open_fail_queue_len;
    int block_queue_len;
    int max_away;
    int max_shmuse;
    int shmbuf_count;
    int sent_count;
    int recv_count;
    int sio_id;

    struct
    {
        int ops;
        int success;
        int fail;
    }

    open, create, close, unlink, read, write;
};

extern diskd_stats_t diskd_stats;

#endif
Commit	Line	Data
b9ae18aa	1
	2	/*
	3	* $Id: DiskdIOStrategy.h,v 1.1 2004/12/20 16:30:38 robertc Exp $
	4	*
	5	* DEBUG: section 79 Squid-side DISKD I/O functions.
	6	* AUTHOR: Duane Wessels
	7	*
	8	* SQUID Web Proxy Cache http://www.squid-cache.org/
	9	* ----------------------------------------------------------
	10	*
	11	* Squid is the result of efforts by numerous individuals from
	12	* the Internet community; see the CONTRIBUTORS file for full
	13	* details. Many organizations have provided support for Squid's
	14	* development; see the SPONSORS file for full details. Squid is
	15	* Copyrighted (C) 2001 by the Regents of the University of
	16	* California; see the COPYRIGHT file for full details. Squid
	17	* incorporates software developed and/or copyrighted by other
	18	* sources; see the CREDITS file for full details.
	19	*
	20	* This program is free software; you can redistribute it and/or modify
	21	* it under the terms of the GNU General Public License as published by
	22	* the Free Software Foundation; either version 2 of the License, or
	23	* (at your option) any later version.
	24	*
	25	* This program is distributed in the hope that it will be useful,
	26	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	27	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	28	* GNU General Public License for more details.
	29	*
	30	* You should have received a copy of the GNU General Public License
	31	* along with this program; if not, write to the Free Software
	32	* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.
	33	*
	34	* Copyright (c) 2003, Robert Collins <robertc@squid-cache.org>
	35	*/
	36
	37	#ifndef __STORE_DISKDIOSTRATEGY_H__
	38	#define __STORE_DISKDIOSTRATEGY_H__
	39
	40	/*
	41	* magic2 is the point at which we start blocking on msgsnd/msgrcv.
	42	* If a queue has magic2 (or more) messages away, then we read the
	43	* queue until the level falls below magic2. Recommended value
	44	* is 75% of SHMBUFS. magic1 is the number of messages away which we
	45	* stop allowing open/create for.
	46	*/
	47
	48	struct diomsg;
	49
	50	class SharedMemory
	51	{
	52
	53	public:
	54	void put(off_t);
	55
	56	void *get
	57	(off_t *);
	58
	59	void init (int ikey, int magic2);
	60
	61	int nbufs;
	62
	63	char *buf;
	64
65	char *inuse_map;
66
67	int id;
68	};
69
70	#include "DiskIO/DiskIOStrategy.h"
71
72	class DiskFile;
73
74	class DiskdFile;
75
76	class ReadRequest;
77
78	class DiskdIOStrategy : public DiskIOStrategy
79	{
80
81	public:
82	DiskdIOStrategy();
83	virtual bool shedLoad();
84	virtual int load();
85	virtual RefCount<DiskFile> newFile(char const *path);
86	virtual void unlinkFile (char const *);
87	virtual ConfigOption *getOptionTree() const;
88	virtual void init();
89	virtual void sync();
90	virtual int callback();
91	virtual void statfs(StoreEntry & sentry)const;
92	int send(int mtype, int id, DiskdFile theFile, int size, int offset, off_t shm_offset, RefCountable_ );
93	/* public for accessing return address's */
94	SharedMemory shm;
95
96	private:
97	static size_t newInstance();
98	static size_t nextInstanceID;
99	void openFailed();
100	bool optionQ1Parse(char const option, const char value, int reconfiguring);
101	void optionQ1Dump(StoreEntry * e) const;
102	bool optionQ2Parse(char const option, const char value, int reconfiguring);
103	void optionQ2Dump(StoreEntry * e) const;
104	int send(int mtype, int id, RefCount<storeIOState> sio, int size, int offset, off_t shm_offset);
105	void handle(diomsg * M);
106	void unlinkDone(diomsg * M);
107	int magic1;
108	int magic2;
109	int away;
110	int smsgid;
111	int rmsgid;
112	int wfd;
113	size_t instanceID;
114	};
115
116	#define SHMBUF_BLKSZ SM_PAGE_SIZE
117
118
119	struct diskd_stats_t
120	{
121	int open_fail_queue_len;
122	int block_queue_len;
123	int max_away;
124	int max_shmuse;
125	int shmbuf_count;
126	int sent_count;
127	int recv_count;
128	int sio_id;
129
130	struct
131	{
132	int ops;
133	int success;
134	int fail;
135	}
136
137	open, create, close, unlink, read, write;
138	};
139
140	extern diskd_stats_t diskd_stats;
141
142	#endif