iPXE
Data Structures | Macros | Enumerations | Functions | Variables
tftp.c File Reference

TFTP protocol. More...

#include <stdint.h>
#include <stdlib.h>
#include <stdio.h>
#include <string.h>
#include <strings.h>
#include <byteswap.h>
#include <errno.h>
#include <assert.h>
#include <ipxe/refcnt.h>
#include <ipxe/iobuf.h>
#include <ipxe/xfer.h>
#include <ipxe/open.h>
#include <ipxe/uri.h>
#include <ipxe/tcpip.h>
#include <ipxe/retry.h>
#include <ipxe/features.h>
#include <ipxe/bitmap.h>
#include <ipxe/settings.h>
#include <ipxe/dhcp.h>
#include <ipxe/profile.h>
#include <ipxe/errortab.h>
#include <ipxe/tftp.h>

Go to the source code of this file.

Data Structures

struct  tftp_request
 A TFTP request. More...
 
struct  tftp_option
 A TFTP option. More...
 

Macros

#define EINVAL_BLKSIZE   __einfo_error ( EINFO_EINVAL_BLKSIZE )
 
#define EINFO_EINVAL_BLKSIZE
 
#define EINVAL_TSIZE   __einfo_error ( EINFO_EINVAL_TSIZE )
 
#define EINFO_EINVAL_TSIZE
 
#define EINVAL_MC_NO_PORT   __einfo_error ( EINFO_EINVAL_MC_NO_PORT )
 
#define EINFO_EINVAL_MC_NO_PORT
 
#define EINVAL_MC_NO_MC   __einfo_error ( EINFO_EINVAL_MC_NO_MC )
 
#define EINFO_EINVAL_MC_NO_MC
 
#define EINVAL_MC_INVALID_MC   __einfo_error ( EINFO_EINVAL_MC_INVALID_MC )
 
#define EINFO_EINVAL_MC_INVALID_MC
 
#define EINVAL_MC_INVALID_IP   __einfo_error ( EINFO_EINVAL_MC_INVALID_IP )
 
#define EINFO_EINVAL_MC_INVALID_IP
 
#define EINVAL_MC_INVALID_PORT   __einfo_error ( EINFO_EINVAL_MC_INVALID_PORT )
 
#define EINFO_EINVAL_MC_INVALID_PORT
 
#define ENOENT_NOT_FOUND   __einfo_error ( EINFO_ENOENT_NOT_FOUND )
 
#define EINFO_ENOENT_NOT_FOUND
 
#define MTFTP_MAX_TIMEOUTS   3
 Maximum number of MTFTP open requests before falling back to TFTP. More...
 

Enumerations

enum  { TFTP_FL_SEND_ACK = 0x0001, TFTP_FL_RRQ_SIZES = 0x0002, TFTP_FL_RRQ_MULTICAST = 0x0004, TFTP_FL_MTFTP_RECOVERY = 0x0008 }
 TFTP request flags. More...
 

Functions

 FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)
 
 FEATURE (FEATURE_PROTOCOL, "TFTP", DHCP_EB_FEATURE_TFTP, 1)
 
static void tftp_free (struct refcnt *refcnt)
 Free TFTP request. More...
 
static void tftp_done (struct tftp_request *tftp, int rc)
 Mark TFTP request as complete. More...
 
static int tftp_reopen (struct tftp_request *tftp)
 Reopen TFTP socket. More...
 
static int tftp_reopen_mc (struct tftp_request *tftp, struct sockaddr *local)
 Reopen TFTP multicast socket. More...
 
static int tftp_presize (struct tftp_request *tftp, size_t filesize)
 Presize TFTP receive buffers and block bitmap. More...
 
void tftp_set_mtftp_address (struct in_addr address)
 Set MTFTP multicast address. More...
 
void tftp_set_mtftp_port (unsigned int port)
 Set MTFTP multicast port. More...
 
static int tftp_send_rrq (struct tftp_request *tftp)
 Transmit RRQ. More...
 
static int tftp_send_ack (struct tftp_request *tftp)
 Transmit ACK. More...
 
static int tftp_send_error (struct tftp_request *tftp, int errcode, const char *errmsg)
 Transmit ERROR (Abort) More...
 
static int tftp_send_packet (struct tftp_request *tftp)
 Transmit next relevant packet. More...
 
static void tftp_timer_expired (struct retry_timer *timer, int fail)
 Handle TFTP retransmission timer expiry. More...
 
static int tftp_process_blksize (struct tftp_request *tftp, char *value)
 Process TFTP "blksize" option. More...
 
static int tftp_process_tsize (struct tftp_request *tftp, char *value)
 Process TFTP "tsize" option. More...
 
static int tftp_process_multicast (struct tftp_request *tftp, char *value)
 Process TFTP "multicast" option. More...
 
static int tftp_process_option (struct tftp_request *tftp, const char *name, char *value)
 Process TFTP option. More...
 
static int tftp_rx_oack (struct tftp_request *tftp, void *buf, size_t len)
 Receive OACK. More...
 
static int tftp_rx_data (struct tftp_request *tftp, struct io_buffer *iobuf)
 Receive DATA. More...
 
static int tftp_errcode_to_rc (unsigned int errcode)
 Convert TFTP error code to return status code. More...
 
static int tftp_rx_error (struct tftp_request *tftp, void *buf, size_t len)
 Receive ERROR. More...
 
static int tftp_rx (struct tftp_request *tftp, struct io_buffer *iobuf, struct xfer_metadata *meta)
 Receive new data. More...
 
static int tftp_socket_deliver (struct tftp_request *tftp, struct io_buffer *iobuf, struct xfer_metadata *meta)
 Receive new data via socket. More...
 
static size_t tftp_xfer_window (struct tftp_request *tftp)
 Check flow control window. More...
 
static void tftp_close (struct tftp_request *tftp, int rc)
 Terminate download. More...
 
static int tftp_core_open (struct interface *xfer, struct uri *uri, unsigned int default_port, struct sockaddr *multicast, unsigned int flags)
 Initiate TFTP/TFTM/MTFTP download. More...
 
static int tftp_open (struct interface *xfer, struct uri *uri)
 Initiate TFTP download. More...
 
static int tftm_open (struct interface *xfer, struct uri *uri)
 Initiate TFTM download. More...
 
static int mtftp_open (struct interface *xfer, struct uri *uri)
 Initiate MTFTP download. More...
 
static int tftp_apply_settings (void)
 Apply TFTP configuration settings. More...
 

Variables

static struct profiler tftp_client_profiler __profiler
 Client profiler. More...
 
struct errortab tftp_errors [] __errortab
 Human-readable error messages. More...
 
static struct sockaddr_in tftp_mtftp_socket
 MTFTP multicast receive address. More...
 
static struct tftp_option tftp_options []
 Recognised TFTP options. More...
 
static struct interface_operation tftp_socket_operations []
 TFTP socket operations. More...
 
static struct interface_descriptor tftp_socket_desc
 TFTP socket interface descriptor. More...
 
static struct interface_operation tftp_mc_socket_operations []
 TFTP multicast socket operations. More...
 
static struct interface_descriptor tftp_mc_socket_desc
 TFTP multicast socket interface descriptor. More...
 
static struct interface_operation tftp_xfer_operations []
 TFTP data transfer interface operations. More...
 
static struct interface_descriptor tftp_xfer_desc
 TFTP data transfer interface descriptor. More...
 
struct uri_opener tftp_uri_opener __uri_opener
 TFTP URI opener. More...
 
struct settings_applicator tftp_settings_applicator __settings_applicator
 TFTP settings applicator. More...
 

Detailed Description

TFTP protocol.

Definition in file tftp.c.

Macro Definition Documentation

◆ EINVAL_BLKSIZE

#define EINVAL_BLKSIZE   __einfo_error ( EINFO_EINVAL_BLKSIZE )

Definition at line 59 of file tftp.c.

◆ EINFO_EINVAL_BLKSIZE

#define EINFO_EINVAL_BLKSIZE
Value:
( EINFO_EINVAL, 0x01, "Invalid blksize" )
#define EINFO_EINVAL
Definition: errno.h:429
#define __einfo_uniqify(einfo_base, uniq, desc)
Declare disambiguated error.
Definition: errno.h:180

Definition at line 60 of file tftp.c.

◆ EINVAL_TSIZE

#define EINVAL_TSIZE   __einfo_error ( EINFO_EINVAL_TSIZE )

Definition at line 62 of file tftp.c.

◆ EINFO_EINVAL_TSIZE

#define EINFO_EINVAL_TSIZE
Value:
( EINFO_EINVAL, 0x02, "Invalid tsize" )
#define EINFO_EINVAL
Definition: errno.h:429
#define __einfo_uniqify(einfo_base, uniq, desc)
Declare disambiguated error.
Definition: errno.h:180

Definition at line 63 of file tftp.c.

◆ EINVAL_MC_NO_PORT

#define EINVAL_MC_NO_PORT   __einfo_error ( EINFO_EINVAL_MC_NO_PORT )

Definition at line 65 of file tftp.c.

◆ EINFO_EINVAL_MC_NO_PORT

#define EINFO_EINVAL_MC_NO_PORT
Value:
( EINFO_EINVAL, 0x03, "Missing multicast port" )
#define EINFO_EINVAL
Definition: errno.h:429
#define __einfo_uniqify(einfo_base, uniq, desc)
Declare disambiguated error.
Definition: errno.h:180

Definition at line 66 of file tftp.c.

◆ EINVAL_MC_NO_MC

#define EINVAL_MC_NO_MC   __einfo_error ( EINFO_EINVAL_MC_NO_MC )

Definition at line 68 of file tftp.c.

◆ EINFO_EINVAL_MC_NO_MC

#define EINFO_EINVAL_MC_NO_MC
Value:
( EINFO_EINVAL, 0x04, "Missing multicast mc" )
#define EINFO_EINVAL
Definition: errno.h:429
#define __einfo_uniqify(einfo_base, uniq, desc)
Declare disambiguated error.
Definition: errno.h:180

Definition at line 69 of file tftp.c.

◆ EINVAL_MC_INVALID_MC

#define EINVAL_MC_INVALID_MC   __einfo_error ( EINFO_EINVAL_MC_INVALID_MC )

Definition at line 71 of file tftp.c.

◆ EINFO_EINVAL_MC_INVALID_MC

#define EINFO_EINVAL_MC_INVALID_MC
Value:
( EINFO_EINVAL, 0x05, "Missing multicast IP" )
#define EINFO_EINVAL
Definition: errno.h:429
#define __einfo_uniqify(einfo_base, uniq, desc)
Declare disambiguated error.
Definition: errno.h:180

Definition at line 72 of file tftp.c.

◆ EINVAL_MC_INVALID_IP

#define EINVAL_MC_INVALID_IP   __einfo_error ( EINFO_EINVAL_MC_INVALID_IP )

Definition at line 74 of file tftp.c.

◆ EINFO_EINVAL_MC_INVALID_IP

#define EINFO_EINVAL_MC_INVALID_IP
Value:
( EINFO_EINVAL, 0x06, "Invalid multicast IP" )
#define EINFO_EINVAL
Definition: errno.h:429
#define __einfo_uniqify(einfo_base, uniq, desc)
Declare disambiguated error.
Definition: errno.h:180

Definition at line 75 of file tftp.c.

◆ EINVAL_MC_INVALID_PORT

#define EINVAL_MC_INVALID_PORT   __einfo_error ( EINFO_EINVAL_MC_INVALID_PORT )

Definition at line 77 of file tftp.c.

◆ EINFO_EINVAL_MC_INVALID_PORT

#define EINFO_EINVAL_MC_INVALID_PORT
Value:
( EINFO_EINVAL, 0x07, "Invalid multicast port" )
#define EINFO_EINVAL
Definition: errno.h:429
#define __einfo_uniqify(einfo_base, uniq, desc)
Declare disambiguated error.
Definition: errno.h:180

