Namespaces | |
| Mem | |
Classes | |
| class | BaseMultiQueue |
| class | Coordinator |
| Coordinates shared activities of Strands (Squid processes or threads) More... | |
| class | FewToFewBiQueue |
| class | Forwarder |
| class | HereIamMessage |
| strand registration with Coordinator (also used as an ACK) More... | |
| class | Inquirer |
| class | MemMap |
| A map of MemMapSlots indexed by their keys, with read/write slot locking. More... | |
| class | MemMapCleaner |
| API for adjusting external state when dirty map slot is being freed. More... | |
| class | MemMapSlot |
| a MemMap basic element, holding basic shareable memory block info More... | |
| class | MultiQueue |
| class | OneToOneUniQueue |
| class | OneToOneUniQueues |
| shared array of OneToOneUniQueues More... | |
| class | OpenListenerParams |
| "shared listen" is when concurrent processes are listening on the same fd More... | |
| class | Port |
| Waits for and receives incoming IPC messages; kids handle the messages. More... | |
| class | QueueReader |
| class | QueueReaders |
| shared array of QueueReaders More... | |
| class | ReadWriteLock |
| class | ReadWriteLockStats |
| approximate stats of a set of ReadWriteLocks More... | |
| class | Request |
| IPC request. More... | |
| class | Response |
| A response to Ipc::Request. More... | |
| class | SharedListenRequest |
| a request for a listen socket with given parameters More... | |
| class | SharedListenResponse |
| a response to SharedListenRequest More... | |
| class | StartListeningCb |
| common API for all StartListening() callbacks More... | |
| class | StoreMap |
| class | StoreMapAnchor |
| class | StoreMapAnchors |
| class | StoreMapCleaner |
| API for adjusting external state when dirty map slice is being freed. More... | |
| class | StoreMapItems |
| class | StoreMapSlice |
| class | StoreMapUpdate |
| Aggregates information required for updating entry metadata and headers. More... | |
| class | Strand |
| Receives coordination messages on behalf of its process or thread. More... | |
| class | StrandCoord |
| Strand location details. More... | |
| class | StrandSearchRequest |
| asynchronous strand search request More... | |
| class | StrandSearchResponse |
| asynchronous strand search response More... | |
| class | TypedMsgHdr |
| struct msghdr with a known type, fixed-size I/O and control buffers More... | |
| class | UdsOp |
| class | UdsSender |
| attempts to send an IPC message a few times, with a timeout More... | |
Typedefs | |
| typedef int32_t | StoreMapSliceId |
| typedef StoreMapItems< StoreMapSlice > | StoreMapSlices |
| StoreMapSlices indexed by their slice ID. More... | |
| typedef StoreMapItems< std::atomic< sfileno > > | StoreMapFileNos |
| StoreMapAnchor positions, indexed by entry "name" (i.e., the entry key hash) More... | |
| typedef std::vector< StrandCoord > | StrandCoords |
| a collection of strand coordinates; the order, if any, is owner-dependent More... | |
Enumerations | |
| enum | FdNoteId { fdnNone, fdnHttpSocket, fdnHttpsSocket, fdnFtpSocket, fdnInSnmpSocket, fdnOutSnmpSocket, fdnInIcpSocket, fdnInHtcpSocket, fdnEnd } |
| We cannot send char* FD notes to other processes. Pass int IDs and convert. More... | |
| enum | MessageType { mtNone = 0, mtRegistration, mtStrandSearchRequest, mtStrandSearchResponse, mtSharedListenRequest, mtSharedListenResponse, mtIpcIoNotification, mtCollapsedForwardingNotification, mtCacheMgrRequest, mtCacheMgrResponse, mtSnmpRequest, mtSnmpResponse } |
| message class identifier More... | |
Functions | |
| const char * | FdNote (int fdNodeId) |
| converts FdNoteId into a string More... | |
| void | AssertFlagIsSet (std::atomic_flag &flag) |
| std::ostream & | operator<< (std::ostream &os, const Response &response) |
| void | JoinSharedListen (const OpenListenerParams &, AsyncCall::Pointer &) |
| prepare and send SharedListenRequest to Coordinator More... | |
| void | SharedListenJoined (const SharedListenResponse &response) |
| process Coordinator response to SharedListenRequest More... | |
| void | StartListening (int sock_type, int proto, const Comm::ConnectionPointer &listenConn, FdNoteId fdNote, AsyncCall::Pointer &callback) |
| struct sockaddr_un | PathToAddress (const String &pathAddr) |
| converts human-readable filename path into UDS address More... | |
| void | SendMessage (const String &toAddress, const TypedMsgHdr &message) |
| const Comm::ConnectionPointer & | ImportFdIntoComm (const Comm::ConnectionPointer &conn, int socktype, int protocol, FdNoteId noteId) |
| import socket fd from another strand into our Comm state More... | |
Variables | |
| const char | strandAddrLabel [] = "-kid" |
| strand's listening address unique label More... | |
Detailed Description
Declarations used by various IPC messages
Typedef Documentation
◆ StoreMapFileNos
| typedef StoreMapItems< std::atomic<sfileno> > Ipc::StoreMapFileNos |
Definition at line 159 of file StoreMap.h.
◆ StoreMapSliceId
| typedef int32_t Ipc::StoreMapSliceId |
Definition at line 24 of file StoreMap.h.
◆ StoreMapSlices
Definition at line 137 of file StoreMap.h.
◆ StrandCoords
| typedef std::vector<StrandCoord> Ipc::StrandCoords |
Definition at line 19 of file StrandCoords.h.
Enumeration Type Documentation
◆ FdNoteId
| enum Ipc::FdNoteId |
◆ MessageType
| enum Ipc::MessageType |
Definition at line 20 of file Messages.h.
Function Documentation
◆ AssertFlagIsSet()
| void Ipc::AssertFlagIsSet | ( | std::atomic_flag & | flag | ) |
Same as assert(flag is set): The process assert()s if flag is not set. Side effect: The unset flag becomes set just before we assert(). Needed because atomic_flag cannot be compared with a boolean.
Definition at line 15 of file ReadWriteLock.cc.
References assert.
Referenced by Ipc::StoreMap::abortUpdating(), Ipc::StoreMap::closeForUpdating(), and Ipc::ReadWriteLock::unlockHeaders().
◆ FdNote()
| const char * Ipc::FdNote | ( | int | fdNodeId | ) |
Definition at line 16 of file FdNotes.cc.
References DBG_IMPORTANT, debugs, fdnEnd, fdnNone, and HERE().
Referenced by clientListenerConnectionOpened(), ImportFdIntoComm(), OpenedHttpSocket(), Ipc::Coordinator::openListenSocket(), ListeningStartedDialer::print(), SharedListenJoined(), and StartListening().
◆ ImportFdIntoComm()
| const Comm::ConnectionPointer & Ipc::ImportFdIntoComm | ( | const Comm::ConnectionPointer & | conn, |
| int | socktype, | ||
| int | protocol, | ||
| Ipc::FdNoteId | noteId | ||
| ) |
Definition at line 194 of file UdsOp.cc.
References addr, addrinfo::ai_protocol, addrinfo::ai_socktype, Comm::Connection::close(), comm_import_opened(), Ipc::UdsOp::conn(), DBG_CRITICAL, debugs, Comm::Connection::fd, FdNote(), Ip::Address::FreeAddr(), Ip::Address::getAddrInfo(), len, NULL, Comm::Connection::remote, and xstrerr().
Referenced by Mgr::Inquirer::Inquirer(), Snmp::Inquirer::Inquirer(), Mgr::FunAction::respond(), and Mgr::InfoAction::respond().
◆ JoinSharedListen()
| void Ipc::JoinSharedListen | ( | const OpenListenerParams & | params, |
| AsyncCall::Pointer & | cb | ||
| ) |
Definition at line 144 of file SharedListen.cc.
References PendingOpenRequest::callback, debugs, PendingOpenRequest::params, SendSharedListenRequest(), TheDelayedRequests, and TheSharedListenRequestMap.
Referenced by StartListening().
◆ operator<<()
|
inline |
Definition at line 42 of file Response.h.
References Ipc::Response::requestId.
◆ PathToAddress()
| struct sockaddr_un Ipc::PathToAddress | ( | const String & | pathAddr | ) |
Definition at line 73 of file UdsOp.cc.
References AF_LOCAL, assert, CBDATA_NAMESPACED_CLASS_INIT(), sockaddr_un::sun_family, sockaddr_un::sun_path, and xstrncpy().
◆ SendMessage()
| void Ipc::SendMessage | ( | const String & | toAddress, |
| const TypedMsgHdr & | message | ||
| ) |
Definition at line 188 of file UdsOp.cc.
References AsyncJob::Start(), and Ipc::UdsSender::UdsSender().
Referenced by Ipc::Coordinator::handleCacheMgrRequest(), Ipc::Coordinator::handleRegistrationRequest(), Ipc::Coordinator::handleSharedListenRequest(), Ipc::Coordinator::handleSnmpRequest(), Ipc::Inquirer::inquire(), CollapsedForwarding::Notify(), IpcIoFile::Notify(), Ipc::Coordinator::notifySearcher(), IpcIoFile::open(), Ipc::Strand::registerSelf(), Snmp::SendResponse(), Mgr::Action::sendResponse(), SendSharedListenRequest(), and Ipc::Forwarder::start().
◆ SharedListenJoined()
| void Ipc::SharedListenJoined | ( | const SharedListenResponse & | response | ) |
Definition at line 160 of file SharedListen.cc.
References Ipc::OpenListenerParams::addr, addrinfo::ai_protocol, addrinfo::ai_socktype, assert, comm_import_opened(), Ipc::StartListeningCb::conn, debugs, Ipc::StartListeningCb::errNo, Ipc::SharedListenResponse::errNo, Ipc::SharedListenResponse::fd, Comm::Connection::fd, FdNote(), Ipc::OpenListenerParams::fdNote, Ipc::OpenListenerParams::flags, Comm::Connection::flags, Ip::Address::FreeAddr(), Ip::Address::getAddrInfo(), Ipc::StartListeningCb::handlerSubscription, Comm::IsConnOpen(), kickDelayedRequest(), Comm::Connection::local, Ipc::SharedListenResponse::mapId, Must, NULL, p, Ipc::OpenListenerParams::proto, ScheduleCallHere, Ipc::OpenListenerParams::sock_type, TheDelayedRequests, and TheSharedListenRequestMap.
Referenced by Ipc::Strand::receive().
◆ StartListening()
| void Ipc::StartListening | ( | int | sock_type, |
| int | proto, | ||
| const Comm::ConnectionPointer & | listenConn, | ||
| FdNoteId | fdNote, | ||
| AsyncCall::Pointer & | callback | ||
| ) |
Depending on whether SMP is on, either ask Coordinator to send us the listening FD or open a listening socket directly.
Definition at line 35 of file StartListening.cc.
References Ipc::OpenListenerParams::addr, comm_open_listener(), Ipc::StartListeningCb::conn, debugs, enter_suid(), Ipc::StartListeningCb::errNo, FdNote(), Ipc::OpenListenerParams::fdNote, Ipc::OpenListenerParams::flags, Comm::Connection::flags, AsyncCall::getDialer(), HERE(), Comm::IsConnOpen(), JoinSharedListen(), leave_suid(), Comm::Connection::local, Must, p, Ipc::OpenListenerParams::proto, ScheduleCallHere, Ipc::OpenListenerParams::sock_type, and UsingSmp().
Referenced by clientHttpConnectionsOpen(), clientStartListeningOn(), htcpOpenPorts(), icpOpenPorts(), and snmpOpenPorts().
Variable Documentation
◆ strandAddrLabel
| const char Ipc::strandAddrLabel = "-kid" |
Definition at line 22 of file Port.cc.
Referenced by Ipc::Coordinator::handleCacheMgrRequest(), Ipc::Coordinator::handleRegistrationRequest(), Ipc::Coordinator::handleSharedListenRequest(), Ipc::Coordinator::handleSnmpRequest(), Ipc::Inquirer::inquire(), CollapsedForwarding::Notify(), IpcIoFile::Notify(), and Ipc::Coordinator::notifySearcher().