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