Definition at line 78 of file tftp.c.

◆ ENOENT_NOT_FOUND

#define ENOENT_NOT_FOUND   __einfo_error ( EINFO_ENOENT_NOT_FOUND )

Definition at line 80 of file tftp.c.

◆ EINFO_ENOENT_NOT_FOUND

#define EINFO_ENOENT_NOT_FOUND
Value:
( EINFO_ENOENT, 0x01, "Not found" )
#define EINFO_ENOENT
Definition: errno.h:515
#define __einfo_uniqify(einfo_base, uniq, desc)
Declare disambiguated error.
Definition: errno.h:180

Definition at line 81 of file tftp.c.

◆ MTFTP_MAX_TIMEOUTS

#define MTFTP_MAX_TIMEOUTS   3

Maximum number of MTFTP open requests before falling back to TFTP.

Definition at line 164 of file tftp.c.

Enumeration Type Documentation

◆ anonymous enum

anonymous enum

TFTP request flags.

Enumerator
TFTP_FL_SEND_ACK 

Send ACK packets.

TFTP_FL_RRQ_SIZES 

Request blksize and tsize options.

TFTP_FL_RRQ_MULTICAST 

Request multicast option.

TFTP_FL_MTFTP_RECOVERY 

Perform MTFTP recovery on timeout.

Definition at line 152 of file tftp.c.

152  {
153  /** Send ACK packets */
154  TFTP_FL_SEND_ACK = 0x0001,
155  /** Request blksize and tsize options */
156  TFTP_FL_RRQ_SIZES = 0x0002,
157  /** Request multicast option */
158  TFTP_FL_RRQ_MULTICAST = 0x0004,
159  /** Perform MTFTP recovery on timeout */
160  TFTP_FL_MTFTP_RECOVERY = 0x0008,
161 };
Send ACK packets.
Definition: tftp.c:154
Request blksize and tsize options.
Definition: tftp.c:156
Perform MTFTP recovery on timeout.
Definition: tftp.c:160
Request multicast option.
Definition: tftp.c:158

Function Documentation

◆ FILE_LICENCE()

FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL  )

◆ FEATURE()

FEATURE ( FEATURE_PROTOCOL  ,
"TFTP"  ,
DHCP_EB_FEATURE_TFTP  ,
 
)

◆ tftp_free()

static void tftp_free ( struct refcnt refcnt)
static

Free TFTP request.

Parameters
refcntReference counter

Definition at line 184 of file tftp.c.

184  {
185  struct tftp_request *tftp =
186  container_of ( refcnt, struct tftp_request, refcnt );
187 
188  uri_put ( tftp->uri );
189  bitmap_free ( &tftp->bitmap );
190  free ( tftp );
191 }
static void uri_put(struct uri *uri)
Decrement URI reference count.
Definition: uri.h:205
static void bitmap_free(struct bitmap *bitmap)
Free bitmap resources.
Definition: bitmap.h:57
struct bitmap bitmap
Block bitmap.
Definition: tftp.c:134
A TFTP request.
Definition: tftp.c:89
A reference counter.
Definition: refcnt.h:26
#define container_of(ptr, type, field)
Get containing structure.
Definition: stddef.h:35
static void(* free)(struct refcnt *refcnt))
Definition: refcnt.h:54
struct uri * uri
URI being fetched.
Definition: tftp.c:96

References tftp_request::bitmap, bitmap_free(), container_of, free, tftp_request::uri, and uri_put().

Referenced by tftp_core_open().

◆ tftp_done()

static void tftp_done ( struct tftp_request tftp,
int  rc 
)
static

Mark TFTP request as complete.

Parameters
tftpTFTP connection
rcReturn status code

Definition at line 199 of file tftp.c.

199  {
200 
201  DBGC ( tftp, "TFTP %p finished with status %d (%s)\n",
202  tftp, rc, strerror ( rc ) );
203 
204  /* Stop the retry timer */
205  stop_timer ( &tftp->timer );
206 
207  /* Close all data transfer interfaces */
208  intf_shutdown ( &tftp->socket, rc );
209  intf_shutdown ( &tftp->mc_socket, rc );
210  intf_shutdown ( &tftp->xfer, rc );
211 }
struct interface socket
Transport layer interface.
Definition: tftp.c:98
struct arbelprm_rc_send_wqe rc
Definition: arbel.h:14
void intf_shutdown(struct interface *intf, int rc)
Shut down an object interface.
Definition: interface.c:278
#define DBGC(...)
Definition: compiler.h:505
struct interface xfer
Data transfer interface.
Definition: tftp.c:93
struct interface mc_socket
Multicast transport layer interface.
Definition: tftp.c:100
char * strerror(int errno)
Retrieve string representation of error number.
Definition: strerror.c:78
struct retry_timer timer
Retransmission timer.
Definition: tftp.c:148
void stop_timer(struct retry_timer *timer)
Stop timer.
Definition: retry.c:117

References DBGC, intf_shutdown(), tftp_request::mc_socket, rc, tftp_request::socket, stop_timer(), strerror(), tftp_request::timer, and tftp_request::xfer.

Referenced by tftp_close(), tftp_core_open(), tftp_rx_data(), tftp_rx_error(), tftp_rx_oack(), and tftp_timer_expired().

◆ tftp_reopen()

static int tftp_reopen ( struct tftp_request tftp)
static

Reopen TFTP socket.

Parameters
tftpTFTP connection
Return values
rcReturn status code

Definition at line 219 of file tftp.c.

219  {
220  struct sockaddr_tcpip server;
221  int rc;
222 
223  /* Close socket */
224  intf_restart ( &tftp->socket, 0 );
225 
226  /* Disable ACK sending. */
227  tftp->flags &= ~TFTP_FL_SEND_ACK;
228 
229  /* Reset peer address */
230  memset ( &tftp->peer, 0, sizeof ( tftp->peer ) );
231 
232  /* Open socket */
233  memset ( &server, 0, sizeof ( server ) );
234  server.st_port = htons ( tftp->port );
235  if ( ( rc = xfer_open_named_socket ( &tftp->socket, SOCK_DGRAM,
236  ( struct sockaddr * ) &server,
237  tftp->uri->host, NULL ) ) != 0 ) {
238  DBGC ( tftp, "TFTP %p could not open socket: %s\n",
239  tftp, strerror ( rc ) );
240  return rc;
241  }
242 
243  return 0;
244 }
struct interface socket
Transport layer interface.
Definition: tftp.c:98
TCP/IP socket address.
Definition: tcpip.h:75
struct arbelprm_rc_send_wqe rc
Definition: arbel.h:14
void intf_restart(struct interface *intf, int rc)
Shut down and restart an object interface.
Definition: interface.c:343
#define SOCK_DGRAM
Definition: socket.h:29
#define DBGC(...)
Definition: compiler.h:505
unsigned int flags
Request flags.
Definition: tftp.c:129
Send ACK packets.
Definition: tftp.c:154
Generalized socket address structure.
Definition: socket.h:96
char * strerror(int errno)
Retrieve string representation of error number.
Definition: strerror.c:78
const char * host
Host name.
Definition: uri.h:76
unsigned int port
Server port.
Definition: tftp.c:121
struct uri * uri
URI being fetched.
Definition: tftp.c:96
struct sockaddr_tcpip peer
Peer address.
Definition: tftp.c:127
#define NULL
NULL pointer (VOID *)
Definition: Base.h:321
#define htons(value)
Definition: byteswap.h:135
int xfer_open_named_socket(struct interface *xfer, int semantics, struct sockaddr *peer, const char *name, struct sockaddr *local)
Open named socket.
Definition: resolv.c:402
void * memset(void *dest, int character, size_t len) __nonnull

References DBGC, tftp_request::flags, uri::host, htons, intf_restart(), memset(), NULL, tftp_request::peer, tftp_request::port, rc, SOCK_DGRAM, tftp_request::socket, sockaddr_tcpip::st_port, strerror(), TFTP_FL_SEND_ACK, tftp_request::uri, and xfer_open_named_socket().

Referenced by tftp_core_open(), and tftp_timer_expired().

◆ tftp_reopen_mc()

static int tftp_reopen_mc ( struct tftp_request tftp,
struct sockaddr local 
)
static

Reopen TFTP multicast socket.

Parameters
tftpTFTP connection
localLocal socket address
Return values
rcReturn status code

Definition at line 253 of file tftp.c.

254  {
255  int rc;
256 
257  /* Close multicast socket */
258  intf_restart ( &tftp->mc_socket, 0 );
259 
260  /* Open multicast socket. We never send via this socket, so
261  * use the local address as the peer address (since the peer
262  * address cannot be NULL).
263  */
264  if ( ( rc = xfer_open_socket ( &tftp->mc_socket, SOCK_DGRAM,
265  local, local ) ) != 0 ) {
266  DBGC ( tftp, "TFTP %p could not open multicast "
267  "socket: %s\n", tftp, strerror ( rc ) );
268  return rc;
269  }
270 
271  return 0;
272 }
struct arbelprm_rc_send_wqe rc
Definition: arbel.h:14
void intf_restart(struct interface *intf, int rc)
Shut down and restart an object interface.
Definition: interface.c:343
int xfer_open_socket(struct interface *intf, int semantics, struct sockaddr *peer, struct sockaddr *local)
Open socket.
Definition: open.c:142
#define SOCK_DGRAM
Definition: socket.h:29
#define DBGC(...)
Definition: compiler.h:505
struct interface mc_socket
Multicast transport layer interface.
Definition: tftp.c:100
char * strerror(int errno)
Retrieve string representation of error number.
Definition: strerror.c:78

References DBGC, intf_restart(), tftp_request::mc_socket, rc, SOCK_DGRAM, strerror(), and xfer_open_socket().

Referenced by tftp_core_open(), and tftp_process_multicast().

◆ tftp_presize()

static int tftp_presize ( struct tftp_request tftp,
size_t  filesize 
)
static

Presize TFTP receive buffers and block bitmap.

Parameters
tftpTFTP connection
filesizeKnown minimum file size
Return values
rcReturn status code

Definition at line 281 of file tftp.c.

281  {
282  unsigned int num_blocks;
283  int rc;
284 
285  /* Do nothing if we are already large enough */
286  if ( filesize <= tftp->filesize )
287  return 0;
288 
289  /* Record filesize */
290  tftp->filesize = filesize;
291 
292  /* Notify recipient of file size */
293  xfer_seek ( &tftp->xfer, filesize );
294  xfer_seek ( &tftp->xfer, 0 );
295 
296  /* Calculate expected number of blocks. Note that files whose
297  * length is an exact multiple of the blocksize will have a
298  * trailing zero-length block, which must be included.
299  */
300  if ( tftp->blksize == 0 )
301  return -EINVAL;
302  num_blocks = ( ( filesize / tftp->blksize ) + 1 );
303  if ( ( rc = bitmap_resize ( &tftp->bitmap, num_blocks ) ) != 0 ) {
304  DBGC ( tftp, "TFTP %p could not resize bitmap to %d blocks: "
305  "%s\n", tftp, num_blocks, strerror ( rc ) );
306  return rc;
307  }
308 
309  return 0;
310 }
#define EINVAL
Invalid argument.
Definition: errno.h:428
struct arbelprm_rc_send_wqe rc
Definition: arbel.h:14
struct bitmap bitmap
Block bitmap.
Definition: tftp.c:134
#define DBGC(...)
Definition: compiler.h:505
unsigned int blksize
Data block size.
Definition: tftp.c:108
struct interface xfer
Data transfer interface.
Definition: tftp.c:93
int bitmap_resize(struct bitmap *bitmap, unsigned int new_length)
Resize bitmap.
Definition: bitmap.c:42
int xfer_seek(struct interface *intf, off_t offset)
Seek to position.
Definition: xfer.c:351
char * strerror(int errno)
Retrieve string representation of error number.
Definition: strerror.c:78
size_t filesize
Maximum known length.
Definition: tftp.c:146

