Forwarder.cc
Go to the documentation of this file.
1 /*
2  * Copyright (C) 1996-2022 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 /* DEBUG: section 49 SNMP Interface */
10 
11 #include "squid.h"
12 #include "base/TextException.h"
13 #include "comm.h"
14 #include "CommCalls.h"
15 #include "globals.h"
16 #include "ipc/Port.h"
17 #include "snmp/Forwarder.h"
18 #include "snmp/Request.h"
19 #include "snmp/Response.h"
20 #include "snmp_core.h"
21 
23 
24 Snmp::Forwarder::Forwarder(const Pdu& aPdu, const Session& aSession, int aFd,
25  const Ip::Address& anAddress):
26  Ipc::Forwarder(new Request(KidIdentifier, Ipc::RequestId(), aPdu, aSession, aFd, anAddress), 2),
27  fd(aFd)
28 {
29  debugs(49, 5, "FD " << aFd);
30  Must(fd >= 0);
31  closer = asyncCall(49, 5, "Snmp::Forwarder::noteCommClosed",
34 }
35 
37 void
39 {
40  if (fd >= 0) {
41  if (closer != NULL) {
42  comm_remove_close_handler(fd, closer);
43  closer = NULL;
44  }
45  fd = -1;
46  }
48 }
49 
51 void
53 {
54  debugs(49, 5, MYNAME);
55  Must(fd == params.fd);
56  closer = nullptr;
57  fd = -1;
58  mustStop("commClosed");
59 }
60 
61 void
63 {
66 }
67 
68 void
69 Snmp::Forwarder::handleException(const std::exception& e)
70 {
71  debugs(49, 3, e.what());
72  sendError(SNMP_ERR_GENERR);
74 }
75 
77 void
79 {
80  debugs(49, 3, MYNAME);
81 
82  if (fd < 0)
83  return; // client gone
84 
85  Snmp::Request& req = static_cast<Snmp::Request&>(*request);
87  req.pdu.errstat = error;
88  u_char buffer[SNMP_REQUEST_SIZE];
89  int len = sizeof(buffer);
90  snmp_build(&req.session, &req.pdu, buffer, &len);
91  comm_udp_sendto(fd, req.address, buffer, len);
92 }
93 
94 void
95 Snmp::SendResponse(const Ipc::RequestId requestId, const Pdu &pdu)
96 {
97  debugs(49, 5, MYNAME);
98  // snmpAgentResponse() can modify arg
99  Pdu tmp = pdu;
100  Snmp::Response response(requestId);
101  snmp_pdu* response_pdu = NULL;
102  try {
103  response_pdu = snmpAgentResponse(&tmp);
104  Must(response_pdu != NULL);
105  response.pdu = static_cast<Pdu&>(*response_pdu);
106  snmp_free_pdu(response_pdu);
107  } catch (const std::exception& e) {
108  debugs(49, DBG_CRITICAL, e.what());
109  response.pdu.command = SNMP_PDU_RESPONSE;
110  response.pdu.errstat = SNMP_ERR_GENERR;
111  }
112  Ipc::TypedMsgHdr message;
113  response.pack(message);
115 }
116 
AsyncCall * asyncCall(int aDebugSection, int aDebugLevel, const char *aName, const Dialer &aDialer)
Definition: AsyncCall.h:154
#define Must(condition)
Definition: TextException.h:71
void error(char *format,...)
int fd
FD which the call was about. Set by the async call creator.
Definition: CommCalls.h:90
virtual void swanSong()
Definition: Forwarder.cc:69
virtual void handleTimeout()
Definition: Forwarder.cc:127
virtual void handleException(const std::exception &e)
terminate with an error
Definition: Forwarder.cc:134
static String CoordinatorAddr()
get the IPC message address for coordinator process
Definition: Port.cc:65
struct msghdr with a known type, fixed-size I/O and control buffers
Definition: TypedMsgHdr.h:33
int fd
client connection descriptor
Definition: Forwarder.h:46
virtual void handleTimeout()
Definition: Forwarder.cc:62
virtual void handleException(const std::exception &e)
terminate with an error
Definition: Forwarder.cc:69
void noteCommClosed(const CommCloseCbParams &params)
called when the client socket gets closed by some external force
Definition: Forwarder.cc:52
AsyncCall::Pointer closer
comm_close handler for the connection
Definition: Forwarder.h:47
void sendError(int error)
send error SNMP response
Definition: Forwarder.cc:78
Forwarder(const Pdu &aPdu, const Session &aSession, int aFd, const Ip::Address &anAddress)
Definition: Forwarder.cc:24
virtual void swanSong()
removes our cleanup handler of the client connection socket
Definition: Forwarder.cc:38
Definition: Pdu.h:24
SNMP request.
Definition: Request.h:25
Session session
SNMP session.
Definition: Request.h:37
Ip::Address address
client address
Definition: Request.h:39
Pdu pdu
SNMP protocol data unit.
Definition: Request.h:36
virtual void pack(Ipc::TypedMsgHdr &msg) const
prepare for sendmsg()
Definition: Response.cc:31
Pdu pdu
SNMP protocol data unit.
Definition: Response.h:33
snmp_session wrapper add pack/unpack feature
Definition: Session.h:23
AsyncCall::Pointer comm_add_close_handler(int fd, CLCB *handler, void *data)
Definition: comm.cc:921
void comm_remove_close_handler(int fd, CLCB *handler, void *data)
Definition: comm.cc:950
int comm_udp_sendto(int fd, const Ip::Address &to_addr, const void *buf, int len)
Definition: comm.cc:890
#define MYNAME
Definition: Stream.h:238
#define debugs(SECTION, LEVEL, CONTENT)
Definition: Stream.h:196
#define DBG_CRITICAL
Definition: Stream.h:40
int KidIdentifier
CBDATA_NAMESPACED_CLASS_INIT(Ipc, Forwarder)
Definition: IpcIoFile.h:24
void SendMessage(const String &toAddress, const TypedMsgHdr &message)
Definition: UdsOp.cc:188
Definition: forward.h:15
void SendResponse(Ipc::RequestId, const Pdu &)
Definition: Forwarder.cc:95
int snmp_build(struct snmp_session *, struct snmp_pdu *, u_char *, int *)
Definition: snmp_api.c:106
struct snmp_pdu * snmpAgentResponse(struct snmp_pdu *PDU)
Definition: snmp_core.cc:456
#define SNMP_REQUEST_SIZE
Definition: snmp_core.h:21
#define SNMP_ERR_GENERR
Definition: snmp_error.h:47
#define SNMP_ERR_RESOURCEUNAVAILABLE
Definition: snmp_error.h:56
#define SNMP_PDU_RESPONSE
Definition: snmp_pdu.h:94
void snmp_free_pdu(struct snmp_pdu *)
Definition: snmp_pdu.c:284
int command
Definition: snmp_pdu.h:51
int errstat
Definition: snmp_pdu.h:55
#define NULL
Definition: types.h:166

 

Introduction

Documentation

Support

Miscellaneous

Web Site Translations

Mirrors