stub_store.cc
Go to the documentation of this file.
1 /*
2  * Copyright (C) 1996-2018 The Squid Software Foundation and contributors
3  *
4  * Squid software is distributed under GPLv2+ license and includes
5  * contributions from numerous individuals and organizations.
6  * Please see the COPYING and CONTRIBUTORS files for details.
7  */
8 
9 #include "squid.h"
10 #include "RequestFlags.h"
11 
12 #define STUB_API "store.cc"
13 #include "tests/STUB.h"
14 
15 const char *storeStatusStr[] = { };
16 const char *pingStatusStr[] = { };
17 const char *memStatusStr[] = { };
18 const char *swapStatusStr[] = { };
19 
20 #include "RemovalPolicy.h"
22 
23 #include "Store.h"
25 bool StoreEntry::checkDeferRead(int fd) const STUB_RETVAL(false)
26 const char *StoreEntry::getMD5Text() const STUB_RETVAL(NULL)
27 StoreEntry::StoreEntry() STUB
28 StoreEntry::~StoreEntry() STUB
29 HttpReply const *StoreEntry::getReply() const STUB_RETVAL(NULL)
30 void StoreEntry::write(StoreIOBuffer) STUB
31 bool StoreEntry::isAccepting() const STUB_RETVAL(false)
32 size_t StoreEntry::bytesWanted(Range<size_t> const, bool) const STUB_RETVAL(0)
33 void StoreEntry::complete() STUB
35 char const *StoreEntry::getSerialisedMetaData() STUB_RETVAL(NULL)
36 void StoreEntry::replaceHttpReply(HttpReply *, bool andStartWriting) STUB
37 bool StoreEntry::mayStartSwapOut() STUB_RETVAL(false)
38 void StoreEntry::trimMemory(const bool preserveSwappable) STUB
39 void StoreEntry::abort() STUB
40 bool StoreEntry::makePublic(const KeyScope scope) STUB
41 void StoreEntry::makePrivate(const bool shareable) STUB
42 bool StoreEntry::setPublicKey(const KeyScope scope) STUB
43 void StoreEntry::setPrivateKey(const bool, const bool) STUB
44 void StoreEntry::expireNow() STUB
45 void StoreEntry::releaseRequest(const bool shareable) STUB
46 void StoreEntry::negativeCache() STUB
47 bool StoreEntry::cacheNegatively() STUB
48 void StoreEntry::swapOut() STUB
49 void StoreEntry::swapOutFileClose(int how) STUB
50 const char *StoreEntry::url() const STUB_RETVAL(NULL)
51 bool StoreEntry::checkCachable() STUB_RETVAL(false)
52 int StoreEntry::checkNegativeHit() const STUB_RETVAL(0)
53 int StoreEntry::locked() const STUB_RETVAL(0)
54 int StoreEntry::validToSend() const STUB_RETVAL(0)
55 bool StoreEntry::memoryCachable() STUB_RETVAL(false)
56 void StoreEntry::createMemObject() STUB
57 void StoreEntry::createMemObject(const char *, const char *, const HttpRequestMethod &aMethod) STUB
58 void StoreEntry::ensureMemObject(const char *, const char *, const HttpRequestMethod &) STUB
59 void StoreEntry::dump(int debug_lvl) const STUB
60 void StoreEntry::hashDelete() STUB
61 void StoreEntry::hashInsert(const cache_key *) STUB
62 void StoreEntry::registerAbort(STABH * cb, void *) STUB
63 void StoreEntry::reset() STUB
64 void StoreEntry::setMemStatus(mem_status_t) STUB
65 bool StoreEntry::timestampsSet() STUB_RETVAL(false)
66 void StoreEntry::unregisterAbort() STUB
67 void StoreEntry::destroyMemObject() STUB
68 int StoreEntry::checkTooSmall() STUB_RETVAL(0)
69 void StoreEntry::delayAwareRead(const Comm::ConnectionPointer&, char *buf, int len, AsyncCall::Pointer callback) STUB
70 void StoreEntry::setNoDelay (bool const) STUB
71 bool StoreEntry::modifiedSince(const time_t, const int) const STUB_RETVAL(false)
72 bool StoreEntry::hasIfMatchEtag(const HttpRequest &request) const STUB_RETVAL(false)
73 bool StoreEntry::hasIfNoneMatchEtag(const HttpRequest &request) const STUB_RETVAL(false)
74 Store::Disk &StoreEntry::disk() const STUB_RETREF(Store::Disk)
75 size_t StoreEntry::inUseCount() STUB_RETVAL(0)
76 void StoreEntry::getPublicByRequestMethod(StoreClient * aClient, HttpRequest * request, const HttpRequestMethod& method) STUB
77 void StoreEntry::getPublicByRequest(StoreClient * aClient, HttpRequest * request) STUB
78 void StoreEntry::getPublic(StoreClient * aClient, const char *uri, const HttpRequestMethod& method) STUB
79 void *StoreEntry::operator new(size_t byteCount)
80 {
81  STUB
82  return new StoreEntry();
83 }
84 void StoreEntry::operator delete(void *address) STUB
85 //#if USE_SQUID_ESI
86 //ESIElement::Pointer StoreEntry::cachedESITree STUB_RETVAL(NULL)
87 //#endif
89 void StoreEntry::flush() STUB
90 int StoreEntry::unlock(const char *) STUB_RETVAL(0)
91 int64_t StoreEntry::objectLen() const STUB_RETVAL(0)
92 int64_t StoreEntry::contentLen() const STUB_RETVAL(0)
93 void StoreEntry::lock(const char *) STUB
94 void StoreEntry::touch() STUB
95 void StoreEntry::release(const bool shareable) STUB
96 void StoreEntry::append(char const *, int) STUB
97 void StoreEntry::vappendf(const char *, va_list) STUB
98 void StoreEntry::setCollapsingRequirement(const bool required) STUB
99 
101 const char *NullStoreEntry::getMD5Text() const STUB_RETVAL(NULL)
102 void NullStoreEntry::operator delete(void *address) STUB
103 // private virtual. Why is this linked from outside?
105 
106 Store::Controller &Store::Root() STUB_RETREF(Store::Controller)
107 void Store::Init(Store::Controller *root) STUB
108 void Store::FreeMemory() STUB
109 void Store::Stats(StoreEntry * output) STUB
110 void Store::Maintain(void *unused) STUB
111 int Store::Controller::store_dirs_rebuilding = 0;
112 StoreSearch *Store::Controller::search() STUB_RETVAL(NULL)
113 void Store::Controller::maintain() STUB
114 bool Store::Controller::markedForDeletion(const cache_key *) const STUB_RETVAL(false)
115 void Store::Controller::freeMemorySpace(const int) STUB
116 
117 std::ostream &operator <<(std::ostream &os, const StoreEntry &)
118 {
119  STUB
120  return os;
121 }
122 
123 size_t storeEntryInUse() STUB_RETVAL(0)
124 void storeEntryReplaceObject(StoreEntry *, HttpReply *) STUB
125 StoreEntry *storeGetPublic(const char *uri, const HttpRequestMethod& method) STUB_RETVAL(NULL)
126 StoreEntry *storeGetPublicByRequest(HttpRequest * request, const KeyScope scope) STUB_RETVAL(NULL)
127 StoreEntry *storeGetPublicByRequestMethod(HttpRequest * request, const HttpRequestMethod& method, const KeyScope scope) STUB_RETVAL(NULL)
128 StoreEntry *storeCreateEntry(const char *, const char *, const RequestFlags &, const HttpRequestMethod&) STUB_RETVAL(NULL)
129 StoreEntry *storeCreatePureEntry(const char *storeId, const char *logUrl, const HttpRequestMethod&) STUB_RETVAL(nullptr)
130 void storeConfigure(void) STUB
131 int expiresMoreThan(time_t, time_t) STUB_RETVAL(0)
132 void storeAppendPrintf(StoreEntry *, const char *,...) STUB
133 void storeAppendVPrintf(StoreEntry *, const char *, va_list ap) STUB
135 void storeHeapPositionUpdate(StoreEntry *, SwapDir *) STUB
136 void storeSwapFileNumberSet(StoreEntry * e, sfileno filn) STUB
137 void storeFsInit(void) STUB
138 void storeFsDone(void) STUB
139 void storeReplAdd(const char *, REMOVALPOLICYCREATE *) STUB
140 void destroyStoreEntry(void *) STUB
141 void storeGetMemSpace(int size) STUB
142 
void storeReplAdd(const char *type, REMOVALPOLICYCREATE *create)
Definition: store.cc:1718
virtual bool isAccepting() const
Definition: store.cc:2064
void makePrivate(const bool shareable)
Definition: store.cc:150
void const char HLPCB * callback
Definition: stub_helper.cc:16
void touch()
update last reference timestamp and related Store metadata
Definition: store.cc:442
static void getPublicByRequestMethod(StoreClient *aClient, HttpRequest *request, const HttpRequestMethod &method)
Definition: store.cc:497
void Stats(StoreEntry *)
Definition: old_api.cc:171
int validToSend() const
Definition: store.cc:1431
virtual void release(const bool shareable=false)
Definition: store.cc:1206
int unlock(const char *context)
Definition: store.cc:459
virtual int64_t contentLen() const
Definition: store.cc:1679
void storeEntryReplaceObject(StoreEntry *, HttpReply *)
bool timestampsSet()
Definition: store.cc:1471
virtual void append(char const *, int)
Appends a c-string to existing packed data.
Definition: store.cc:840
unsigned char cache_key
Store key.
Definition: forward.h:29
virtual void buffer()
Definition: store.cc:1652
void expireNow()
Definition: store.cc:807
static size_t inUseCount()
Definition: store.cc:175
void ensureMemObject(const char *storeId, const char *logUri, const HttpRequestMethod &aMethod)
initialize mem_obj (if needed) and set URIs/method (if missing)
Definition: store.cc:1640
Definition: Range.h:18
virtual void flush()
Definition: store.cc:1663
StoreEntry * storeGetPublicByRequestMethod(HttpRequest *req, const HttpRequestMethod &method, const KeyScope keyScope)
Definition: store.cc:539
void delayAwareRead(const Comm::ConnectionPointer &conn, char *buf, int len, AsyncCall::Pointer callback)
Definition: store.cc:201
void storeFsDone(void)
const char * pingStatusStr[]
Definition: stub_store.cc:16
Controller & Root()
safely access controller singleton
Definition: Controller.cc:871
int storeTooManyDiskFilesOpen(void)
Definition: store.cc:928
void destroyMemObject()
Definition: store.cc:371
void replaceHttpReply(HttpReply *, bool andStartWriting=true)
Definition: store.cc:1799
static void getPublicByRequest(StoreClient *aClient, HttpRequest *request)
Definition: store.cc:509
RemovalPolicy * REMOVALPOLICYCREATE(wordlist *args)
Definition: RemovalPolicy.h:80
bool hasIfMatchEtag(const HttpRequest &request) const
has ETag matching at least one of the If-Match etags
Definition: store.cc:1958
virtual void complete()
Definition: store.cc:1075
static void getPublic(StoreClient *aClient, const char *uri, const HttpRequestMethod &method)
Definition: store.cc:521
virtual char const * getSerialisedMetaData()
Definition: store.cc:1842
const char * swapStatusStr[]
Definition: stub_store.cc:18
void hashDelete()
Definition: store.cc:423
int locked() const
Definition: store.cc:1266
void hashInsert(const cache_key *)
Definition: store.cc:414
bool checkDeferRead(int fd) const
Definition: store.cc:245
store_client_t
Definition: enums.h:63
StoreEntry()
Definition: store.cc:323
virtual int64_t objectLen() const
Definition: store.cc:1672
StoreEntry * storeCreateEntry(const char *url, const char *logUrl, const RequestFlags &flags, const HttpRequestMethod &method)
Definition: store.cc:793
void abort()
Definition: store.cc:1124
bool checkCachable()
Definition: store.cc:969
virtual HttpReply const * getReply() const
Definition: store.cc:1687
RemovalPolicy * createRemovalPolicy(RemovalPolicySettings *settings) STUB_RETVAL(NULL) StoreIoStats store_io_stats
Definition: store.cc:1744
#define STUB
macro to stub a void function.
Definition: STUB.h:33
bool modifiedSince(const time_t ims, const int imslen=-1) const
Definition: store.cc:1910
bool setPublicKey(const KeyScope keyScope=ksDefault)
Definition: store.cc:604
void Init(void)
prepares to parse ACLs configuration
Definition: AclRegs.cc:114
void dump(int debug_lvl) const
Definition: store.cc:1550
int checkNegativeHit() const
Definition: store.cc:1377
Store statistics related to low-level I/O.
Definition: StoreStats.h:58
void releaseRequest(const bool shareable=false)
Definition: store.cc:448
virtual void vappendf(const char *, va_list)
Definition: store.cc:858
RefCount< Comm::Connection > ConnectionPointer
Definition: forward.h:25
void setNoDelay(bool const)
Definition: store.cc:251
signed_int32_t sfileno
Definition: forward.h:22
int checkTooSmall()
Definition: store.cc:940
int unsigned int const char *desc STUB void int len
Definition: stub_fd.cc:20
const char * url() const
Definition: store.cc:1617
void STABH(void *)
Definition: MemObject.h:28
void const char * buf
Definition: stub_helper.cc:16
void Maintain(void *unused)
Definition: store.cc:1192
void storeGetMemSpace(int size)
Definition: store.cc:1178
void setCollapsingRequirement(const bool required)
allow or forbid collapsed requests feeding
Definition: store.cc:2088
bool makePublic(const KeyScope keyScope=ksDefault)
Definition: store.cc:143
void storeFsInit(void)
Definition: store.cc:1709
virtual const char * getMD5Text() const
Definition: store.cc:183
void swapOutFileClose(int how)
const char * memStatusStr[]
Definition: stub_store.cc:17
bool cacheNegatively()
Definition: store.cc:164
virtual void write(StoreIOBuffer)
Definition: store.cc:814
Store::Disk & disk() const
the disk this entry is [being] cached on; asserts for entries w/o a disk
Definition: store.cc:2005
void FreeMemory()
undo Init()
Definition: Controller.cc:884
bool memoryCachable()
checkCachable() and can be cached in memory
Definition: store.cc:1356
virtual bool mayStartSwapOut()
whether we may start writing to disk (now or in the future)
size_t HttpReply *STUB StoreEntry const KeyScope scope const HttpRequestMethod const KeyScope scope const char const RequestFlags const HttpRequestMethod const char const HttpRequestMethod time_t const char STUB void storeAppendVPrintf(StoreEntry *, const char *, va_list ap) STUB int storeTooManyDiskFilesOpen(void) STUB_RETVAL(0) void storeHeapPositionUpdate(StoreEntry *
Definition: store.cc:902
void storeConfigure(void)
Definition: store.cc:1350
KeyScope
Definition: store_key_md5.h:18
StoreEntry * storeCreatePureEntry(const char *url, const char *log_url, const HttpRequestMethod &method)
Definition: store.cc:775
StoreIoStats store_io_stats
Definition: store_io.cc:16
size_t storeEntryInUse() STUB_RETVAL(0) void storeEntryReplaceObject(StoreEntry *
size_t HttpReply *STUB StoreEntry * storeGetPublic(const char *uri, const HttpRequestMethod &method) STUB_RETVAL(NULL) StoreEntry *storeGetPublicByRequest(HttpRequest *request
Definition: store.cc:533
void registerAbort(STABH *cb, void *)
Definition: store.cc:1531
virtual size_t bytesWanted(Range< size_t > const aRange, bool ignoreDelayPool=false) const
Definition: store.cc:227
#define STUB_RETREF(x)
Definition: STUB.h:51
bool hasIfNoneMatchEtag(const HttpRequest &request) const
has ETag matching at least one of the If-None-Match etags
Definition: store.cc:1965
void unregisterAbort()
Definition: store.cc:1540
enum _mem_status_t mem_status_t
StoreEntry * storeGetPublicByRequest(HttpRequest *req, const KeyScope keyScope)
Definition: store.cc:545
virtual store_client_t storeClientType() const
Definition: store.cc:263
const char * storeStatusStr[]
Definition: stub_store.cc:15
void storeHeapPositionUpdate(StoreEntry *, SwapDir *)
size_t HttpReply *STUB StoreEntry const KeyScope scope const HttpRequestMethod const KeyScope scope const char const RequestFlags const HttpRequestMethod const char const HttpRequestMethod time_t const char STUB void SwapDir *STUB void storeSwapFileNumberSet(StoreEntry *e, sfileno filn) STUB void storeFsInit(void) STUB void storeFsDone(void) STUB void storeReplAdd(const char *
int expiresMoreThan(time_t expires, time_t when)
Definition: store.cc:1422
void swapOut()
void reset()
Definition: store.cc:1693
void setPrivateKey(const bool shareable, const bool permanent)
Definition: store.cc:577
FREE destroyStoreEntry
void storeAppendPrintf(StoreEntry *e, const char *fmt,...)
Definition: store.cc:892
void negativeCache()
Definition: store.cc:1398
size_t HttpReply *STUB StoreEntry const KeyScope scope STUB_RETVAL(NULL) StoreEntry *storeGetPublicByRequestMethod(HttpRequest *request
#define NULL
Definition: types.h:166
A StoreEntry::getPublic*() caller.
Definition: StoreClient.h:23
int size
Definition: ModDevPoll.cc:77
virtual void trimMemory(const bool preserveSwappable)
Definition: store.cc:1888
#define false
Definition: GnuRegex.c:233
manages a single cache_dir
Definition: Disk.h:21
void setMemStatus(mem_status_t)
Definition: store.cc:1575
void lock(const char *context)
Definition: store.cc:435
void createMemObject()
Definition: store.cc:1626

 

Introduction

Documentation

Support

Miscellaneous

Web Site Translations

Mirrors