References tftp_request::bitmap, bitmap_resize(), tftp_request::blksize, DBGC, EINVAL, tftp_request::filesize, rc, strerror(), tftp_request::xfer, and xfer_seek().

Referenced by tftp_rx_data(), and tftp_rx_oack().

◆ tftp_set_mtftp_address()

void tftp_set_mtftp_address ( struct in_addr  address)

Set MTFTP multicast address.

Parameters
addressMulticast IPv4 address

Definition at line 328 of file tftp.c.

328  {
330 }
uint64_t address
Base address.
Definition: ena.h:24
static struct sockaddr_in tftp_mtftp_socket
MTFTP multicast receive address.
Definition: tftp.c:317
struct in_addr sin_addr
IPv4 address.
Definition: in.h:100

References address, sockaddr_in::sin_addr, and tftp_mtftp_socket.

◆ tftp_set_mtftp_port()

void tftp_set_mtftp_port ( unsigned int  port)

Set MTFTP multicast port.

Parameters
portMulticast port

Definition at line 337 of file tftp.c.

337  {
339 }
u8 port
Port number.
Definition: CIB_PRM.h:31
uint16_t sin_port
TCP/IP port (part of struct sockaddr_tcpip)
Definition: in.h:93
static struct sockaddr_in tftp_mtftp_socket
MTFTP multicast receive address.
Definition: tftp.c:317
#define htons(value)
Definition: byteswap.h:135

References htons, port, sockaddr_in::sin_port, and tftp_mtftp_socket.

◆ tftp_send_rrq()

static int tftp_send_rrq ( struct tftp_request tftp)
static

Transmit RRQ.

Parameters
tftpTFTP connection
Return values
rcReturn status code

Definition at line 347 of file tftp.c.

347  {
348  const char *path = ( tftp->uri->path + 1 /* skip '/' */ );
349  struct tftp_rrq *rrq;
350  size_t len;
351  struct io_buffer *iobuf;
352  size_t blksize;
353 
354  DBGC ( tftp, "TFTP %p requesting \"%s\"\n", tftp, path );
355 
356  /* Allocate buffer */
357  len = ( sizeof ( *rrq ) + strlen ( path ) + 1 /* NUL */
358  + 5 + 1 /* "octet" + NUL */
359  + 7 + 1 + 5 + 1 /* "blksize" + NUL + ddddd + NUL */
360  + 5 + 1 + 1 + 1 /* "tsize" + NUL + "0" + NUL */
361  + 9 + 1 + 1 /* "multicast" + NUL + NUL */ );
362  iobuf = xfer_alloc_iob ( &tftp->socket, len );
363  if ( ! iobuf )
364  return -ENOMEM;
365 
366  /* Determine block size */
367  blksize = xfer_window ( &tftp->xfer );
368  if ( blksize > TFTP_MAX_BLKSIZE )
370 
371  /* Build request */
372  rrq = iob_put ( iobuf, sizeof ( *rrq ) );
373  rrq->opcode = htons ( TFTP_RRQ );
374  iob_put ( iobuf, snprintf ( iobuf->tail, iob_tailroom ( iobuf ),
375  "%s%coctet", path, 0 ) + 1 );
376  if ( tftp->flags & TFTP_FL_RRQ_SIZES ) {
377  iob_put ( iobuf, snprintf ( iobuf->tail,
378  iob_tailroom ( iobuf ),
379  "blksize%c%zd%ctsize%c0",
380  0, blksize, 0, 0 ) + 1 );
381  }
382  if ( tftp->flags & TFTP_FL_RRQ_MULTICAST ) {
383  iob_put ( iobuf, snprintf ( iobuf->tail,
384  iob_tailroom ( iobuf ),
385  "multicast%c", 0 ) + 1 );
386  }
387 
388  /* RRQ always goes to the address specified in the initial
389  * xfer_open() call
390  */
391  return xfer_deliver_iob ( &tftp->socket, iobuf );
392 }
struct interface socket
Transport layer interface.
Definition: tftp.c:98
#define TFTP_MAX_BLKSIZE
Definition: tftp.h:16
#define iob_put(iobuf, len)
Definition: iobuf.h:120
int xfer_deliver_iob(struct interface *intf, struct io_buffer *iobuf)
Deliver datagram as I/O buffer without metadata.
Definition: xfer.c:255
#define DBGC(...)
Definition: compiler.h:505
struct io_buffer * xfer_alloc_iob(struct interface *intf, size_t len)
Allocate I/O buffer.
Definition: xfer.c:158
size_t xfer_window(struct interface *intf)
Check flow control window.
Definition: xfer.c:116
void * tail
End of data.
Definition: iobuf.h:50
#define ENOMEM
Not enough space.
Definition: errno.h:534
unsigned int flags
Request flags.
Definition: tftp.c:129
struct interface xfer
Data transfer interface.
Definition: tftp.c:93
Request blksize and tsize options.
Definition: tftp.c:156
const char * path
Path (after URI decoding)
Definition: uri.h:80
uint16_t opcode
Definition: tftp.h:38
static size_t iob_tailroom(struct io_buffer *iobuf)
Calculate available space at end of an I/O buffer.
Definition: iobuf.h:175
size_t strlen(const char *src)
Get length of string.
Definition: string.c:243
A TFTP read request (RRQ) packet.
Definition: tftp.h:37
int snprintf(char *buf, size_t size, const char *fmt,...)
Write a formatted string to a buffer.
Definition: vsprintf.c:382
uint32_t blksize
Cipher block size.
Definition: pccrr.h:14
struct uri * uri
URI being fetched.
Definition: tftp.c:96
uint32_t len
Length.
Definition: ena.h:14
#define htons(value)
Definition: byteswap.h:135
Request multicast option.
Definition: tftp.c:158
#define TFTP_RRQ
Read request opcode.
Definition: tftp.h:18
A persistent I/O buffer.
Definition: iobuf.h:33

References blksize, DBGC, ENOMEM, tftp_request::flags, htons, iob_put, iob_tailroom(), len, tftp_rrq::opcode, uri::path, snprintf(), tftp_request::socket, strlen(), io_buffer::tail, TFTP_FL_RRQ_MULTICAST, TFTP_FL_RRQ_SIZES, TFTP_MAX_BLKSIZE, TFTP_RRQ, tftp_request::uri, tftp_request::xfer, xfer_alloc_iob(), xfer_deliver_iob(), and xfer_window().

Referenced by tftp_send_packet().

◆ tftp_send_ack()

static int tftp_send_ack ( struct tftp_request tftp)
static

Transmit ACK.

Parameters
tftpTFTP connection
Return values
rcReturn status code

Definition at line 400 of file tftp.c.

400  {
401  struct tftp_ack *ack;
402  struct io_buffer *iobuf;
403  struct xfer_metadata meta = {
404  .dest = ( struct sockaddr * ) &tftp->peer,
405  };
406  unsigned int block;
407 
408  /* Determine next required block number */
409  block = bitmap_first_gap ( &tftp->bitmap );
410  DBGC2 ( tftp, "TFTP %p sending ACK for block %d\n", tftp, block );
411 
412  /* Allocate buffer */
413  iobuf = xfer_alloc_iob ( &tftp->socket, sizeof ( *ack ) );
414  if ( ! iobuf )
415  return -ENOMEM;
416 
417  /* Build ACK */
418  ack = iob_put ( iobuf, sizeof ( *ack ) );
419  ack->opcode = htons ( TFTP_ACK );
420  ack->block = htons ( block );
421 
422  /* ACK always goes to the peer recorded from the RRQ response */
423  return xfer_deliver ( &tftp->socket, iobuf, &meta );
424 }
struct interface socket
Transport layer interface.
Definition: tftp.c:98
#define iob_put(iobuf, len)
Definition: iobuf.h:120
Data transfer metadata.
Definition: xfer.h:22
uint16_t opcode
Definition: tftp.h:51
struct bitmap bitmap
Block bitmap.
Definition: tftp.c:134
uint16_t block
Definition: tftp.h:52
struct io_buffer * xfer_alloc_iob(struct interface *intf, size_t len)
Allocate I/O buffer.
Definition: xfer.c:158
#define TFTP_ACK
Data block acknowledgement opcode.
Definition: tftp.h:21
#define ENOMEM
Not enough space.
Definition: errno.h:534
int meta(WINDOW *, bool)
Generalized socket address structure.
Definition: socket.h:96
int xfer_deliver(struct interface *intf, struct io_buffer *iobuf, struct xfer_metadata *meta)
Deliver datagram.
Definition: xfer.c:194
#define DBGC2(...)
Definition: compiler.h:522
uint8_t block[3][8]
DES-encrypted blocks.
Definition: mschapv2.h:12
static unsigned int bitmap_first_gap(struct bitmap *bitmap)
Get first gap within bitmap.
Definition: bitmap.h:69
struct sockaddr_tcpip peer
Peer address.
Definition: tftp.c:127
#define htons(value)
Definition: byteswap.h:135
A TFTP acknowledgement (ACK) packet.
Definition: tftp.h:50
A persistent I/O buffer.
Definition: iobuf.h:33

References tftp_request::bitmap, bitmap_first_gap(), block, tftp_ack::block, DBGC2, ENOMEM, htons, iob_put, meta(), tftp_ack::opcode, tftp_request::peer, tftp_request::socket, TFTP_ACK, xfer_alloc_iob(), and xfer_deliver().

Referenced by tftp_send_packet().

◆ tftp_send_error()

static int tftp_send_error ( struct tftp_request tftp,
int  errcode,
const char *  errmsg 
)
static

Transmit ERROR (Abort)

Parameters
tftpTFTP connection
errcodeTFTP error code
errmsgError message string
Return values
rcReturn status code

Definition at line 434 of file tftp.c.

435  {
436  struct tftp_error *err;
437  struct io_buffer *iobuf;
438  struct xfer_metadata meta = {
439  .dest = ( struct sockaddr * ) &tftp->peer,
440  };
441  size_t msglen;
442 
443  DBGC2 ( tftp, "TFTP %p sending ERROR %d: %s\n", tftp, errcode,
444  errmsg );
445 
446  /* Allocate buffer */
447  msglen = sizeof ( *err ) + strlen ( errmsg ) + 1 /* NUL */;
448  iobuf = xfer_alloc_iob ( &tftp->socket, msglen );
449  if ( ! iobuf )
450  return -ENOMEM;
451 
452  /* Build ERROR */
453  err = iob_put ( iobuf, msglen );
454  err->opcode = htons ( TFTP_ERROR );
455  err->errcode = htons ( errcode );
456  strcpy ( err->errmsg, errmsg );
457 
458  /* ERR always goes to the peer recorded from the RRQ response */
459  return xfer_deliver ( &tftp->socket, iobuf, &meta );
460 }
struct interface socket
Transport layer interface.
Definition: tftp.c:98
#define iob_put(iobuf, len)
Definition: iobuf.h:120
Data transfer metadata.
Definition: xfer.h:22
uint16_t errcode
Definition: tftp.h:12
struct io_buffer * xfer_alloc_iob(struct interface *intf, size_t len)
Allocate I/O buffer.
Definition: xfer.c:158
#define ENOMEM
Not enough space.
Definition: errno.h:534
uint16_t errcode
Definition: tftp.h:58
char errmsg[0]
Definition: tftp.h:13
char * strcpy(char *dest, const char *src)
Copy string.
Definition: string.c:346
int meta(WINDOW *, bool)
Generalized socket address structure.
Definition: socket.h:96
int xfer_deliver(struct interface *intf, struct io_buffer *iobuf, struct xfer_metadata *meta)
Deliver datagram.
Definition: xfer.c:194
size_t strlen(const char *src)
Get length of string.
Definition: string.c:243
#define TFTP_ERROR
Error opcode.
Definition: tftp.h:22
uint16_t opcode
Definition: tftp.h:57
char errmsg[0]
Definition: tftp.h:59
#define DBGC2(...)
Definition: compiler.h:522
struct sockaddr_tcpip peer
Peer address.
Definition: tftp.c:127
#define htons(value)
Definition: byteswap.h:135
A TFTP error (ERROR) packet.
Definition: tftp.h:56
A persistent I/O buffer.
Definition: iobuf.h:33

