[457] | 1 | This file lists major changes between release versions that require
|
---|
| 2 | ports or applications to be changed. Use it to update a port or an
|
---|
| 3 | application written for an older version of lwIP to correctly work
|
---|
| 4 | with newer versions.
|
---|
| 5 |
|
---|
| 6 |
|
---|
| 7 | (git master)
|
---|
| 8 |
|
---|
| 9 | * [Enter new changes just after this line - do not remove this line]
|
---|
| 10 |
|
---|
| 11 | (2.1.0)
|
---|
| 12 |
|
---|
| 13 | ++ Application changes:
|
---|
| 14 |
|
---|
| 15 | * Use the new altcp API for seamless TLS integration into existing TCP applications (see changelog)
|
---|
| 16 | * TCP only kills existing connections with a LOWER priority than the one currently being opened.
|
---|
| 17 | Previous implementations also kill existing connections of the SAME priority.
|
---|
| 18 | * ip4_route_src: parameter order is reversed: ip4_route_src(dest, src) -> ip4_route_src(src, dest)
|
---|
| 19 | to make parameter order consistent with other ip*_route*() functions.
|
---|
| 20 | Same also applies to LWIP_HOOK_IP4_ROUTE_SRC() parameter order.
|
---|
| 21 | * pbuf API: pbuf->type (an u8_t holding the enum 'pbuf_type') has changed to only hold a
|
---|
| 22 | description of the pbuf (e.g. data following pbuf struct, data volatile, allocation
|
---|
| 23 | source heap/pool/etc.). As a consequence, applications can't test pbuf->type any more.
|
---|
| 24 | Use pbuf_match_type(pbuf, type) instead.
|
---|
| 25 | * socket API: according to the standard, SO_ERROR now only returns asynchronous errors.
|
---|
| 26 | All other/normal/synchronous errors are (and always were) available via 'errno'.
|
---|
| 27 | LWIP_SOCKET_SET_ERRNO has been removed - 'errno' is always set - and required!
|
---|
| 28 | * httpd LWIP_HTTPD_CGI_SSI: httpd_cgi_handler() has an additional parameter "struct fs_file *"
|
---|
| 29 |
|
---|
| 30 | ++ Port changes:
|
---|
| 31 |
|
---|
| 32 | * tcpip_trycallback() was renamed to tcpip_callbackmsg_trycallback() to avoid confusion
|
---|
| 33 | with tcpip_try_callback()
|
---|
| 34 | * compatibility headers: moved from 'src/include/posix' to 'src/include/compat/posix',
|
---|
| 35 | 'src/include/compat/stdc' etc.
|
---|
| 36 | * The IPv6 implementation now supports address scopes. (See LWIP_IPV6_SCOPES documentation
|
---|
| 37 | and ip6_zone.h for more documentation)
|
---|
| 38 | * LWIP_HOOK_DHCP_APPEND_OPTIONS() has changed, see description in opt.h (options_out_len is not
|
---|
| 39 | available in struct dhcp any more)
|
---|
| 40 | * Added debug helper asserts to ensure threading/locking requirements are met (define
|
---|
| 41 | LWIP_MARK_TCPIP_THREAD() and LWIP_ASSERT_CORE_LOCKED()).
|
---|
| 42 | * Added sys_mbox_trypost_fromisr() and tcpip_callbackmsg_trycallback_fromisr()
|
---|
| 43 | These can be used to post preallocated messages from an ISR to the tcpip thread
|
---|
| 44 | (e.g. when using FreeRTOS)
|
---|
| 45 |
|
---|
| 46 | (2.0.2)
|
---|
| 47 |
|
---|
| 48 | ++ Application changes:
|
---|
| 49 |
|
---|
| 50 | * slipif: The way to pass serial port number has changed. netif->num is not
|
---|
| 51 | supported any more, netif->state is interpreted as an u8_t port number now
|
---|
| 52 | (it's not a POINTER to an u8_t any more!)
|
---|
| 53 |
|
---|
| 54 | (2.0.1)
|
---|
| 55 |
|
---|
| 56 | ++ Application changes:
|
---|
| 57 |
|
---|
| 58 | * UDP does NOT receive multicast traffic from ALL netifs on an UDP PCB bound to a specific
|
---|
| 59 | netif any more. Users need to bind to IP_ADDR_ANY to receive multicast traffic and compare
|
---|
| 60 | ip_current_netif() to the desired netif for every packet.
|
---|
| 61 | See bug #49662 for an explanation.
|
---|
| 62 |
|
---|
| 63 | (2.0.0)
|
---|
| 64 |
|
---|
| 65 | ++ Application changes:
|
---|
| 66 |
|
---|
| 67 | * Changed netif "up" flag handling to be an administrative flag (as opposed to the previous meaning of
|
---|
| 68 | "ip4-address-valid", a netif will now not be used for transmission if not up) -> even a DHCP netif
|
---|
| 69 | has to be set "up" before starting the DHCP client
|
---|
| 70 | * Added IPv6 support (dual-stack or IPv4/IPv6 only)
|
---|
| 71 | * Changed ip_addr_t to be a union in dual-stack mode (use ip4_addr_t where referring to IPv4 only).
|
---|
| 72 | * Major rewrite of SNMP (added MIB parser that creates code stubs for custom MIBs);
|
---|
| 73 | supports SNMPv2c (experimental v3 support)
|
---|
| 74 | * Moved some core applications from contrib repository to src/apps (and include/lwip/apps)
|
---|
| 75 |
|
---|
| 76 | +++ Raw API:
|
---|
| 77 | * Changed TCP listen backlog: removed tcp_accepted(), added the function pair tcp_backlog_delayed()/
|
---|
| 78 | tcp_backlog_accepted() to explicitly delay backlog handling on a connection pcb
|
---|
| 79 |
|
---|
| 80 | +++ Socket API:
|
---|
| 81 | * Added an implementation for posix sendmsg()
|
---|
| 82 | * Added LWIP_FIONREAD_LINUXMODE that makes ioctl/FIONREAD return the size of the next pending datagram
|
---|
| 83 |
|
---|
| 84 | ++ Port changes
|
---|
| 85 |
|
---|
| 86 | +++ new files:
|
---|
| 87 | * MANY new and moved files!
|
---|
| 88 | * Added src/Filelists.mk for use in Makefile projects
|
---|
| 89 | * Continued moving stack-internal parts from abc.h to abc_priv.h in sub-folder "priv"
|
---|
| 90 | to let abc.h only contain the actual application programmer's API
|
---|
| 91 |
|
---|
| 92 | +++ sys layer:
|
---|
| 93 | * Made LWIP_TCPIP_CORE_LOCKING==1 the default as it usually performs better than
|
---|
| 94 | the traditional message passing (although with LWIP_COMPAT_MUTEX you are still
|
---|
| 95 | open to priority inversion, so this is not recommended any more)
|
---|
| 96 | * Added LWIP_NETCONN_SEM_PER_THREAD to use one "op_completed" semaphore per thread
|
---|
| 97 | instead of using one per netconn (these semaphores are used even with core locking
|
---|
| 98 | enabled as some longer lasting functions like big writes still need to delay)
|
---|
| 99 | * Added generalized abstraction for itoa(), strnicmp(), stricmp() and strnstr()
|
---|
| 100 | in def.h (to be overridden in cc.h) instead of config
|
---|
| 101 | options for netbiosns, httpd, dns, etc. ...
|
---|
| 102 | * New abstraction for hton* and ntoh* functions in def.h.
|
---|
| 103 | To override them, use the following in cc.h:
|
---|
| 104 | #define lwip_htons(x) <your_htons>
|
---|
| 105 | #define lwip_htonl(x) <your_htonl>
|
---|
| 106 |
|
---|
| 107 | +++ new options:
|
---|
| 108 | * TODO
|
---|
| 109 |
|
---|
| 110 | +++ new pools:
|
---|
| 111 | * Added LWIP_MEMPOOL_* (declare/init/alloc/free) to declare private memp pools
|
---|
| 112 | that share memp.c code but do not have to be made global via lwippools.h
|
---|
| 113 | * Added pools for IPv6, MPU_COMPATIBLE, dns-api, netif-api, etc.
|
---|
| 114 | * added hook LWIP_HOOK_MEMP_AVAILABLE() to get informed when a memp pool was empty and an item
|
---|
| 115 | is now available
|
---|
| 116 |
|
---|
| 117 | * Signature of LWIP_HOOK_VLAN_SET macro was changed
|
---|
| 118 |
|
---|
| 119 | * LWIP_DECLARE_MEMORY_ALIGNED() may be used to declare aligned memory buffers (mem/memp)
|
---|
| 120 | or to move buffers to dedicated memory using compiler attributes
|
---|
| 121 |
|
---|
| 122 | * Standard C headers are used to define sized types and printf formatters
|
---|
| 123 | (disable by setting LWIP_NO_STDINT_H=1 or LWIP_NO_INTTYPES_H=1 if your compiler
|
---|
| 124 | does not support these)
|
---|
| 125 |
|
---|
| 126 |
|
---|
| 127 | ++ Major bugfixes/improvements
|
---|
| 128 |
|
---|
| 129 | * Added IPv6 support (dual-stack or IPv4/IPv6 only)
|
---|
| 130 | * Major rewrite of PPP (incl. keep-up with apache pppd)
|
---|
| 131 | see doc/ppp.txt for an upgrading how-to
|
---|
| 132 | * Major rewrite of SNMP (incl. MIB parser)
|
---|
| 133 | * Fixed timing issues that might have lead to losing a DHCP lease
|
---|
| 134 | * Made rx processing path more robust against crafted errors
|
---|
| 135 | * TCP window scaling support
|
---|
| 136 | * modification of api modules to support FreeRTOS-MPU (don't pass stack-pointers to other threads)
|
---|
| 137 | * made DNS client more robust
|
---|
| 138 | * support PBUF_REF for RX packets
|
---|
| 139 | * LWIP_NETCONN_FULLDUPLEX allows netconn/sockets to be used for reading/writing from separate
|
---|
| 140 | threads each (needs LWIP_NETCONN_SEM_PER_THREAD)
|
---|
| 141 | * Moved and reordered stats (mainly memp/mib2)
|
---|
| 142 |
|
---|
| 143 | (1.4.0)
|
---|
| 144 |
|
---|
| 145 | ++ Application changes:
|
---|
| 146 |
|
---|
| 147 | * Replaced struct ip_addr by typedef ip_addr_t (struct ip_addr is kept for
|
---|
| 148 | compatibility to old applications, but will be removed in the future).
|
---|
| 149 |
|
---|
| 150 | * Renamed mem_realloc() to mem_trim() to prevent confusion with realloc()
|
---|
| 151 |
|
---|
| 152 | +++ Raw API:
|
---|
| 153 | * Changed the semantics of tcp_close() (since it was rather a
|
---|
| 154 | shutdown before): Now the application does *NOT* get any calls to the recv
|
---|
| 155 | callback (aside from NULL/closed) after calling tcp_close()
|
---|
| 156 |
|
---|
| 157 | * When calling tcp_abort() from a raw API TCP callback function,
|
---|
| 158 | make sure you return ERR_ABRT to prevent accessing unallocated memory.
|
---|
| 159 | (ERR_ABRT now means the applicaiton has called tcp_abort!)
|
---|
| 160 |
|
---|
| 161 | +++ Netconn API:
|
---|
| 162 | * Changed netconn_receive() and netconn_accept() to return
|
---|
| 163 | err_t, not a pointer to new data/netconn.
|
---|
| 164 |
|
---|
| 165 | +++ Socket API:
|
---|
| 166 | * LWIP_SO_RCVTIMEO: when accept() or recv() time out, they
|
---|
| 167 | now set errno to EWOULDBLOCK/EAGAIN, not ETIMEDOUT.
|
---|
| 168 |
|
---|
| 169 | * Added a minimal version of posix fctl() to have a
|
---|
| 170 | standardised way to set O_NONBLOCK for nonblocking sockets.
|
---|
| 171 |
|
---|
| 172 | +++ all APIs:
|
---|
| 173 | * correctly implemented SO(F)_REUSEADDR
|
---|
| 174 |
|
---|
| 175 | ++ Port changes
|
---|
| 176 |
|
---|
| 177 | +++ new files:
|
---|
| 178 |
|
---|
| 179 | * Added 4 new files: def.c, timers.c, timers.h, tcp_impl.h:
|
---|
| 180 |
|
---|
| 181 | * Moved stack-internal parts of tcp.h to tcp_impl.h, tcp.h now only contains
|
---|
| 182 | the actual application programmer's API
|
---|
| 183 |
|
---|
| 184 | * Separated timer implementation from sys.h/.c, moved to timers.h/.c;
|
---|
| 185 | Added timer implementation for NO_SYS==1, set NO_SYS_NO_TIMERS==1 if you
|
---|
| 186 | still want to use your own timer implementation for NO_SYS==0 (as before).
|
---|
| 187 |
|
---|
| 188 | +++ sys layer:
|
---|
| 189 |
|
---|
| 190 | * Converted mbox- and semaphore-functions to take pointers to sys_mbox_t/
|
---|
| 191 | sys_sem_t;
|
---|
| 192 |
|
---|
| 193 | * Converted sys_mbox_new/sys_sem_new to take pointers and return err_t;
|
---|
| 194 |
|
---|
| 195 | * Added Mutex concept in sys_arch (define LWIP_COMPAT_MUTEX to let sys.h use
|
---|
| 196 | binary semaphores instead of mutexes - as before)
|
---|
| 197 |
|
---|
| 198 | +++ new options:
|
---|
| 199 |
|
---|
| 200 | * Don't waste memory when chaining segments, added option TCP_OVERSIZE to
|
---|
| 201 | prevent creating many small pbufs when calling tcp_write with many small
|
---|
| 202 | blocks of data. Instead, pbufs are allocated larger than needed and the
|
---|
| 203 | space is used for later calls to tcp_write.
|
---|
| 204 |
|
---|
| 205 | * Added LWIP_NETIF_TX_SINGLE_PBUF to always copy to try to create single pbufs
|
---|
| 206 | in tcp_write/udp_send.
|
---|
| 207 |
|
---|
| 208 | * Added an additional option LWIP_ETHERNET to support ethernet without ARP
|
---|
| 209 | (necessary for pure PPPoE)
|
---|
| 210 |
|
---|
| 211 | * Add MEMP_SEPARATE_POOLS to place memory pools in separate arrays. This may
|
---|
| 212 | be used to place these pools into user-defined memory by using external
|
---|
| 213 | declaration.
|
---|
| 214 |
|
---|
| 215 | * Added TCP_SNDQUEUELOWAT corresponding to TCP_SNDLOWAT
|
---|
| 216 |
|
---|
| 217 | +++ new pools:
|
---|
| 218 |
|
---|
| 219 | * Netdb uses a memp pool for allocating memory when getaddrinfo() is called,
|
---|
| 220 | so MEMP_NUM_NETDB has to be set accordingly.
|
---|
| 221 |
|
---|
| 222 | * DNS_LOCAL_HOSTLIST_IS_DYNAMIC uses a memp pool instead of the heap, so
|
---|
| 223 | MEMP_NUM_LOCALHOSTLIST has to be set accordingly.
|
---|
| 224 |
|
---|
| 225 | * Snmp-agent uses a memp pools instead of the heap, so MEMP_NUM_SNMP_* have
|
---|
| 226 | to be set accordingly.
|
---|
| 227 |
|
---|
| 228 | * PPPoE uses a MEMP pool instead of the heap, so MEMP_NUM_PPPOE_INTERFACES
|
---|
| 229 | has to be set accordingly
|
---|
| 230 |
|
---|
| 231 | * Integrated loopif into netif.c - loopif does not have to be created by the
|
---|
| 232 | port any more, just define LWIP_HAVE_LOOPIF to 1.
|
---|
| 233 |
|
---|
| 234 | * Added define LWIP_RAND() for lwip-wide randomization (needs to be defined
|
---|
| 235 | in cc.h, e.g. used by igmp)
|
---|
| 236 |
|
---|
| 237 | * Added printf-formatter X8_F to printf u8_t as hex
|
---|
| 238 |
|
---|
| 239 | * The heap now may be moved to user-defined memory by defining
|
---|
| 240 | LWIP_RAM_HEAP_POINTER as a void pointer to that memory's address
|
---|
| 241 |
|
---|
| 242 | * added autoip_set_struct() and dhcp_set_struct() to let autoip and dhcp work
|
---|
| 243 | with user-allocated structs instead of calling mem_malloc
|
---|
| 244 |
|
---|
| 245 | * Added const char* name to mem- and memp-stats for easier debugging.
|
---|
| 246 |
|
---|
| 247 | * Calculate the TCP/UDP checksum while copying to only fetch data once:
|
---|
| 248 | Define LWIP_CHKSUM_COPY to a memcpy-like function that returns the checksum
|
---|
| 249 |
|
---|
| 250 | * Added SO_REUSE_RXTOALL to pass received UDP broadcast/multicast packets to
|
---|
| 251 | more than one pcb.
|
---|
| 252 |
|
---|
| 253 | * Changed the semantics of ARP_QUEUEING==0: ARP_QUEUEING now cannot be turned
|
---|
| 254 | off any more, if this is set to 0, only one packet (the most recent one) is
|
---|
| 255 | queued (like demanded by RFC 1122).
|
---|
| 256 |
|
---|
| 257 |
|
---|
| 258 | ++ Major bugfixes/improvements
|
---|
| 259 |
|
---|
| 260 | * Implemented tcp_shutdown() to only shut down one end of a connection
|
---|
| 261 | * Implemented shutdown() at socket- and netconn-level
|
---|
| 262 | * Added errorset support to select() + improved select speed overhead
|
---|
| 263 | * Merged pppd to v2.3.11 (including some backported bugfixes from 2.4.x)
|
---|
| 264 | * Added timer implementation for NO_SYS==1 (may be disabled with NO_SYS_NO_TIMERS==1
|
---|
| 265 | * Use macros defined in ip_addr.h to work with IP addresses
|
---|
| 266 | * Implemented many nonblocking socket/netconn functions
|
---|
| 267 | * Fixed ARP input processing: only add a new entry if a request was directed as us
|
---|
| 268 | * mem_realloc() to mem_trim() to prevent confusion with realloc()
|
---|
| 269 | * Some improvements for AutoIP (don't route/forward link-local addresses, don't break
|
---|
| 270 | existing connections when assigning a routable address)
|
---|
| 271 | * Correctly handle remote side overrunning our rcv_wnd in ooseq case
|
---|
| 272 | * Removed packing from ip_addr_t, the packed version is now only used in protocol headers
|
---|
| 273 | * Corrected PBUF_POOL_BUFSIZE for ports where ETH_PAD_SIZE > 0
|
---|
| 274 | * Added support for static ARP table entries
|
---|
| 275 |
|
---|
| 276 | (STABLE-1.3.2)
|
---|
| 277 |
|
---|
| 278 | * initial version of this file
|
---|