-
Notifications
You must be signed in to change notification settings - Fork 7
/
CHANGELOG
1368 lines (1272 loc) · 66.2 KB
/
CHANGELOG
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
== OpenDataPlane (1.11.0.0)
ODP v1.11.0 is the base tag and branch for the Monarch LTS (Long Term Support)
release of ODP.
=== New Features
==== APIs
As part of the final Monarch LTS API set, a minor change to the
`odp_tm_egress_t` struct was made to better reflect the capabilities of
SoC platforms targeting Monarch support. This change adds the boolean
`egress_fcn_supported` that indicates whether TM systems support an egress
function. In addition, each TM system is now associated with a PktIO rather
than a PktOUT queue. This struct is input to the `odp_tm_create()` API and
output from the `odp_tm_find()` API.
==== Strict Priority (SP) Scheduler
Building on the modular scheduler framework introduced in v1.10.1.0, An
alternate Strict Priority (SP) scheduler is now available. The SP scheduler
is selected when ODP is configured with the `--enable_schedule_sp` option.
The SP scheduler is designed to favor low-latency processing of high priority
work at the expense of throughput. This is considered experimental code at
this point and should be treated as such by those wishing to use it.
=== Bug Fixes
==== Scheduler PktIO Cleanup
The scheduler now properly cleans up PktIOs operating in SCHEDULE mode following
`odp_pktio_close()` calls. This resolves
https://bugs.linaro.org/show_bug.cgi?id=2301[Bug 2301].
==== Chksum Routine C++ conformance
The odph_chksum() helper routine is now C++ conformant. This resolves
https://bugs.linaro.org/show_bug.cgi?id=2302[Bug 2302].
==== User Area Copying
The `odp_packet_copy()` API now copies the packet user area as part of its
processing and the packet validation test has been enhanced to verify that this
is done properly. This resolves
https://bugs.linaro.org/show_bug.cgi?id=2310[Bug 2310].
==== Use of Pool 0 as a Timeout Pool
The internal definition of `ODP_TIMEOUT_INVALID` was changed in `odp-linux` to
enable the use of Pool 0 as a timeout pool. This resolves
https://bugs.linaro.org/show_bug.cgi?id=2316[Bug 2316].
=== Packaging
==== libodphelper
To facilitate API tracking, `libodphelper.so` has been split out from
`libodp.so`.
==== Helper dependencies
To avoid circular dependencies that cause issues when packaging ODP as a
shared library, the `odp-linux` implementation no longer makes and use of
the ODP helper library.
=== Performance
Performance enhancements in the `odp-linux` reference implementation have been
made in PktIO routines and the packet classifier.
=== General Cleanup
General cleanup throughout has resulted in adding proper termination calls to
ODP examples as well as miscellaneous Doxygen corrections. Additionally, the
`odp-linux` code base has been cleaned up by removing "To Dos" as well as
extraneous `#includes` for extra C headers and dependencies on linux headers
for improved portability.
=== Validation
==== Queue Capability Test
The Queue validation test now properly exercises the `odp_queue_capability()`
API and attempts to create the maximum reported number of supported queues.
==== Platform Tests
The platform-specific tests have been moved from `platform/linux-generic/test`
to `test/platform/linux-generc` so that all tests are now found under a
single `test` directory.
=== Examples
The ODP `examples` directory has been cleaned up and numerous corrections to
existing examples have been made to add proper termination paths, etc. In
addition, a new "hello world" example (`odp_hello.c`) has been added that
illustrates the basic startup and shutdown steps needed for all ODP
applications. As a simple stand-alone application is is also a good initial
build tests for new ODP implementations.
=== Documentation
==== Pure API Guide
The Doxygen API guide has been split so that both a "pure" version that is
platform-independent and retains unresolved ODP abstract types as well as
an implementation-specific version (for `odp-linux`) that shows
platform-specific `typedef` and `enum` values.
==== Implementation Guide Improvements
The _ODP Implementer's Guide_ has been enhanced with a section on
implementation considerations, including issues surrounding the definition of
Application Binary Interfaces (ABIs).
=== Known Issues
==== https://bugs.linaro.org/show_bug.cgi?id=2309[Bug 2309]
The timer validation tests have seen occasional failures when run on systems
containing a larger number of CPUs (typically 24 or more).
==== https://bugs.linaro.org/show_bug.cgi?id=2386[Bug 2386]
ODP cannot be compiled using the -m32 option to generate 32-bit code on a
64-bit platform when using GCC 4.9 (the default GCC found in Ubuntu 15.04).
This is due to a known bug in GCC 4.9 and is closed as a permanent restriction.
==== https://bugs.linaro.org/show_bug.cgi?id=2402[Bug 2402]
Doxygen generates a warning for `ODP_BIG_ENDIAN_BITFIELD` when compiling on
little endian systems. A similar warning for `ODP_LITTLE_ENDIAN_BITFIELD` is
issued when compiling on big endian systems.
==== https://bugs.linaro.org/show_bug.cgi?id=2444[Bug 2444]
The traffic manager cannot be used with two PktIOs simultaneously. That is,
`odp-linux` does not properly support applications that create more than one
TM system. This is a bug in the `odp-linux` implementation that will be
corrected. It is not a limit of the architecture or other ODP implementations.
==== https://bugs.linaro.org/show_bug.cgi?id=2449[Bug 2449]
Packet queue pool causes out-of-bounds accesses. This is closely related
to https://bugs.linaro.org/show_bug.cgi?id=2444[Bug 2444] and reflects that
`odp-linux` does not properly support multiple TM systems. This is scheduled
for correction in the first maintenance update for this ODP implementation.
== OpenDataPlane (1.10.1.0)
=== New Features
==== APIs
ODP v1.10.1.0 is a maintenance release and as such introduces no new APIs or
other changes that might result in application source incompatibility with
v1.10.0.0.
==== Modular Scheduler
The ODP scheduler included as part of the `odp-linux` reference implementation
has been modularized to support a "pluggable" architecture that will permit
the easy introduction of alternate scheduler implementations that permit
both easy experimentation as well as alternate scheduling models that are
tuned to specific application workloads (_i.e.,_ a strict priority scheduler
for latency-sensitive workloads). Included in this release is the just the
foundation and alternate schedulers are expected to be added in future ODP
releases.
=== Packaging
==== Rename of `linux-generic` to `odp-linux`
While the platform name within the ODP git repository remains
`linux-generic`, the package name of this reference implementation has been
changed to `odp-linux` to better reflect that this is an implementation of
ODP that is dependent only on the Linux kernel and is intended to be runnable
on any Linux distribution. All ODP documentation has been changed to reflect
this name change.
=== Helpers
==== Introduction of "agnostic" threading support
The current helper APIs for linux pthreads (`odph_linux_pthread_create()`, etc.)
and processes (`odph_linux_process_fork()`, etc.) have been augmented with a
new "agnostic" set of helper routines for general ODP thread management.
`odph_odpthreads_create()` and `odph_odpthreads_join()` are now the preferred
helpers to use for creating and joining threads that may be implemented as
_either_ pthreads or Linux processes. Although currently ODP threads in
Monarch are assumed to share the same (single) address space, this change is
to permit evolution towards multi-address space (_i.e.,_ process oriented)
threading models without requiring application and/or validation test changes.
The various ODP examples and validation tests that make use of threading have
all been changed to new these new helper APIs.
==== Thread affinity APIs
As part of the new "agnostic" threading support, two additional helper APIs
(`odph_odpthread_getaffinity()` and `odph_odpthread_setaffinity()`) have been
added to permit easy management of thread affinity.
The CUnit framework used by the ODP validation suite has been changed to set
the affinity of the initial thread to the first available control CPU. This
avoids inconsistencies in a number of timing tests.
=== Bug Fixes
As a maintenance release, numerous bugs have been fixed in the `odp-linux`
reference implementation in areas such as platform support (particularly on
32-bit systems), compiler support (clang), C++ compatibility, and other
cleanup items. Highlights include:
==== 32-bit platform support
The `configure` utility now correctly identifies and sets variables needed for
proper compilation on 32-bit x86 systems. In addition the Traffic Manager
now executes properly on 32-bit systems.
==== Timer improvements
The `odp_timer_t` abstract type is now strongly typed for consistency with
other ODP types, and the `odp_timer_to_u64()` and `odp_timer_pool_to_u64()`
APIs are now properly implemented. In addition, an issue with compiling the
timer routines on 32-bit systems using clang was resolved.
==== Scheduler fairness
The default scheduler has been improved to avoid starvation and increase
fairness when running with a limited number of threads or CPUs.
==== 128-bit atomics
The `-mcx16` compiler option is now properly identified and used to support
128-bit atomics on systems that support these operations. This leads to
increased efficiency in the implementation of both timers as well as other
atomic operations.
==== Use of hugepages
In systems that support multiple hugepage sizes, the default hugepage size is
now reported properly by the `odp_sys_huge_page_size()` API.
==== Coverity and Valgrind issue cleanup
Numerous issues identified by the Coverity scan tool have been cleaned up
and resolved, leading to improved robustness in the `odp-linux` reference
implementation. In addition, several memory leaks identified by the valgrind
tool have been fixed.
==== Validation test resource checks
The Traffic Manager validation test has certain sub-tests that require a
minimum of 2 CPUs to operate properly. These tests are now skipped with a
warning when run on uniprocessor systems.
=== Performance
Performance enhancements in the `odp-linux` reference implementation have been
made in packet processing, classification, and pktio, leading to increased
observed throughput and packet handling rates.
=== Examples
A new `l2fwd_simple` example has been added that does simple Layer 2 forwarding.
=== Documentation
==== Switch from AsciiDoc to AsciiDoctor
To get better formatting capabilities and future extensibility the ODP user
documentation system has been switched from http://asciidoc.org[AsciiDoc] to
http://asciidoctor.org[AsciiDoctor]. There are a handful of notable changes as
a result of this. Those submitting documentation patches should be aware of
the following:
* `monospace font` is now indicated by demarking the text with backticks (`)
rather than plus signs (+).
* Callouts are now indicated by C++-style double slash comments (// <1>)
instead of C-style comments (/* <1> */). So, for example writing
-----------------------------------------------
[source,c]
----
...some great code deserving a callout // \<1>
----
<1> This is an example of a callout
-----------------------------------------------
yields:
----
...some great code deserving a callout // <1>
----
<1> This is an example of a callout
Note that this change only affects user documentation. Code documentation
still uses http://doxygen.org[Doxygen].
==== Image Cleanup
The images in the user guide have been trimmed to fit the page better. In
addition, many new images have been added to better illustrate ODP API usage.
==== Additional User Documentation for Monarch APIs
The *ODP User's Guide* has been updated to include new sections documenting
the use of the full Monarch packet APIs as well as the Timer APIs. In
addition, the crypto, classification, and traffic manager API documentation
has been improved to cover all of the latest Monarch features, and an
introductory section on overall ODP packet flow architecture has been added.
==== Helper Documentation
The ODP Helper library now has its own document that describes these additional
functions of use to ODP applications and validation tests.
==== Other documentation
The Process Guide, FAQ, CONTRIBUTING, and CHANGELOG files have been reworked
for the new AsciiDoctor structure, leading to a more uniform method of
presenting ODP support documentation. In addition, an option for generating
both a "pure" ODP API document that defines the APIs in their
implementation-independent forms as well as their implementation-dependent
forms for the `odp-linux` reference implementation is now available.
=== Known Issues
==== https://bugs.linaro.org/show_bug.cgi?id=2301[Bug 2301]
The scheduler does not remove PKTIN queues following `odp_pktio_close()`
==== https://bugs.linaro.org/show_bug.cgi?id=2309[Bug 2309]
The timer validation tests have seen occasional failures when run on systems
containing a larger number of CPUs (typically 24 or more).
== OpenDataPlane (1.10.0.0)
=== New Features
==== General
* Move to capabilite structures: The classification, crypto, pktio, pool,
queue, shared memory, and traffic manager areas all add new APIs to query
implementation-specific capability limits for enhanced program portability.
==== Classification
* Addtion of a structure that defines system level classification capability
* Addition of range PMRs to complement the existing value PMRs to permit
application to specifiy classification rules over a range of values.
==== Cryptography
* Provides a way to get the available cipher and authentication algorithms.
==== Debug
* Adds the ODP_STATIC_ASSERT() API to permit compile-time assertions.
==== Packet
* Rename and add new packet copy and move functionality.
* Add packet prefetch API for performance optimization.
* New APIs to permit packet headroom and tailroom to be extended to additional
segments or truncated as needed.
* Align an area of packet data (e.g. IP/UDP headers) so that it is contiguous in
memory and starts in a specified minimum alignment.
* Add packet time stamp metadata support.
* Add packet input index metadata support to allow application context to
be anchored from the associated interface that received the packet.
* Deprecation and removal of segment-level buffer APIs that are now
superseded by additional packet-level manipulation APIs discussed above.
==== Packet io
* Replaced config definition for maximum pktio entries with maximum packet IO
index call
* Added the classify_enable bit to the odp_pktin_queue_param_t that allows
applications to explicity control which pktin queues are subject to full
classifier support.
* Addition of pktin configuration options to control packet timestamping
and checksum validation processing.
* Addition of pktout configuration options to control packet checksum
offload processing.
* Add the ability to query (via capabilties) whether a pktio interface
supports operating in loopback mode and if so to enable/disable this
mode of operation.
* Round out the polling APIs be adding the ability to receive packets in
poll mode from one or more pktin queues with timeout.
* Add the ability to set the pktio interface index for ease of setting up
application context areas associated with each pktio.
* Add the ability to inqure the timestamp resolution associated with
pktio interfaces that support packet timestamping.
==== Queue
* Add a queue capability API to query system-wide queue capabilities and limits.
* Extend queue context with an explicit data length parameter that serves
as a performance hint for the amount of context to prefetch when the
scheduler selects an event from a scheduled queue.
==== Scheduler
* Add the ability to query information about a defined scheduler group
==== Shared Memory
* Add a capability inquiry API to obtain implementation shared memory limits.
==== Traffic Manager
* Add a capability inquiry API to obtain implementation traffic mngr limits.
* Split TOS marking into two separate calls.
* Add new APIs to support VLAN, ECN, and drop precedence marking.
* Add destroy APIs for shapers, scheduler profiles, threshholds, WRED profiles,
TM queues, and TM nodes for symmetry and completeness to allow applictions
to terminate gracefully without resource leakage.
* Add the ability to disconnect TM queues from their fanouts.
* Add TM node contexts to permit applications to anchor user context areas
to TM nodes.
* Add the ability to query info about TM node fanins and TM queues.
* Deprecate and remove the odp_tm_periodic_update() API
==== Utilities/Helpers
* More complete and correct checksum implementation
=== Known Issues
== OpenDataPlane (1.9.0.0)
=== New Features
* A focus has been made on improving the packaging support of ODP for
distributions such as Debian.
* Improved creation of source tar ball and packaging scenarios moved to
https://git.linaro.org/lng/odp-packaging.git
* Renamed libodp to libodp-linux
* Removed all internal functions from leaking through the libodp-linux
=== Known Issues
Time and Traffic Manager validation tests sometimes fail on heavy loaded
systems. This behaviour depends on time accuracy measurements, which depends
on system load.
////
opendataplane (1.8.0.0)
* API:
- api headers moved to include/odp/api/spec/ and apps should use include/odp_api.h
now instead of odp.h
- api/linux-generic/example: classification: add pmr create api
- api: move include/odp.h to include/odp_api.h
- api: odp.h to ease transition period
- api: packet: add bcast/mcast parse documentation
- api: packet: add detailed packet error flags
- api: packet: added multicast flags
- api: pktio: add pktout event queue
- api: pktio: added pktio info structure
- api: pktio: added supported set operations bit mask to pktio capability
- api: pktio: changed odp_pktio_mtu() return value to uint32_t
- api: pktio: define default pktio modes
- api: pktio: define default queue configuration
- api: pktio: remove old single queue API
- api: pktio: rename pktio_recv_queue to pktin_recv
- api: pktio: rename pktio_send_queue to pktout_send
- api: pktio: specify when queue config is called
- api: queue: remove queue type pktin and pktout
- api: sched: define default sched param values
- api: time: fix typo for cmp function
- api: tm: add tm API definitions
- api: tm: replace pktio with pktout_queue in odp_tm_egress_struct
- doc: users: migrate TM from API to users doc
- drv: creation of the driver interface (drv)
* ODP docs:
- doc: depend the docs on the images
- doc: descr of structure for new interfaces
- doc: drop using output dir for guides
- doc: glossary: defining ODP thread more precisely
- doc: images: add traffic manager svg
- doc: implementers-guide: adding drv interface
- doc: removing invalid characters
- doc: update to latest ax_prog_doxygen.m4
- doc: use imagedir attribute for path
- doc: user-guide documentation for classification
- doc: user-guide: fixing other typos
- doc: user-guide: shmem
- doc: users: add TM example
- doc: users: migrate TM from API to users doc
- documentation: userguide: add images for packet processing
- documentation: userguide: add packet processing description
* Validation
- linux-generic: version: added implementation name string
- performance: crypto: add odp_crypto to .gitignore file
- test: l2fwd: add event queue packet output
- test: l2fwd: add option to give destination MAC
- test: l2fwd: fix test getting stuck in DIRECT_RECV/POLL_QUEUE mode
- test: l2fwd: utilize pktio param defaults
- test: performance: crypto: measure crypto operation performance
- test: pktio_perf: finalize port to use new pktio api
- test: pktio_perf: port to use new pktio api
- validataion: packet: add tests for broadcast and multicast flags
- validation: classification: add test case for odp_cos_drop() function
- validation: classifier: port to use new pktio api
- validation: packet: test if user area is properly set
- validation: pktio: add output event queue tests
- validation: pktio: assign MAC address if one loop pktio is used
- validation: pktio: check if configuring promisc mode is supported before testing
- validation: pktio: fix pktio_test_recv_queue() crash
- validation: pktio: fix type on defining pktiout mode
- validation: pktio: port to use new pktio api
- validation: pktio: replace pktio_test_jumbo() with pktio_test_recv_mtu()
- validation: pktio: set packet mac addresses and checksum in statistics test
- validation: scheduler: increase delay tolerance
- validation: tm: add cunit test for traffic mngr
- validation: tm: fix arm compilation
- validation: tm: miscellaneous cleanup and fixes for tm cunit tests
* General:
- linux-generic: Makefile: fix broken include path
- linux-generic: pktio: initial dpdk pktio implementation
- linux-generic: dpdk: add dpdk_setup_port()
- linux-generic: dpdk: add functions for fetching packet input/output queues
- linux-generic: dpdk: add get/set functions for mtu, promisc mode, and capability
- linux-generic: dpdk: add odp_pktio_input_queues_config()
- linux-generic: dpdk: add odp_pktio_link_status()
- linux-generic: dpdk: add odp_pktio_output_queues_config()
- linux-generic: dpdk: add rx/tx locking
- linux-generic: dpdk: close resources in odp_pktio_close()
- linux-generic: dpdk: handle ixgbe_pmd minimum burst size
- linux-generic: drv: creation of the driver interface (drv)
- linux-generic: fix usage of function strncpy
- linux-generic: loop: avoid packet table overflow
- linux-generic: move CPU info dummy data to generic default file
- linux-generic: netmap: add support for VALE and pipe virtual ports
- linux-generic: netmap: bump up link wait timeout to 10 secs
- linux-generic: netmap: improve single RX queue performance
- linux-generic: netmap: increase maximum descriptor count
- linux-generic: netmap: support 'netmap:' interface name prefix
- linux-generic: packet: implement broadcast and multicast metadata flags
- linux-generic: packet: implement parser extensions for broadcast and multicast
- linux-generic: pktio: add dpdk pktio build support
- linux-generic: pktio: add link_status handler for loop interfaces
- linux-generic: pktio: add separate functions for global and local init
- linux-generic: pktio: allow num queues request on disabled pktio
- linux-generic: pktio: allow recv on stopped interface
- linux-generic: pktio: pktout event queues
- linux-generic: pktio: set pktio capability supported set operations flags
- linux-generic: pktio: simplify callback interface
- linux-generic: pktio: use unique names for pktin event queues
- linux-generic: pool: implement user area init support
- linux-generic: queue: simplify NULL param handling
- linux-generic: return error for unsupported pktio calls
- linux-generic: separate MIPS ODP_CACHE_LINE_SIZE to its arch file
- linux-generic: separate PowerPC ODP_CACHE_LINE_SIZE to its arch file
- linux-generic: separate x86 ODP_CACHE_LINE_SIZE to its arch file
- linux-generic: sysinfo clean up for ARM
- linux-generic: systemcpu(): use input parameter instead of global data
- linux-generic: test: add tm unit test to list of tests to run
- linux-generic: tm: Add missing name table initialization call.
- linux-generic: tm: fix numerous bugs in timer wheel and main tm implementation
- linux-generic: tm: implement traffic manager
- linux-generic: tm: remove not used includes of odp_api.h
- linux-generic: tm: use intermediate casts to avoid strict warnings
- linux-generic: tm: use odp_hash_crc32c() api to avoid arch issues
- linux-generic: use one uniform call systemcpu()
- linux-generic: validation: add netmap test
- linux-generic: version: added implementation name string
* Helper:
- helper: eth: added mac address parse
- helper: ip: added ipv4 address parse
- helper: linux: correct cpumask usage
- helper: linux: remove unnecessary cpumask copy
- helper: remove odp_ definitions
- helper: remove ring code
- helpers: remove odp_ prefix for tests source files
- tests: use parse mac and ip address helpers
opendataplane (1.7.0.0)
* API:
- api: atomic: add non-relaxed 64bit operations
- api: atomic: added 32 bit acquire and release
- api: atomic: added 32bit cas_rel and cas_acq_rel
- api: atomic: added atomic min and max
- api: atomic: added atomic_lock_free_u64
- api: atomic: added cas operations
- api: atomic: added relaxed exchange operation
- api: atomic: init functions are not atomic
- api: atomic: rename release ordering
- api: classifier: align enum type naming
- api: cpu: add new API to get CPU max frequency
- api: cpu: add new API to get per-CPU current frequency
- api: cpu: add new API to get per-CPU max frequency
- api: cpu: add new API to get per-CPU model string
- api: cpu: added pause call
- api: cpu: make frequency API return 0 on failure
- api: cpumask: add new API odp_cpumask_all_available()
- api: cpumask: documented string format
- api: define pktio statistics api
- api: endian: rename endian types with odp_ prefix
- api: errno: any odp function can set errno
- api: init: align enum type naming
- api: init: removed platform_init struct definition
- api: pktio: added direct queue receive
- api: pktio: added direct send to pktio output queue
- api: pktio: added link status
- api: pktio: added multiple pktio input queues
- api: pktio: added multiple pktio output queues
- api: pktio: added pktio capability struct
- api: pktio: refine multiqueue API spec
- api: pktio: remove unused ODP_PKTIO_ANY
- api: pktio: rename pktio modes
- api: pool: allow per-thread caching
- api: queue: define queue type as enum
- api: queue: moved queue type into queue parameters
- api: queue: rename QUEUE_TYPE_POLL to _PLAIN
- api: sched: rename SCHED_SYNC_NONE to _PARALLEL
- api: schedule: clarify scheduler API documentation
- api: stdlib: added odp_memcmp
- api: sysinfo: move CPU Hz API to cpu.h
- api: sysinfo: move CPU model API to cpu.h
- api: thrmask: documented string format
- api: pktio: rename single_user param
- api: pktio: renames for compact type and func names
- api: queue: add enq and deq mode params
* ODP docs:
- doc/users-guide: add time API section
- doc/users-guide: add cryptographic services section
- doc: userguide: add application programming section
- doc: process-guide: add release process
- doc: images: replace overview with editable svg src
- doc: guides: embed icons and images in html
- doc: re-organize doxygen doc for synchronizer
* Validation
- test/performance: pktio: perform an initial warmup run
- test: change l2fwd pool size
- test: l2fwd: added poll queue mode
- test: l2fwd: re-organize functions
- test: l2fwd: use multi-queue API for scheduled queues
- test: l2fwd: use multi-queue pktio in direct mode
- test: l2fwd: use multiple queues in sched mode
- test: perf: l2fwd detect missing odp_generator
- test: update CPU Hz calling functions
- tests: harmonize posix extensions level defines
- validation: atomic: added cas test
- validation: atomic: added lock free op test
- validation: atomic: added max and min tests
- validation: atomic: added non-relaxed test
- validation: atomic: added xchg test
- validation: classification: add additional PMR term
- validation: classification: adds Test case for ODP_PMR_DIP_ADDR
- validation: classification: remove double frees
- validation: cls: adopt for supported l3 PMR
- validation: cls: assign default CoS before creating chain
- validation: cls: use correct MAC addresses
- validation: define ODP_TEST_INACTIVE and ODP_TEST_ACTIVE
- validation: implement pktio statistics counters
- validation: pktio: don't continue if packet with > MTU is sent
- validation: pktio: fix check of pktio_stop() called twice
- validation: pktio: fix typo on setting in_mode
- validation: pktio: reduce stdout noise
- validation: pktio: test batch receive
- validation: pktio: use odp_time_ns() instead own function
- validation: pktio check for number of interfaces
- validation: pktio: add test for odp_pktio_recv_queue() and odp_pktio_send_queue()
- validation: pktio: add test for odp_pktout_queue_config()
- validation: pktio: add test for odp_pktin_queue_config()
- validation: possibility to inactive preconded test
- validation: queue: add test for odp_queue_to_u64()
- validation: remove remaining references synchronizers
- validation: removing synchronizers tests
- validation: scheduler: add timing tests for scheduled queue types
- validation: shmem: sync threads with barrier
- validation: stdlib: add odp_memcmp test
- validation: synchro tests split into 3 groups
- validation: system: add validation for new CPU APIs
- validation: system: add validation tests for odp_cpu_cycles_ calls
- validation: system: fix return code for checks
- validation: system: make odp_cpu_hz optional in validation test
- validation: system: make odp_cpu_hz_id conditional
- validation: test odp_pktio_link_status()
- validation: time: increase limit to check to 2 res
- validation: time: round up resolution
- validation: time: store local and global resolution
- validation: timer: fix delay after loop
- validation: timer: handle early exhaustion of pool
* General:
- linux-generic: add packet_io_stats.h to Makefile.am
- linux-generic: arch: renamed cpu arch files
- linux-generic: atomic: 32bit cas_rel and cas_acq_rel
- linux-generic: atomic: implemented exchange
- linux-generic: atomic: non-relaxed 64bit operations
- linux-generic: barrier: use API memory barrier
- linux-generic: classification: implement verify_pmr_dmac
- linux-generic: cpu: implemented pause
- linux-generic: define posix extension level once
- linux-generic: init: handle local/global init/term cleanly
- linux-generic: locks: replace internal atomics
- linux-generic: netmap: add functions for fetching pktio queues
- linux-generic: netmap: add initial multi queue support
- linux-generic: netmap: add netmap_close_descriptors() function
- linux-generic: netmap: add netmap_link_status() function
- linux-generic: netmap: add odp_pktio_capability()
- linux-generic: netmap: add odp_pktio_link_status()
- linux-generic: netmap: add odp_pktio_start()
- linux-generic: netmap: add scheduler multi-queue support
- linux-generic: netmap: add start()/stop() functionality
- linux-generic: netmap: disable debug prints
- linux-generic: netmap: fix MTU size
- linux-generic: netmap: fix netmap_mtu_get()
- linux-generic: netmap: implement pktio statistics
- linux-generic: netmap: map rings in netmap_start
- linux-generic: netmap: odp_pktio_recv() from all pktin queues
- linux-generic: netmap: use select() instead of poll() in recv
- linux-generic: packet: hide frame_len behind accessor
- linux-generic: packet_io: expose pktio_tbl and is_free()
- linux-generic: packet_io: fix array indexing in pktin_deq_multi()
- linux-generic: packet_io: separate locks for RX/TX
- linux-generic: pcap: implement pktio statistics counters
- linux-generic: pktio loop: implement statistics counters
- linux-generic: pktio: add RSS helper functions
- linux-generic: pktio: added poll type input queue
- linux-generic: pktio: added scheduler multi-queue support
- linux-generic: pktio: dummy multi-queue pktio
- linux-generic: pktio: enable using PKTIO_MAX_QUEUES in pktio implementations
- linux-generic: pktio: implement odp_pktio_link_status()
- linux-generic: pktio: print out the name of pktio used
- linux-generic: pktio: re-organize queue config code
- linux-generic: pktio: remove unwanted initialisation
- linux-generic: pktio: use multiqueue recv internally
- linux-generic: pool: accelerate buffer allocation marking
- linux-generic: pool: catch duplicate free errors in debug builds
- linux-generic: queue: check invalid handle in odp_queue_destroy
- linux-generic: remove direct include of endian.h from byteorder.h
- linux-generic: remove direct include of stdint.h by atomic.h
- linux-generic: remove direct include of stdlib.h by timer.h
- linux-generic: removed spin_internal
- linux-generic: scheduler: improve pktio polling
- linux-generic: sockets: implement pktio statistics
- linux-generic: sysinfo: apply per-CPU implementation to MIPS
- linux-generic: sysinfo: apply per-CPU implementation to PowerPC
- linux-generic: sysinfo: make the cpu_hz per-CPU data
- linux-generic: sysinfo: make the model_str per-CPU data
- linux-generic: sysinfo: move ARM system info codes to default arch file
- linux-generic: sysinfo: move MIPS system info codes to its plarform file
- linux-generic: sysinfo: move PowerPC system info codes to its plarform file
- linux-generic: sysinfo: move cpu_arch_str to odp_system_info_t
- linux-generic: sysinfo: move x86 system info codes to its plarform file
- linux-generic: sysinfo: rename odp_cpu_hz_current with odp_ prefix
- linux-generic: sysinfo: rename variable cpu_hz to cpu_hz_max
- linux-generic: sysinfo: revise odp_cpu_hz() to return current frequency
- linux-generic: sysinfo: set values for cpu_arch_str
- linux-generic: sysinfo: update dummy function to pass validation
- linux-generic: sysinfo: use uniform call odp_sysinfo_parser
- linux-generic: timer use SIGEV_THREAD_ID
- linux-generic: timer: limit notification about resolution incorrectness
- linux-generic: timer use SIGEV_THREAD_ID
- linux-generic: update CPU Hz calling functions
opendataplane (1.6.0.0)
* API:
- api: atomic: clean atomic API documentation
- api: clib: added standard c library api
- api: hash: Added crc32 and crc32c hash functions
- api/linux-generic: classification: rename odp_drop_e to odp_cls_drop_t
- api/validation/linux-generic: classification: implement class of service create api
- api: time: add global time API
- api: time: add resolution and wait API calls
- api: time: make odp_local_time to be monotonic wall time
- api: init: allow implementation to use private ways for its own configuration
- api: classification: add odp_cls_cos_pool_set() api
- api: doc: re-organize doxygen doc for synchronizer
- api: rwlock_recursive: added recursive rwlock
- api: spinlock_recursive: added recursive spinlock
- api: crypto: Add AES128-GCM support
- api: thread: added THREAD_COUNT_MAX define
- api: thrmask: correct specification error
- api: pktio: add odp_pktio_print() API
- api: version: added implementation name str
- api: sync: removed odp_sync_stores
- api: barrier: added memory barriers
* ODP docs:
- doc/users-guide: add time API section
- doc/users-guide: add cryptographic services section
- doc: userguide: add application programming section
- doc: process-guide: add release process
- doc: images: replace overview with editable svg src
- doc: guides: embed icons and images in html
- doc: re-organize doxygen doc for synchronizer
* Validation
- api/validation/linux-generic: classification: implement class of service create api
- api: hash: Added crc32 and crc32c hash functions
- classification: add odp_cls_cos_pool_set() api
- classification: adds additional ASSERTS for stability
- classification: check return value of pktio stop
- classification: start pktio after setting inq and stop it before removing it
- classification: stronger checks to avoid SEGV on pktio failure
- crypto: add test for AES128-GCM
- crypto: allow custom auth/cipher range
- crypto: support validating both cipher and auth at the same time
- performance: pktio_perf: use odp_time_wait_ns() function instead of looping
- performance: sched: use ODP time API instead of clock_gettime
- performance: set a packet rate pass threshold for l2fwd
- pktio : Fix UDP checksum computation
- pktio: ability to wait for external network
- pktio: add customizable out mode for pktios
- pktio: add test for start when started and stop when stopped()
- pktio: add tests for rrecv() on WONLY, and send on RONLY pktios
- pktio: initialize mac addresses for all packets
- pktio: refactor error handling during sequence check
- pktio: remove unneeded stop as interface is stopped after open()
- pktio: stop interfaces before removing the default inq
- pktio: test odp_pktio_print()
- queue: refactor test to avoid coverity issues
- sched: improve scheduler validation test to check sched time correctly
- scheduler: use fail timeout when waiting on events in chaos
- std_clib: added validation tests
- synchronizers: add missing rwlock read lock functional test
- synchronizers: add recursive lock tests
- test/example: use local time API as wall time
- test: performance: pktio: don't use direct arithmetic operations with odp_time_t
- time: add test convertsion on 0
- time: add test for odp_time_local_res() and use resolution
- time: add test for odp_time_wait_ns() and odp_time_wait_until()
- time: don't assign int directly to odp_time_t
- time: test time constants in ns
- time: update to tes global time API
- validation: time: align tests with current time API
* General:
- align with new wall time API
- classification: add null check for pool assigned to CoS
- classification: define pkt_addr as const
- classification: implement class of service create api
- classification: implements odp_cls_cos_pool_set() api
- classification: rename odp_drop_e to odp_cls_drop_t
- clib: added standard c library api
- crypto: Add AES128-GCM support
- fix tap compilation
- hash: Added crc32 and crc32c hash functions
- include netmap headers with -isystem
- odp_time: don't use cpu cycle API to get time
- packet: _odp_parse_common: arm build fix
- pktio: add odp_pktio_print() API
- pktio: add tap pktio type
- pktio: add test for tap pktio
- pktio: check for pktio_start when started and pktio_stop when stopped
- pktio: check interface mode is compatible before receiving or sending
- pktio: configuration functions check that interface is stopped
- queue: fix memory corruption in reorder_enq()
- rwlock_recursive: added recursive rwlock
- schedule: set sched_local.pool correctly
- schedule: use schedule time in ns
- socket: set up __odp_errno on ioctl failures
- spinlock_recursive: added recursive spinlock
- thread: added THREAD_COUNT_MAX define
- thread: removed internal max threads define
- time: add global time API
- time: add resolution and wait API calls
- time: remove posix bleed through on odp_time_t
- timer: include event_types instead of buffer_types
- validation: pktio: report test as skipped when setup fails
- validation: run config tests
opendataplane (1.5.0.0)
* API:
- api: buffer: add functions to alloc/free multiple buffers at once
- api: cpu: change order of arguments for diff function
- api: crypto: add AES128-CBC encrypt/decrypt methods
- api: crypto: add HMAC-SHA-256-128 support
- api: crypto: move enums from platform types to odp and rename to fit the API format
- api: packet: add functions to alloc/free multiple packets at once
- api: queue: add odp_queue_info() function to retrieve queue information
- api: time: change order of arguments for diff function
- api: time: unbind CPU cycles from time API
* ODP docs:
- userguide: add baseline overview to document
- images: add additional user guide images
- implementers-guide: convert to ODP standard layout
- implementers-guide: fix broken doxygen build from tarball
- users-guide: move EXTRA_DIST down to its makefile
- Makefile: add docs to the tarball
- improve asciidoc presentation
- users-guide convert to asciidoc
- images: add resource_management.msc for users-guide
- images: add svg for user-guide
* Validation
- performance: odp_pktio_perf: fix potential overflow in wait loop
- test/example: avoid "cycle" word usage
- ability to specify test install directory
- buffer: add tests for buffer alloc/free multi functions
- crypto: add test for AES128 CBC
- crypto: add test for HMAC-SHA-256-128
- crypto: limit packet size to maximum supported by platform
- packet: add tests for packet alloc/free multi functions
- queue: api validation tests for odp_queue_info()
- remove strict dependency on CUnit 2.1-3
- scheduler: add missing ticketlock unlock
* General:
- rpm packaging support
- linux-generic: config: increase ODP_CONFIG_SCHED_GRPS to 256
- linux-generic: cpumask: warn that CPU0 is used by control and worker thread
- linux-generic: packet: add implementation for packet alloc/free multi
- linux-generic: pool: add buffer_alloc_multi function
- linux-generic: pool: add implementation for buffer alloc/free multi
- linux-generic: queue: add odp_queue_info() function
- linux-generic: validation: add run-test script for post install testing
- platform: move list of API files to Makefile.inc so it is common to all platforms
opendataplane (1.4.1.0)
* Validation
- pktio: test transmit error recovery
- schedule: add chaos test
- check return code from odp_queue_lock_count()
- scheduler: test ordered queue reorder processing
- pktio: initialize queue parameters correctly
- pktio: test for transmit error handling
- pktio: add support for direct receive
- pktio: pass interface index rather than name
- pktio: fix start_stop test
- test: l2fwd: separate rx and tx drop counters
- test: l2fwd: increase burst size
- test: l2fwd: optimize statistics usage
- test: l2fwd: optimize queue mode
- test: l2fwd: start pktios after worker thread create
- test: l2fwd: added option to disable error check
- example/ipsec: Increase ip_data_len for Tunnel mode
- example: ipsec: check push_tail return code
* General:
- linux-generic: pktio: handle transmit errors correctly
- pktio socket_mmap: recover from transmit errors but 1890
- pktio: increase MTU of loop interface
- ordered queues: fix race condition during order release
and out of order.
- configure: move HAVE_PCAP AM_CONDITIONAL to configure.ac
* ODP helper:
- linux: checkpatch cleaning for helper/linux.c
- linux: examine the cause for child process termination
- linux: request SIGTERM if parent process dies
opendataplane (1.4.0.0)
* API:
- ** Classification **
- odp_cos_set_queue() renamed to odp_cos_queue_set()
- int odp_cos_set_drop renamed to odp_cos_drop_set()
- new: odp_queue_t odp_cos_queue(odp_cos_t cos_id)
- new: odp_drop_e odp_cos_drop(odp_cos_t cos_id)
- ODP_PMR_CUSTOM_FRAME support in classification
- odp_pmr_create() arguments passing change to use struct
- odp_pmr_match_set_create() added id argument
- ** Config **
- new: odp_config_...() API introduced instead of ODP_CONFIG_ defines
- ** Cpu, Threads and Scheduler **
- new: uint64_t odp_cpu_cycles(void)
- new: uint64_t odp_cpu_cycles_diff(uint64_t c1, uint64_t c2);
- new: uint64_t odp_cpu_cycles_max(void);
- new: uint64_t odp_cpu_cycles_resolution(void);
- odp_cpumask_def_worker() renamed to odp_cpumask_default_worker()
- odp_cpumask_def_control() renamed to odp_cpumask_default_control()
- odp init extended with num worker and control threads
- new: int odp_queue_lock_count(odp_queue_t queue);
- refine api doc for scheduler and schedule orderd locks
- argument of odp_schedule_order_lock() and odp_schedule_order_unlock changed to unsigned
- new: int odp_thread_count_max(void)
- ** Packet **
- new: uint32_t odp_packet_flow_hash(odp_packet_t pkt)
- new: void odp_packet_flow_hash_set(odp_packet_t pkt, uint32_t flow_hash)
- new: int odp_packet_has_flow_hash(odp_packet_t pkt);
- new: void odp_packet_has_flow_hash_clr(odp_packet_t pkt);
- ** Pktio **
- pktio can be configuread as receive or transmit only
- pktio: refined api doc for start() and stop()
- new: void odp_pktio_param_init(odp_pktio_param_t *param)
* ODP docs:
- implementers-guide: update names of test module libraries
- implementers-guide: update section on skipping tests
* Test framework
- update README files
- renaming module libs
- add odp_cunit_update() to modify registered tests
- add ability to mark tests inactive
* Validation
- ** Classification **
- Add fix for classification tests
- remove redundant pool lookup function
- remove redundant sequence number check
- use tcp data offset field to calculate data offset
- move destroy_inq() to common file
- add odp_pktio_param_init() API
- added additional suite to test individual PMRs
- use a structure instead of many args for odp_pmr_create
- Add init calls for queue parameters
- syntax correction for CU_ASSERT
- Add init calls for pool parameters
- queue and drop policy API name change
- Queue parameter init calls
- ** Cpu, Threads and Scheduler **
- rename odp_cpumask_def to _default
- schedule: revise definition of ordered locks
- schedule: remove odp_schedule_order_lock_init() API
- schedule: don't check schedule time on 0
- synchronizers: support a single worker
- init: fix test when debug-print is disabled
- ** Packet **
- packet: test flow hash
- packet: test now handles pool that do not support segmentation
- ** Pktio **
- pktio: don't call APIs with an invalid pktio handle
- ** Config **
- config: removed ODP_CONFIG_MAX_THREADS
- config: add CUnit tests for config APIs
* Performance
- l2fwd: add missing braces
- l2fwd: add option to disable filling eth addresses
- l2fwd: add support for using odd number of ports
- l2fwd: fix crash when accuracy is set to 0
- l2fwd: add option to select scheduler queue type
- l2fwd: add option to change destination eth addresses
- l2fwd: obey -t in queue mode
- l2fwd: fill correct source ethernet address
- sched: update scheduling test to use cycle counts
- odp_pktio_perf: fix potential overflow for burst_gap
- odp_pktio_perf: fix potential overflow for send_duration
* general:
- classification: implement ODP_PMR_CUSTOM_FRAME matching
- classification: queue and drop policy API name change
- cpu: created arch dependent cpu_cycles files
- cpu: fix cycle lost while cycle counter overflow
- cpu: implementation for cycle count API
- cpu: rename time_cycles to cpu_cycles
- pktio: implemented pcap pktio
- pktio: implemented netmap pktio
- pktio: close all pktio when term is called
- pktio: enable classifier only when needed
- pktio: factor state management into packet_io
- pktio: fill in L2 parse results by default
- pktio: implement odp_pktio_param_init() API
- packet: implement flow hash support
- schedule: fix odp_schdule_wait_time
- queue: change lock_index from uint32_t to unsigned to match API
- queue: direct internal enqueues to target queue
- queue: fix pktout_enqueue() logic
- queue: remove obsolete prototypes
- use cycles_diff for time API also
opendataplane (1.3.0.0)
* API:
- codespell: correct spelling
- event: change to odp_event_type_t
- init: use const pointer types
- packet_io: added odp_pktio_param_t
- packet_io: added start and stop
- packet_io: change word instance to interface
- pktio: added output mode
- pktio: rename pktio_input_mode enum
- pool: add odp_pool_param_init prototype
- pool: standardize description for odp_pool_param_init routine
- queue: add odp_queue_param_init prototype
- queue: clarify odp_queue_context_set() documentation
- queue: rename queue context get/set for consistency
- sched: added ordered context lock
- sched: added release ordered