References DBGC2, ENOMEM, errcode, tftp_error::errcode, errmsg, tftp_error::errmsg, htons, iob_put, meta(), tftp_error::opcode, tftp_request::peer, tftp_request::socket, strcpy(), strlen(), TFTP_ERROR, xfer_alloc_iob(), and xfer_deliver().

Referenced by tftp_close().

◆ tftp_send_packet()

static int tftp_send_packet ( struct tftp_request tftp)
static

Transmit next relevant packet.

Parameters
tftpTFTP connection
Return values
rcReturn status code

Definition at line 468 of file tftp.c.

468  {
469 
470  /* Update retransmission timer. While name resolution takes place the
471  * window is zero. Avoid unnecessary delay after name resolution
472  * completes by retrying immediately.
473  */
474  stop_timer ( &tftp->timer );
475  if ( xfer_window ( &tftp->socket ) ) {
476  start_timer ( &tftp->timer );
477  } else {
478  start_timer_nodelay ( &tftp->timer );
479  }
480 
481  /* Send RRQ or ACK as appropriate */
482  if ( ! tftp->peer.st_family ) {
483  return tftp_send_rrq ( tftp );
484  } else {
485  if ( tftp->flags & TFTP_FL_SEND_ACK ) {
486  return tftp_send_ack ( tftp );
487  } else {
488  return 0;
489  }
490  }
491 }
struct interface socket
Transport layer interface.
Definition: tftp.c:98
static void start_timer_nodelay(struct retry_timer *timer)
Start timer with no delay.
Definition: retry.h:99
sa_family_t st_family
Socket address family (part of struct sockaddr)
Definition: tcpip.h:77
size_t xfer_window(struct interface *intf)
Check flow control window.
Definition: xfer.c:116
unsigned int flags
Request flags.
Definition: tftp.c:129
Send ACK packets.
Definition: tftp.c:154
static int tftp_send_rrq(struct tftp_request *tftp)
Transmit RRQ.
Definition: tftp.c:347
void start_timer(struct retry_timer *timer)
Start timer.
Definition: retry.c:93
static int tftp_send_ack(struct tftp_request *tftp)
Transmit ACK.
Definition: tftp.c:400
struct retry_timer timer
Retransmission timer.
Definition: tftp.c:148
void stop_timer(struct retry_timer *timer)
Stop timer.
Definition: retry.c:117
struct sockaddr_tcpip peer
Peer address.
Definition: tftp.c:127

References tftp_request::flags, tftp_request::peer, tftp_request::socket, sockaddr_tcpip::st_family, start_timer(), start_timer_nodelay(), stop_timer(), TFTP_FL_SEND_ACK, tftp_send_ack(), tftp_send_rrq(), tftp_request::timer, and xfer_window().

Referenced by tftp_rx_data(), tftp_rx_oack(), and tftp_timer_expired().

◆ tftp_timer_expired()

static void tftp_timer_expired ( struct retry_timer timer,
int  fail 
)
static

Handle TFTP retransmission timer expiry.

Parameters
timerRetry timer
failFailure indicator

Definition at line 499 of file tftp.c.

499  {
500  struct tftp_request *tftp =
501  container_of ( timer, struct tftp_request, timer );
502  int rc;
503 
504  /* If we are doing MTFTP, attempt the various recovery strategies */
505  if ( tftp->flags & TFTP_FL_MTFTP_RECOVERY ) {
506  if ( tftp->peer.st_family ) {
507  /* If we have received any response from the server,
508  * try resending the RRQ to restart the download.
509  */
510  DBGC ( tftp, "TFTP %p attempting reopen\n", tftp );
511  if ( ( rc = tftp_reopen ( tftp ) ) != 0 )
512  goto err;
513  } else {
514  /* Fall back to plain TFTP after several attempts */
515  tftp->mtftp_timeouts++;
516  DBGC ( tftp, "TFTP %p timeout %d waiting for MTFTP "
517  "open\n", tftp, tftp->mtftp_timeouts );
518 
519  if ( tftp->mtftp_timeouts > MTFTP_MAX_TIMEOUTS ) {
520  DBGC ( tftp, "TFTP %p falling back to plain "
521  "TFTP\n", tftp );
522  tftp->flags = TFTP_FL_RRQ_SIZES;
523 
524  /* Close multicast socket */
525  intf_restart ( &tftp->mc_socket, 0 );
526 
527  /* Reset retry timer */
528  start_timer_nodelay ( &tftp->timer );
529 
530  /* The blocksize may change: discard
531  * the block bitmap
532  */
533  bitmap_free ( &tftp->bitmap );
534  memset ( &tftp->bitmap, 0,
535  sizeof ( tftp->bitmap ) );
536 
537  /* Reopen on standard TFTP port */
538  tftp->port = TFTP_PORT;
539  if ( ( rc = tftp_reopen ( tftp ) ) != 0 )
540  goto err;
541  }
542  }
543  } else {
544  /* Not doing MTFTP (or have fallen back to plain
545  * TFTP); fail as per normal.
546  */
547  if ( fail ) {
548  rc = -ETIMEDOUT;
549  goto err;
550  }
551  }
552  tftp_send_packet ( tftp );
553  return;
554 
555  err:
556  tftp_done ( tftp, rc );
557 }
unsigned int mtftp_timeouts
MTFTP timeout count.
Definition: tftp.c:131
struct arbelprm_rc_send_wqe rc
Definition: arbel.h:14
void intf_restart(struct interface *intf, int rc)
Shut down and restart an object interface.
Definition: interface.c:343
static void start_timer_nodelay(struct retry_timer *timer)
Start timer with no delay.
Definition: retry.h:99
static int tftp_reopen(struct tftp_request *tftp)
Reopen TFTP socket.
Definition: tftp.c:219
static void bitmap_free(struct bitmap *bitmap)
Free bitmap resources.
Definition: bitmap.h:57
sa_family_t st_family
Socket address family (part of struct sockaddr)
Definition: tcpip.h:77
struct bitmap bitmap
Block bitmap.
Definition: tftp.c:134
#define DBGC(...)
Definition: compiler.h:505
#define MTFTP_MAX_TIMEOUTS
Maximum number of MTFTP open requests before falling back to TFTP.
Definition: tftp.c:164
A TFTP request.
Definition: tftp.c:89
A timer.
Definition: timer.h:28
unsigned int flags
Request flags.
Definition: tftp.c:129
#define container_of(ptr, type, field)
Get containing structure.
Definition: stddef.h:35
Request blksize and tsize options.
Definition: tftp.c:156
struct interface mc_socket
Multicast transport layer interface.
Definition: tftp.c:100
static void tftp_done(struct tftp_request *tftp, int rc)
Mark TFTP request as complete.
Definition: tftp.c:199
static int tftp_send_packet(struct tftp_request *tftp)
Transmit next relevant packet.
Definition: tftp.c:468
#define TFTP_PORT
Default TFTP server port.
Definition: tftp.h:14
Perform MTFTP recovery on timeout.
Definition: tftp.c:160
struct retry_timer timer
Retransmission timer.
Definition: tftp.c:148
unsigned int port
Server port.
Definition: tftp.c:121
struct sockaddr_tcpip peer
Peer address.
Definition: tftp.c:127
#define ETIMEDOUT
Connection timed out.
Definition: errno.h:669
void * memset(void *dest, int character, size_t len) __nonnull

References tftp_request::bitmap, bitmap_free(), container_of, DBGC, ETIMEDOUT, tftp_request::flags, intf_restart(), tftp_request::mc_socket, memset(), MTFTP_MAX_TIMEOUTS, tftp_request::mtftp_timeouts, tftp_request::peer, tftp_request::port, rc, sockaddr_tcpip::st_family, start_timer_nodelay(), tftp_done(), TFTP_FL_MTFTP_RECOVERY, TFTP_FL_RRQ_SIZES, TFTP_PORT, tftp_reopen(), tftp_send_packet(), and tftp_request::timer.

Referenced by tftp_core_open().

◆ tftp_process_blksize()

static int tftp_process_blksize ( struct tftp_request tftp,
char *  value 
)
static

Process TFTP "blksize" option.

Parameters
tftpTFTP connection
valueOption value
Return values
rcReturn status code

Definition at line 566 of file tftp.c.

566  {
567  char *end;
568 
569  tftp->blksize = strtoul ( value, &end, 10 );
570  if ( *end ) {
571  DBGC ( tftp, "TFTP %p got invalid blksize \"%s\"\n",
572  tftp, value );
573  return -EINVAL_BLKSIZE;
574  }
575  DBGC ( tftp, "TFTP %p blksize=%d\n", tftp, tftp->blksize );
576 
577  return 0;
578 }
unsigned long strtoul(const char *string, char **endp, int base)
Convert string to numeric value.
Definition: string.c:484
#define DBGC(...)
Definition: compiler.h:505
unsigned int blksize
Data block size.
Definition: tftp.c:108
pseudo_bit_t value[0x00020]
Definition: arbel.h:13
#define EINVAL_BLKSIZE
Definition: tftp.c:59
uint32_t end
Ending offset.
Definition: netvsc.h:18

References tftp_request::blksize, DBGC, EINVAL_BLKSIZE, end, strtoul(), and value.

◆ tftp_process_tsize()

static int tftp_process_tsize ( struct tftp_request tftp,
char *  value 
)
static

Process TFTP "tsize" option.

Parameters
tftpTFTP connection
valueOption value
Return values
rcReturn status code

Definition at line 587 of file tftp.c.

587  {
588  char *end;
589 
590  tftp->tsize = strtoul ( value, &end, 10 );
591  if ( *end ) {
592  DBGC ( tftp, "TFTP %p got invalid tsize \"%s\"\n",
593  tftp, value );
594  return -EINVAL_TSIZE;
595  }
596  DBGC ( tftp, "TFTP %p tsize=%ld\n", tftp, tftp->tsize );
597 
598  return 0;
599 }
unsigned long strtoul(const char *string, char **endp, int base)
Convert string to numeric value.
Definition: string.c:484
#define DBGC(...)
Definition: compiler.h:505
pseudo_bit_t value[0x00020]
Definition: arbel.h:13
uint32_t end
Ending offset.
Definition: netvsc.h:18
unsigned long tsize
File size.
Definition: tftp.c:115
#define EINVAL_TSIZE
Definition: tftp.c:62

References DBGC, EINVAL_TSIZE, end, strtoul(), tftp_request::tsize, and value.

◆ tftp_process_multicast()

static int tftp_process_multicast ( struct tftp_request tftp,
char *  value 
)
static

Process TFTP "multicast" option.

Parameters
tftpTFTP connection
valueOption value
Return values
rcReturn status code

Definition at line 608 of file tftp.c.

608  {
609  union {
610  struct sockaddr sa;
611  struct sockaddr_in sin;
612  } socket;
613  char *addr;
614  char *port;
615  char *port_end;
616  char *mc;
617  char *mc_end;
618  int rc;
619 
620  /* Split value into "addr,port,mc" fields */
621  addr = value;
622  port = strchr ( addr, ',' );
623  if ( ! port ) {
624  DBGC ( tftp, "TFTP %p multicast missing port,mc\n", tftp );
625  return -EINVAL_MC_NO_PORT;
626  }
627  *(port++) = '\0';
628  mc = strchr ( port, ',' );
629  if ( ! mc ) {
630  DBGC ( tftp, "TFTP %p multicast missing mc\n", tftp );
631  return -EINVAL_MC_NO_MC;
632  }
633  *(mc++) = '\0';
634 
635  /* Parse parameters */
636  if ( strtoul ( mc, &mc_end, 0 ) == 0 )
637  tftp->flags &= ~TFTP_FL_SEND_ACK;
638  if ( *mc_end ) {
639  DBGC ( tftp, "TFTP %p multicast invalid mc %s\n", tftp, mc );
640  return -EINVAL_MC_INVALID_MC;
641  }
642  DBGC ( tftp, "TFTP %p is%s the master client\n",
643  tftp, ( ( tftp->flags & TFTP_FL_SEND_ACK ) ? "" : " not" ) );
644  if ( *addr && *port ) {
645  socket.sin.sin_family = AF_INET;
646  if ( inet_aton ( addr, &socket.sin.sin_addr ) == 0 ) {
647  DBGC ( tftp, "TFTP %p multicast invalid IP address "
648  "%s\n", tftp, addr );
649  return -EINVAL_MC_INVALID_IP;
650  }
651  DBGC ( tftp, "TFTP %p multicast IP address %s\n",
652  tftp, inet_ntoa ( socket.sin.sin_addr ) );
653  socket.sin.sin_port = htons ( strtoul ( port, &port_end, 0 ) );
654  if ( *port_end ) {
655  DBGC ( tftp, "TFTP %p multicast invalid port %s\n",
656  tftp, port );
657  return -EINVAL_MC_INVALID_PORT;
658  }
659  DBGC ( tftp, "TFTP %p multicast port %d\n",
660  tftp, ntohs ( socket.sin.sin_port ) );
661  if ( ( rc = tftp_reopen_mc ( tftp, &socket.sa ) ) != 0 )
662  return rc;
663  }
664 
665  return 0;
666 }
struct arbelprm_rc_send_wqe rc
Definition: arbel.h:14
unsigned long strtoul(const char *string, char **endp, int base)
Convert string to numeric value.
Definition: string.c:484
#define EINVAL_MC_NO_MC
Definition: tftp.c:68
#define EINVAL_MC_INVALID_IP
Definition: tftp.c:74
#define DBGC(...)
Definition: compiler.h:505
#define EINVAL_MC_INVALID_PORT
Definition: tftp.c:77
IPv4 socket address.
Definition: in.h:84
#define ntohs(value)
Definition: byteswap.h:136
unsigned int flags
Request flags.
Definition: tftp.c:129
u8 port
Port number.
Definition: CIB_PRM.h:31
Send ACK packets.
Definition: tftp.c:154
pseudo_bit_t value[0x00020]
Definition: arbel.h:13
struct sockaddr sa
Definition: syslog.c:55
#define EINVAL_MC_NO_PORT
Definition: tftp.c:65
Generalized socket address structure.
Definition: socket.h:96
char * strchr(const char *src, int character)
Find character within a string.
Definition: string.c:271
int inet_aton(const char *string, struct in_addr *in)
Parse IPv4 address.
Definition: ipv4.c:641
char * inet_ntoa(struct in_addr in)
Convert IPv4 address to dotted-quad notation.
Definition: ipv4.c:668
#define EINVAL_MC_INVALID_MC
Definition: tftp.c:71
static int tftp_reopen_mc(struct tftp_request *tftp, struct sockaddr *local)
Reopen TFTP multicast socket.
Definition: tftp.c:253
u32 addr
Definition: sky2.h:8
struct sockaddr_in sin
Definition: syslog.c:57
#define htons(value)
Definition: byteswap.h:135
#define AF_INET
IPv4 Internet addresses.
Definition: socket.h:63
if(natsemi->flags &NATSEMI_64BIT) return 1

References addr, AF_INET, DBGC, EINVAL_MC_INVALID_IP, EINVAL_MC_INVALID_MC, EINVAL_MC_INVALID_PORT, EINVAL_MC_NO_MC, EINVAL_MC_NO_PORT, tftp_request::flags, htons, if(), inet_aton(), inet_ntoa(), ntohs, port, rc, sa, sin, strchr(), strtoul(), TFTP_FL_SEND_ACK, tftp_reopen_mc(), and value.

◆ tftp_process_option()

static int tftp_process_option ( struct tftp_request tftp,
const char *  name,
char *  value 
)
static

Process TFTP option.

Parameters
tftpTFTP connection
nameOption name
valueOption value
Return values
rcReturn status code

Definition at line 697 of file tftp.c.

698  {
699  struct tftp_option *option;
700 
701  for ( option = tftp_options ; option->name ; option++ ) {
702  if ( strcasecmp ( name, option->name ) == 0 )
703  return option->process ( tftp, value );
704  }
705 
706  DBGC ( tftp, "TFTP %p received unknown option \"%s\" = \"%s\"\n",
707  tftp, name, value );
708 
709  /* Unknown options should be silently ignored */
710  return 0;
711 }
const char * name
Definition: ath9k_hw.c:1984
#define DBGC(...)
Definition: compiler.h:505
int strcasecmp(const char *first, const char *second)
Compare case-insensitive strings.
Definition: string.c:208
A TFTP option.
Definition: tftp.c:669
A long option, as used for getopt_long()
Definition: getopt.h:24
pseudo_bit_t value[0x00020]
Definition: arbel.h:13
const char * name
Long name of this option.
Definition: getopt.h:26
static struct tftp_option tftp_options[]
Recognised TFTP options.
Definition: tftp.c:682

References DBGC, option::name, name, strcasecmp(), tftp_options, and value.

Referenced by tftp_rx_oack().

◆ tftp_rx_oack()

static int tftp_rx_oack ( struct tftp_request tftp,
void *  buf,
size_t  len 
)
static

Receive OACK.

Parameters
tftpTFTP connection
bufTemporary data buffer
lenLength of temporary data buffer
Return values
rcReturn status code

Definition at line 721 of file tftp.c.

721  {
722  struct tftp_oack *oack = buf;
723  char *end = buf + len;
724  char *name;
725  char *value;
726  char *next;
727  int rc = 0;
728 
729  /* Sanity check */
730  if ( len < sizeof ( *oack ) ) {
731  DBGC ( tftp, "TFTP %p received underlength OACK packet "
732  "length %zd\n", tftp, len );
733  rc = -EINVAL;
734  goto done;
735  }
736 
737  /* Process each option in turn */
738  for ( name = oack->data ; name < end ; name = next ) {
739 
740  /* Parse option name and value
741  *
742  * We treat parsing errors as non-fatal, because there
743  * exists at least one TFTP server (IBM Tivoli PXE
744  * Server 5.1.0.3) that has been observed to send
745  * malformed OACKs containing trailing garbage bytes.
746  */
747  value = ( name + strnlen ( name, ( end - name ) ) + 1 );
748  if ( value > end ) {
749  DBGC ( tftp, "TFTP %p received OACK with malformed "
750  "option name:\n", tftp );
751  DBGC_HD ( tftp, oack, len );
752  break;
753  }
754  if ( value == end ) {
755  DBGC ( tftp, "TFTP %p received OACK missing value "
756  "for option \"%s\"\n", tftp, name );
757  DBGC_HD ( tftp, oack, len );
758  break;
759  }
760  next = ( value + strnlen ( value, ( end - value ) ) + 1 );
761  if ( next > end ) {
762  DBGC ( tftp, "TFTP %p received OACK with malformed "
763  "value for option \"%s\":\n", tftp, name );
764  DBGC_HD ( tftp, oack, len );
765  break;
766  }
767 
768  /* Process option */
769  if ( ( rc = tftp_process_option ( tftp, name, value ) ) != 0 )
770  goto done;
771  }
772 
773  /* Process tsize information, if available */
774  if ( tftp->tsize ) {
775  if ( ( rc = tftp_presize ( tftp, tftp->tsize ) ) != 0 )
776  goto done;
777  }
778 
779  /* Request next data block */
780  tftp_send_packet ( tftp );
781 
782  done:
783  if ( rc )
784  tftp_done ( tftp, rc );
785  return rc;
786 }
#define EINVAL
Invalid argument.
Definition: errno.h:428
struct arbelprm_rc_send_wqe rc
Definition: arbel.h:14
const char * name
Definition: ath9k_hw.c:1984
A TFTP options acknowledgement (OACK) packet.
Definition: tftp.h:63
uint32_t next
Next descriptor address.
Definition: myson.h:18
static int tftp_process_option(struct tftp_request *tftp, const char *name, char *value)
Process TFTP option.
Definition: tftp.c:697
#define DBGC(...)
Definition: compiler.h:505
static int tftp_presize(struct tftp_request *tftp, size_t filesize)
Presize TFTP receive buffers and block bitmap.
Definition: tftp.c:281
pseudo_bit_t value[0x00020]
Definition: arbel.h:13
static void tftp_done(struct tftp_request *tftp, int rc)
Mark TFTP request as complete.
Definition: tftp.c:199
static int tftp_send_packet(struct tftp_request *tftp)
Transmit next relevant packet.
Definition: tftp.c:468
#define DBGC_HD(...)
Definition: compiler.h:507
char data[0]
Definition: tftp.h:65
size_t strnlen(const char *src, size_t max)
Get length of string.
Definition: string.c:255
uint32_t end
Ending offset.
Definition: netvsc.h:18
unsigned long tsize
File size.
Definition: tftp.c:115
uint32_t len
Length.
Definition: ena.h:14
struct bofm_section_header done
Definition: bofm_test.c:46

References tftp_oack::data, DBGC, DBGC_HD, done, EINVAL, end, len, name, next, rc, strnlen(), tftp_done(), tftp_presize(), tftp_process_option(), tftp_send_packet(), tftp_request::tsize, and value.

Referenced by tftp_rx().

◆ tftp_rx_data()

static int tftp_rx_data ( struct tftp_request tftp,
struct io_buffer iobuf 
)
static

Receive DATA.

Parameters
tftpTFTP connection
iobufI/O buffer
Return values
rcReturn status code

Takes ownership of I/O buffer.

Definition at line 797 of file tftp.c.

798  {
799  struct tftp_data *data = iobuf->data;
800  struct xfer_metadata meta;
801  unsigned int block;
802  off_t offset;
803  size_t data_len;
804  int rc;
805 
806  /* Sanity check */
807  if ( iob_len ( iobuf ) < sizeof ( *data ) ) {
808  DBGC ( tftp, "TFTP %p received underlength DATA packet "
809  "length %zd\n", tftp, iob_len ( iobuf ) );
810  rc = -EINVAL;
811  goto done;
812  }
813 
814  /* Calculate block number */
815  block = ( ( bitmap_first_gap ( &tftp->bitmap ) + 1 ) & ~0xffff );
816  if ( data->block == 0 && block == 0 ) {
817  DBGC ( tftp, "TFTP %p received data block 0\n", tftp );
818  rc = -EINVAL;
819  goto done;
820  }
821  block += ( ntohs ( data->block ) - 1 );
822 
823  /* Stop profiling server turnaround if applicable */
824  if ( block )
825  profile_stop ( &tftp_server_profiler );
826 
827  /* Extract data */
828  offset = ( block * tftp->blksize );
829  iob_pull ( iobuf, sizeof ( *data ) );
830  data_len = iob_len ( iobuf );
831  if ( data_len > tftp->blksize ) {
832  DBGC ( tftp, "TFTP %p received overlength DATA packet "
833  "length %zd\n", tftp, data_len );
834  rc = -EINVAL;
835  goto done;
836  }
837 
838  /* Deliver data */
839  memset ( &meta, 0, sizeof ( meta ) );
840  meta.flags = XFER_FL_ABS_OFFSET;
841  meta.offset = offset;
842  if ( ( rc = xfer_deliver ( &tftp->xfer, iob_disown ( iobuf ),
843  &meta ) ) != 0 ) {
844  DBGC ( tftp, "TFTP %p could not deliver data: %s\n",
845  tftp, strerror ( rc ) );
846  goto done;
847  }
848 
849  /* Ensure block bitmap is ready */
850  if ( ( rc = tftp_presize ( tftp, ( offset + data_len ) ) ) != 0 )
851  goto done;
852 
853  /* Mark block as received */
854  bitmap_set ( &tftp->bitmap, block );
855 
856  /* Acknowledge block */
857  tftp_send_packet ( tftp );
858 
859  /* Stop profiling client turnaround */
860  profile_stop ( &tftp_client_profiler );
861 
862  /* Start profiling server turnaround */
863  profile_start ( &tftp_server_profiler );
864 
865  /* If all blocks have been received, finish. */
866  if ( bitmap_full ( &tftp->bitmap ) )
867  tftp_done ( tftp, 0 );
868 
869  done:
870  free_iob ( iobuf );
871  if ( rc )
872  tftp_done ( tftp, rc );
873  return rc;
874 }
#define iob_pull(iobuf, len)
Definition: iobuf.h:102
#define EINVAL
Invalid argument.
Definition: errno.h:428
struct arbelprm_rc_send_wqe rc
Definition: arbel.h:14
Data transfer metadata.
Definition: xfer.h:22
#define XFER_FL_ABS_OFFSET
Offset is absolute.
Definition: xfer.h:47
void free_iob(struct io_buffer *iobuf)
Free I/O buffer.
Definition: iobuf.c:146
struct bitmap bitmap
Block bitmap.
Definition: tftp.c:134
#define DBGC(...)
Definition: compiler.h:505
A TFTP data (DATA) packet.
Definition: tftp.h:43
uint32_t data_len
Microcode data size (or 0 to indicate 2000 bytes)
Definition: ucode.h:26
#define ntohs(value)
Definition: byteswap.h:136
static int tftp_presize(struct tftp_request *tftp, size_t filesize)
Presize TFTP receive buffers and block bitmap.
Definition: tftp.c:281
static void profile_stop(struct profiler *profiler)
Stop profiling.
Definition: profile.h:173
unsigned int blksize
Data block size.
Definition: tftp.c:108
#define iob_disown(iobuf)
Disown an I/O buffer.
Definition: iobuf.h:212
struct interface xfer
Data transfer interface.
Definition: tftp.c:93
static void profile_start(struct profiler *profiler)
Start profiling.
Definition: profile.h:160
static void tftp_done(struct tftp_request *tftp, int rc)
Mark TFTP request as complete.
Definition: tftp.c:199
int meta(WINDOW *, bool)
static int tftp_send_packet(struct tftp_request *tftp)
Transmit next relevant packet.
Definition: tftp.c:468
char * strerror(int errno)
Retrieve string representation of error number.
Definition: strerror.c:78
static size_t iob_len(struct io_buffer *iobuf)
Calculate length of data in an I/O buffer.
Definition: iobuf.h:155
int xfer_deliver(struct interface *intf, struct io_buffer *iobuf, struct xfer_metadata *meta)
Deliver datagram.
Definition: xfer.c:194
void bitmap_set(struct bitmap *bitmap, unsigned int bit)
Set bit in bitmap.
Definition: bitmap.c:93
signed long off_t
Definition: stdint.h:8
uint8_t block[3][8]
DES-encrypted blocks.
Definition: mschapv2.h:12
void * data
Start of data.
Definition: iobuf.h:48
uint8_t data[48]
Additional event data.
Definition: ena.h:22
static unsigned int bitmap_first_gap(struct bitmap *bitmap)
Get first gap within bitmap.
Definition: bitmap.h:69
uint16_t offset
Offset to command line.
Definition: bzimage.h:8
static int bitmap_full(struct bitmap *bitmap)
Check to see if bitmap is full.
Definition: bitmap.h:81
struct bofm_section_header done
Definition: bofm_test.c:46
void * memset(void *dest, int character, size_t len) __nonnull

References tftp_request::bitmap, bitmap_first_gap(), bitmap_full(), bitmap_set(), tftp_request::blksize, block, data, io_buffer::data, data_len, DBGC, done, EINVAL, free_iob(), iob_disown, iob_len(), iob_pull, memset(), meta(), ntohs, offset, profile_start(), profile_stop(), rc, strerror(), tftp_done(), tftp_presize(), tftp_send_packet(), tftp_request::xfer, xfer_deliver(), and XFER_FL_ABS_OFFSET.

Referenced by tftp_rx().

◆ tftp_errcode_to_rc()

static int tftp_errcode_to_rc ( unsigned int  errcode)
static

Convert TFTP error code to return status code.

Parameters
errcodeTFTP error code
Return values
rcReturn status code

Definition at line 882 of file tftp.c.

882  {
883  switch ( errcode ) {
885  case TFTP_ERR_ACCESS_DENIED: return -EACCES;
886  case TFTP_ERR_ILLEGAL_OP: return -ENOTTY;
887  default: return -ENOTSUP;
888  }
889 }
uint16_t errcode
Definition: tftp.h:12
#define EACCES
Permission denied.
Definition: errno.h:298
#define ENOTSUP
Operation not supported.
Definition: errno.h:589
#define ENOENT_NOT_FOUND
Definition: tftp.c:80
#define TFTP_ERR_ILLEGAL_OP
Illegal TFTP operation.
Definition: tftp.h:28
#define TFTP_ERR_ACCESS_DENIED
Access violation.
Definition: tftp.h:26
#define ENOTTY
Inappropriate I/O control operation.
Definition: errno.h:594
#define TFTP_ERR_FILE_NOT_FOUND
File not found.
Definition: tftp.h:25

References EACCES, ENOENT_NOT_FOUND, ENOTSUP, ENOTTY, errcode, TFTP_ERR_ACCESS_DENIED, TFTP_ERR_FILE_NOT_FOUND, and TFTP_ERR_ILLEGAL_OP.

Referenced by tftp_rx_error().

◆ tftp_rx_error()

static int tftp_rx_error ( struct tftp_request tftp,
void *  buf,
size_t  len 
)
static

Receive ERROR.

Parameters
tftpTFTP connection
bufTemporary data buffer
lenLength of temporary data buffer
Return values
rcReturn status code

Definition at line 899 of file tftp.c.

899  {
900  struct tftp_error *error = buf;
901  int rc;
902 
903  /* Sanity check */
904  if ( len < sizeof ( *error ) ) {
905  DBGC ( tftp, "TFTP %p received underlength ERROR packet "
906  "length %zd\n", tftp, len );
907  return -EINVAL;
908  }
909 
910  DBGC ( tftp, "TFTP %p received ERROR packet with code %d, message "
911  "\"%s\"\n", tftp, ntohs ( error->errcode ), error->errmsg );
912 
913  /* Determine final operation result */
914  rc = tftp_errcode_to_rc ( ntohs ( error->errcode ) );
915 
916  /* Close TFTP request */
917  tftp_done ( tftp, rc );
918 
919  return 0;
920 }
#define EINVAL
Invalid argument.
Definition: errno.h:428
struct arbelprm_rc_send_wqe rc
Definition: arbel.h:14
static int tftp_errcode_to_rc(unsigned int errcode)
Convert TFTP error code to return status code.
Definition: tftp.c:882
struct arbelprm_completion_with_error error
Definition: arbel.h:12
#define DBGC(...)
Definition: compiler.h:505
#define ntohs(value)
Definition: byteswap.h:136
static void tftp_done(struct tftp_request *tftp, int rc)
Mark TFTP request as complete.
Definition: tftp.c:199
uint32_t len
Length.
Definition: ena.h:14
A TFTP error (ERROR) packet.
Definition: tftp.h:56

References DBGC, EINVAL, error, len, ntohs, rc, tftp_done(), and tftp_errcode_to_rc().

Referenced by tftp_rx().

◆ tftp_rx()

static int tftp_rx ( struct tftp_request tftp,
struct io_buffer iobuf,
struct xfer_metadata meta 
)
static

Receive new data.

Parameters
tftpTFTP connection
iobufI/O buffer
metaTransfer metadata
Return values
rcReturn status code

Definition at line 930 of file tftp.c.

932  {
933  struct sockaddr_tcpip *st_src;
934  struct tftp_common *common = iobuf->data;
935  size_t len = iob_len ( iobuf );
936  int rc = -EINVAL;
937 
938  /* Start profiling client turnaround */
939  profile_start ( &tftp_client_profiler );
940 
941  /* Sanity checks */
942  if ( len < sizeof ( *common ) ) {
943  DBGC ( tftp, "TFTP %p received underlength packet length "
944  "%zd\n", tftp, len );
945  goto done;
946  }
947  if ( ! meta->src ) {
948  DBGC ( tftp, "TFTP %p received packet without source port\n",
949  tftp );
950  goto done;
951  }
952 
953  /* Filter by TID. Set TID on first response received */
954  st_src = ( struct sockaddr_tcpip * ) meta->src;
955  if ( ! tftp->peer.st_family ) {
956  memcpy ( &tftp->peer, st_src, sizeof ( tftp->peer ) );
957  DBGC ( tftp, "TFTP %p using remote port %d\n", tftp,
958  ntohs ( tftp->peer.st_port ) );
959  } else if ( memcmp ( &tftp->peer, st_src,
960  sizeof ( tftp->peer ) ) != 0 ) {
961  DBGC ( tftp, "TFTP %p received packet from wrong source (got "
962  "%d, wanted %d)\n", tftp, ntohs ( st_src->st_port ),
963  ntohs ( tftp->peer.st_port ) );
964  goto done;
965  }
966 
967  switch ( common->opcode ) {
968  case htons ( TFTP_OACK ):
969  rc = tftp_rx_oack ( tftp, iobuf->data, len );
970  break;
971  case htons ( TFTP_DATA ):
972  rc = tftp_rx_data ( tftp, iob_disown ( iobuf ) );
973  break;
974  case htons ( TFTP_ERROR ):
975  rc = tftp_rx_error ( tftp, iobuf->data, len );
976  break;
977  default:
978  DBGC ( tftp, "TFTP %p received strange packet type %d\n",
979  tftp, ntohs ( common->opcode ) );
980  break;
981  };
982 
983  done:
984  free_iob ( iobuf );
985  return rc;
986 }
#define EINVAL
Invalid argument.
Definition: errno.h:428
TCP/IP socket address.
Definition: tcpip.h:75
struct arbelprm_rc_send_wqe rc
Definition: arbel.h:14
void free_iob(struct io_buffer *iobuf)
Free I/O buffer.
Definition: iobuf.c:146
sa_family_t st_family
Socket address family (part of struct sockaddr)
Definition: tcpip.h:77
#define DBGC(...)
Definition: compiler.h:505
#define ntohs(value)
Definition: byteswap.h:136
#define iob_disown(iobuf)
Disown an I/O buffer.
Definition: iobuf.h:212
static int tftp_rx_error(struct tftp_request *tftp, void *buf, size_t len)
Receive ERROR.
Definition: tftp.c:899
void * memcpy(void *dest, const void *src, size_t len) __nonnull
static int tftp_rx_data(struct tftp_request *tftp, struct io_buffer *iobuf)
Receive DATA.
Definition: tftp.c:797
static void profile_start(struct profiler *profiler)
Start profiling.
Definition: profile.h:160
int meta(WINDOW *, bool)
uint16_t st_port
TCP/IP port.
Definition: tcpip.h:81
static size_t iob_len(struct io_buffer *iobuf)
Calculate length of data in an I/O buffer.
Definition: iobuf.h:155
The common header of all TFTP packets.
Definition: tftp.h:69
struct ib_cm_common common
Definition: ib_mad.h:11
#define TFTP_ERROR
Error opcode.
Definition: tftp.h:22
#define TFTP_OACK
Options acknowledgement opcode.
Definition: tftp.h:23
static int tftp_rx_oack(struct tftp_request *tftp, void *buf, size_t len)
Receive OACK.
Definition: tftp.c:721
void * data
Start of data.
Definition: iobuf.h:48
uint8_t data[48]
Additional event data.
Definition: ena.h:22
#define TFTP_DATA
Data block opcode.
Definition: tftp.h:20
struct sockaddr_tcpip peer
Peer address.
Definition: tftp.c:127
int memcmp(const void *first, const void *second, size_t len)
Compare memory regions.
Definition: string.c:114
uint32_t len
Length.
Definition: ena.h:14
#define htons(value)
Definition: byteswap.h:135
struct bofm_section_header done
Definition: bofm_test.c:46
if(natsemi->flags &NATSEMI_64BIT) return 1

References common, io_buffer::data, DBGC, done, EINVAL, free_iob(), htons, if(), iob_disown, iob_len(), len, memcmp(), memcpy(), meta(), ntohs, tftp_request::peer, profile_start(), rc, sockaddr_tcpip::st_family, sockaddr_tcpip::st_port, TFTP_DATA, TFTP_ERROR, TFTP_OACK, tftp_rx_data(), tftp_rx_error(), and tftp_rx_oack().

Referenced by tftp_socket_deliver().

◆ tftp_socket_deliver()

static int tftp_socket_deliver ( struct tftp_request tftp,
struct io_buffer iobuf,
struct xfer_metadata meta 
)
static

Receive new data via socket.

Parameters
tftpTFTP connection
iobufI/O buffer
metaTransfer metadata
Return values
rcReturn status code

Definition at line 996 of file tftp.c.

998  {
999 
1000  /* Enable sending ACKs when we receive a unicast packet. This
1001  * covers three cases:
1002  *
1003  * 1. Standard TFTP; we should always send ACKs, and will
1004  * always receive a unicast packet before we need to send the
1005  * first ACK.
1006  *
1007  * 2. RFC2090 multicast TFTP; the only unicast packets we will
1008  * receive are the OACKs; enable sending ACKs here (before
1009  * processing the OACK) and disable it when processing the
1010  * multicast option if we are not the master client.
1011  *
1012  * 3. MTFTP; receiving a unicast datagram indicates that we
1013  * are the "master client" and should send ACKs.
1014  */
1015  tftp->flags |= TFTP_FL_SEND_ACK;
1016 
1017  return tftp_rx ( tftp, iobuf, meta );
1018 }
unsigned int flags
Request flags.
Definition: tftp.c:129
Send ACK packets.
Definition: tftp.c:154
int meta(WINDOW *, bool)
static int tftp_rx(struct tftp_request *tftp, struct io_buffer *iobuf, struct xfer_metadata *meta)
Receive new data.
Definition: tftp.c:930

References tftp_request::flags, meta(), TFTP_FL_SEND_ACK, and tftp_rx().

◆ tftp_xfer_window()

static size_t tftp_xfer_window ( struct tftp_request tftp)
static

Check flow control window.

Parameters
tftpTFTP connection
Return values
lenLength of window

Definition at line 1044 of file tftp.c.

1044  {
1045 
1046  /* We abuse this data-xfer method to convey the blocksize to
1047  * the caller. This really should be done using some kind of
1048  * stat() method, but we don't yet have the facility to do
1049  * that.
1050  */
1051  return tftp->blksize;
1052 }
unsigned int blksize
Data block size.
Definition: tftp.c:108

References tftp_request::blksize.

◆ tftp_close()

static void tftp_close ( struct tftp_request tftp,
int  rc 
)
static

Terminate download.

Parameters
tftpTFTP connection
rcReason for close

Definition at line 1060 of file tftp.c.

1060  {
1061 
1062  /* Abort download */
1063  tftp_send_error ( tftp, 0, "TFTP Aborted" );
1064 
1065  /* Close TFTP request */
1066  tftp_done ( tftp, rc );
1067 }
struct arbelprm_rc_send_wqe rc
Definition: arbel.h:14
static int tftp_send_error(struct tftp_request *tftp, int errcode, const char *errmsg)
Transmit ERROR (Abort)
Definition: tftp.c:434
static void tftp_done(struct tftp_request *tftp, int rc)
Mark TFTP request as complete.
Definition: tftp.c:199

References rc, tftp_done(), and tftp_send_error().

Referenced by pxenv_tftp_close().

◆ tftp_core_open()

static int tftp_core_open ( struct interface xfer,
struct uri uri,
unsigned int  default_port,
struct sockaddr multicast,
unsigned int  flags 
)
static

Initiate TFTP/TFTM/MTFTP download.

Parameters
xferData transfer interface
uriUniform Resource Identifier
Return values
rcReturn status code

Definition at line 1086 of file tftp.c.

1089  {
1090  struct tftp_request *tftp;
1091  int rc;
1092 
1093  /* Sanity checks */
1094  if ( ! uri->host )
1095  return -EINVAL;
1096  if ( ! uri->path )
1097  return -EINVAL;
1098  if ( uri->path[0] != '/' )
1099  return -EINVAL;
1100 
1101  /* Allocate and populate TFTP structure */
1102  tftp = zalloc ( sizeof ( *tftp ) );
1103  if ( ! tftp )
1104  return -ENOMEM;
1105  ref_init ( &tftp->refcnt, tftp_free );
1106  intf_init ( &tftp->xfer, &tftp_xfer_desc, &tftp->refcnt );
1107  intf_init ( &tftp->socket, &tftp_socket_desc, &tftp->refcnt );
1108  intf_init ( &tftp->mc_socket, &tftp_mc_socket_desc, &tftp->refcnt );
1109  timer_init ( &tftp->timer, tftp_timer_expired, &tftp->refcnt );
1110  tftp->uri = uri_get ( uri );
1111  tftp->blksize = TFTP_DEFAULT_BLKSIZE;
1112  tftp->flags = flags;
1113 
1114  /* Open socket */
1115  tftp->port = uri_port ( tftp->uri, default_port );
1116  if ( ( rc = tftp_reopen ( tftp ) ) != 0 )
1117  goto err;
1118 
1119  /* Open multicast socket */
1120  if ( multicast ) {
1121  if ( ( rc = tftp_reopen_mc ( tftp, multicast ) ) != 0 )
1122  goto err;
1123  }
1124 
1125  /* Start timer to initiate RRQ */
1126  start_timer_nodelay ( &tftp->timer );
1127 
1128  /* Attach to parent interface, mortalise self, and return */
1129  intf_plug_plug ( &tftp->xfer, xfer );
1130  ref_put ( &tftp->refcnt );
1131  return 0;
1132 
1133  err:
1134  DBGC ( tftp, "TFTP %p could not create request: %s\n",
1135  tftp, strerror ( rc ) );
1136  tftp_done ( tftp, rc );
1137  ref_put ( &tftp->refcnt );
1138  return rc;
1139 }
#define EINVAL
Invalid argument.
Definition: errno.h:428
struct interface socket
Transport layer interface.
Definition: tftp.c:98
struct arbelprm_rc_send_wqe rc
Definition: arbel.h:14
static void start_timer_nodelay(struct retry_timer *timer)
Start timer with no delay.
Definition: retry.h:99
static struct uri * uri_get(struct uri *uri)
Increment URI reference count.
Definition: uri.h:194
static int tftp_reopen(struct tftp_request *tftp)
Reopen TFTP socket.
Definition: tftp.c:219
#define ref_init(refcnt, free)
Initialise a reference counter.
Definition: refcnt.h:64
static struct interface_descriptor tftp_xfer_desc
TFTP data transfer interface descriptor.
Definition: tftp.c:1076
#define DBGC(...)
Definition: compiler.h:505
void intf_plug_plug(struct interface *a, struct interface *b)
Plug two object interfaces together.
Definition: interface.c:107
struct refcnt refcnt
Reference count.
Definition: tftp.c:91
A TFTP request.
Definition: tftp.c:89
unsigned int blksize
Data block size.
Definition: tftp.c:108
static void tftp_timer_expired(struct retry_timer *timer, int fail)
Handle TFTP retransmission timer expiry.
Definition: tftp.c:499
#define ENOMEM
Not enough space.
Definition: errno.h:534
static struct interface_descriptor tftp_socket_desc
TFTP socket interface descriptor.
Definition: tftp.c:1026
unsigned int flags
Request flags.
Definition: tftp.c:129
struct interface xfer
Data transfer interface.
Definition: tftp.c:93
static struct interface_descriptor tftp_mc_socket_desc
TFTP multicast socket interface descriptor.
Definition: tftp.c:1035
const char * path
Path (after URI decoding)
Definition: uri.h:80
struct interface mc_socket
Multicast transport layer interface.
Definition: tftp.c:100
static void tftp_free(struct refcnt *refcnt)
Free TFTP request.
Definition: tftp.c:184
static void tftp_done(struct tftp_request *tftp, int rc)
Mark TFTP request as complete.
Definition: tftp.c:199
uint8_t flags
Flags.
Definition: ena.h:18
char * strerror(int errno)
Retrieve string representation of error number.
Definition: strerror.c:78
void * zalloc(size_t size)
Allocate cleared memory.
Definition: malloc.c:624
const char * host
Host name.
Definition: uri.h:76
static int tftp_reopen_mc(struct tftp_request *tftp, struct sockaddr *local)
Reopen TFTP multicast socket.
Definition: tftp.c:253
struct retry_timer timer
Retransmission timer.
Definition: tftp.c:148
unsigned int port
Server port.
Definition: tftp.c:121
unsigned int uri_port(const struct uri *uri, unsigned int default_port)
Get port from URI.
Definition: uri.c:455
#define TFTP_DEFAULT_BLKSIZE
Default TFTP data block size.
Definition: tftp.h:15
A Uniform Resource Identifier.
Definition: uri.h:64
struct uri * uri
URI being fetched.
Definition: tftp.c:96
static void intf_init(struct interface *intf, struct interface_descriptor *desc, struct refcnt *refcnt)
Initialise an object interface.
Definition: interface.h:203
#define ref_put(refcnt)
Drop reference to object.
Definition: refcnt.h:106

References tftp_request::blksize, DBGC, EINVAL, ENOMEM, flags, tftp_request::flags, uri::host, intf_init(), intf_plug_plug(), tftp_request::mc_socket, uri::path, tftp_request::port, rc, ref_init, ref_put, tftp_request::refcnt, tftp_request::socket, start_timer_nodelay(), strerror(), TFTP_DEFAULT_BLKSIZE, tftp_done(), tftp_free(), tftp_mc_socket_desc, tftp_reopen(), tftp_reopen_mc(), tftp_socket_desc, tftp_timer_expired(), tftp_xfer_desc, tftp_request::timer, tftp_request::uri, uri_get(), uri_port(), tftp_request::xfer, and zalloc().

Referenced by mtftp_open(), tftm_open(), and tftp_open().

◆ tftp_open()

static int tftp_open ( struct interface xfer,
struct uri uri 
)
static

Initiate TFTP download.

Parameters
xferData transfer interface
uriUniform Resource Identifier
Return values
rcReturn status code

Definition at line 1148 of file tftp.c.

1148  {
1149  return tftp_core_open ( xfer, uri, TFTP_PORT, NULL,
1151 
1152 }
struct interface xfer
Data transfer interface.
Definition: tftp.c:93
Request blksize and tsize options.
Definition: tftp.c:156
#define TFTP_PORT
Default TFTP server port.
Definition: tftp.h:14
A Uniform Resource Identifier.
Definition: uri.h:64
static int tftp_core_open(struct interface *xfer, struct uri *uri, unsigned int default_port, struct sockaddr *multicast, unsigned int flags)
Initiate TFTP/TFTM/MTFTP download.
Definition: tftp.c:1086
#define NULL
NULL pointer (VOID *)
Definition: Base.h:321

References NULL, tftp_core_open(), TFTP_FL_RRQ_SIZES, TFTP_PORT, and tftp_request::xfer.

Referenced by pxenv_tftp_open().

◆ tftm_open()

static int tftm_open ( struct interface xfer,
struct uri uri 
)
static

Initiate TFTM download.

Parameters
xferData transfer interface
uriUniform Resource Identifier
Return values
rcReturn status code

Definition at line 1167 of file tftp.c.

1167  {
1168  return tftp_core_open ( xfer, uri, TFTP_PORT, NULL,
1169  ( TFTP_FL_RRQ_SIZES |
1171 
1172 }
struct interface xfer
Data transfer interface.
Definition: tftp.c:93
Request blksize and tsize options.
Definition: tftp.c:156
#define TFTP_PORT
Default TFTP server port.
Definition: tftp.h:14
A Uniform Resource Identifier.
Definition: uri.h:64
static int tftp_core_open(struct interface *xfer, struct uri *uri, unsigned int default_port, struct sockaddr *multicast, unsigned int flags)
Initiate TFTP/TFTM/MTFTP download.
Definition: tftp.c:1086
#define NULL
NULL pointer (VOID *)
Definition: Base.h:321
Request multicast option.
Definition: tftp.c:158

References NULL, tftp_core_open(), TFTP_FL_RRQ_MULTICAST, TFTP_FL_RRQ_SIZES, and TFTP_PORT.

◆ mtftp_open()

static int mtftp_open ( struct interface xfer,
struct uri uri 
)
static

Initiate MTFTP download.

Parameters
xferData transfer interface
uriUniform Resource Identifier
Return values
rcReturn status code

Definition at line 1187 of file tftp.c.

1187  {
1188  return tftp_core_open ( xfer, uri, MTFTP_PORT,
1189  ( struct sockaddr * ) &tftp_mtftp_socket,
1191 }
#define MTFTP_PORT
Default MTFTP server port.
Definition: tftp.h:34
struct interface xfer
Data transfer interface.
Definition: tftp.c:93
Generalized socket address structure.
Definition: socket.h:96
static struct sockaddr_in tftp_mtftp_socket
MTFTP multicast receive address.
Definition: tftp.c:317
Perform MTFTP recovery on timeout.
Definition: tftp.c:160
A Uniform Resource Identifier.
Definition: uri.h:64
static int tftp_core_open(struct interface *xfer, struct uri *uri, unsigned int default_port, struct sockaddr *multicast, unsigned int flags)
Initiate TFTP/TFTM/MTFTP download.
Definition: tftp.c:1086

References MTFTP_PORT, tftp_core_open(), TFTP_FL_MTFTP_RECOVERY, and tftp_mtftp_socket.

◆ tftp_apply_settings()

static int tftp_apply_settings ( void  )
static

Apply TFTP configuration settings.

Return values
rcReturn status code

Definition at line 1211 of file tftp.c.

1211  {
1212  static struct in_addr tftp_server = { 0 };
1213  struct in_addr new_tftp_server;
1214  char uri_string[32];
1215  struct uri *uri;
1216 
1217  /* Retrieve TFTP server setting */
1218  fetch_ipv4_setting ( NULL, &next_server_setting, &new_tftp_server );
1219 
1220  /* If TFTP server setting has changed, set the current working
1221  * URI to match. Do it only when the TFTP server has changed
1222  * to try to minimise surprises to the user, who probably
1223  * won't expect the CWURI to change just because they updated
1224  * an unrelated setting and triggered all the settings
1225  * applicators.
1226  */
1227  if ( new_tftp_server.s_addr &&
1228  ( new_tftp_server.s_addr != tftp_server.s_addr ) ) {
1229  DBGC ( &tftp_server, "TFTP server changed %s => ",
1230  inet_ntoa ( tftp_server ) );
1231  DBGC ( &tftp_server, "%s\n", inet_ntoa ( new_tftp_server ) );
1232  snprintf ( uri_string, sizeof ( uri_string ),
1233  "tftp://%s/", inet_ntoa ( new_tftp_server ) );
1234  uri = parse_uri ( uri_string );
1235  if ( ! uri )
1236  return -ENOMEM;
1237  churi ( uri );
1238  uri_put ( uri );
1239  tftp_server = new_tftp_server;
1240  }
1241 
1242  return 0;
1243 }
static void uri_put(struct uri *uri)
Decrement URI reference count.
Definition: uri.h:205
int fetch_ipv4_setting(struct settings *settings, const struct setting *setting, struct in_addr *inp)
Fetch value of IPv4 address setting.
Definition: settings.c:912
#define DBGC(...)
Definition: compiler.h:505
#define ENOMEM
Not enough space.
Definition: errno.h:534
void churi(struct uri *uri)
Change working URI.
Definition: cwuri.c:45
IP address structure.
Definition: in.h:41
char * inet_ntoa(struct in_addr in)
Convert IPv4 address to dotted-quad notation.
Definition: ipv4.c:668
uint32_t s_addr
Definition: in.h:42
int snprintf(char *buf, size_t size, const char *fmt,...)
Write a formatted string to a buffer.
Definition: vsprintf.c:382
A Uniform Resource Identifier.
Definition: uri.h:64
#define NULL
NULL pointer (VOID *)
Definition: Base.h:321
struct uri * parse_uri(const char *uri_string)
Parse URI.
Definition: uri.c:296

References churi(), DBGC, ENOMEM, fetch_ipv4_setting(), inet_ntoa(), NULL, parse_uri(), in_addr::s_addr, snprintf(), and uri_put().

Variable Documentation

◆ __profiler

struct profiler tftp_server_profiler __profiler
static
Initial value:
=
{ .name = "tftp.client" }

Client profiler.

Server profiler.

Definition at line 167 of file tftp.c.

◆ __errortab

struct errortab tftp_errors [] __errortab
Initial value:
= {
}
#define __einfo_errortab(einfo)
Definition: errortab.h:23
#define EINFO_ENOENT_NOT_FOUND
Definition: tftp.c:81

Human-readable error messages.

Definition at line 175 of file tftp.c.

◆ tftp_mtftp_socket

struct sockaddr_in tftp_mtftp_socket
static
Initial value:
= {
.sin_family = AF_INET,
.sin_addr.s_addr = htonl ( 0xefff0101 ),
.sin_port = htons ( 3001 ),
}
#define htonl(value)
Definition: byteswap.h:133
#define htons(value)
Definition: byteswap.h:135
#define AF_INET
IPv4 Internet addresses.
Definition: socket.h:63

MTFTP multicast receive address.

This is treated as a global configuration parameter.

Definition at line 317 of file tftp.c.

Referenced by mtftp_open(), tftp_set_mtftp_address(), and tftp_set_mtftp_port().

◆ tftp_options

struct tftp_option tftp_options[]
static
Initial value:
= {
{ "blksize", tftp_process_blksize },
{ "tsize", tftp_process_tsize },
{ "multicast", tftp_process_multicast },
{ NULL, NULL }
}
static int tftp_process_multicast(struct tftp_request *tftp, char *value)
Process TFTP "multicast" option.
Definition: tftp.c:608
static int tftp_process_tsize(struct tftp_request *tftp, char *value)
Process TFTP "tsize" option.
Definition: tftp.c:587
static int tftp_process_blksize(struct tftp_request *tftp, char *value)
Process TFTP "blksize" option.
Definition: tftp.c:566
#define NULL
NULL pointer (VOID *)
Definition: Base.h:321

Recognised TFTP options.

Definition at line 682 of file tftp.c.

Referenced by tftp_process_option().

◆ tftp_socket_operations

struct interface_operation tftp_socket_operations[]
static
Initial value:
= {
}
A TFTP request.
Definition: tftp.c:89
static int tftp_socket_deliver(struct tftp_request *tftp, struct io_buffer *iobuf, struct xfer_metadata *meta)
Receive new data via socket.
Definition: tftp.c:996
#define INTF_OP(op_type, object_type, op_func)
Define an object interface operation.
Definition: interface.h:32
int xfer_deliver(struct interface *intf, struct io_buffer *iobuf, struct xfer_metadata *meta)
Deliver datagram.
Definition: xfer.c:194

TFTP socket operations.

Definition at line 1021 of file tftp.c.

◆ tftp_socket_desc

struct interface_descriptor tftp_socket_desc
static
Initial value:
=
A TFTP request.
Definition: tftp.c:89
#define INTF_DESC(object_type, intf, operations)
Define an object interface descriptor.
Definition: interface.h:80
static struct interface_operation tftp_socket_operations[]
TFTP socket operations.
Definition: tftp.c:1021

TFTP socket interface descriptor.

Definition at line 1026 of file tftp.c.

Referenced by tftp_core_open().

◆ tftp_mc_socket_operations

struct interface_operation tftp_mc_socket_operations[]
static
Initial value:
= {
}
A TFTP request.
Definition: tftp.c:89
#define INTF_OP(op_type, object_type, op_func)
Define an object interface operation.
Definition: interface.h:32
int xfer_deliver(struct interface *intf, struct io_buffer *iobuf, struct xfer_metadata *meta)
Deliver datagram.
Definition: xfer.c:194
static int tftp_rx(struct tftp_request *tftp, struct io_buffer *iobuf, struct xfer_metadata *meta)
Receive new data.
Definition: tftp.c:930

TFTP multicast socket operations.

Definition at line 1030 of file tftp.c.

◆ tftp_mc_socket_desc

struct interface_descriptor tftp_mc_socket_desc
static
Initial value:
=
A TFTP request.
Definition: tftp.c:89
#define INTF_DESC(object_type, intf, operations)
Define an object interface descriptor.
Definition: interface.h:80
static struct interface_operation tftp_mc_socket_operations[]
TFTP multicast socket operations.
Definition: tftp.c:1030

TFTP multicast socket interface descriptor.

Definition at line 1035 of file tftp.c.

Referenced by tftp_core_open().

◆ tftp_xfer_operations

struct interface_operation tftp_xfer_operations[]
static
Initial value:
= {
}
void intf_close(struct interface *intf, int rc)
Close an object interface.
Definition: interface.c:249
A TFTP request.
Definition: tftp.c:89
size_t xfer_window(struct interface *intf)
Check flow control window.
Definition: xfer.c:116
static void tftp_close(struct tftp_request *tftp, int rc)
Terminate download.
Definition: tftp.c:1060
#define INTF_OP(op_type, object_type, op_func)
Define an object interface operation.
Definition: interface.h:32
static size_t tftp_xfer_window(struct tftp_request *tftp)
Check flow control window.
Definition: tftp.c:1044

TFTP data transfer interface operations.

Definition at line 1070 of file tftp.c.

◆ tftp_xfer_desc

struct interface_descriptor tftp_xfer_desc
static
Initial value:
=
A TFTP request.
Definition: tftp.c:89
#define INTF_DESC(object_type, intf, operations)
Define an object interface descriptor.
Definition: interface.h:80
static struct interface_operation tftp_xfer_operations[]
TFTP data transfer interface operations.
Definition: tftp.c:1070

TFTP data transfer interface descriptor.

Definition at line 1076 of file tftp.c.

Referenced by tftp_core_open().

◆ __uri_opener

struct uri_opener mtftp_uri_opener __uri_opener
Initial value:
= {
.scheme = "tftp",
.open = tftp_open,
}
static int tftp_open(struct interface *xfer, struct uri *uri)
Initiate TFTP download.
Definition: tftp.c:1148

TFTP URI opener.

MTFTP URI opener.

TFTM URI opener.

Definition at line 1155 of file tftp.c.

◆ __settings_applicator

struct settings_applicator tftp_settings_applicator __settings_applicator
Initial value:
= {
}
static int tftp_apply_settings(void)
Apply TFTP configuration settings.
Definition: tftp.c:1211

TFTP settings applicator.

Definition at line 1246 of file tftp.c.