├── .gitignore
├── COPYING
├── LICENSE
├── Makefile
├── README.md
├── config.h
└── src
├── Makefile
├── array.c
├── array.h
├── log.c
├── log.h
└── main.c
/.gitignore:
--------------------------------------------------------------------------------
1 | # Object files
2 | *.o
3 | *.ko
4 | *.obj
5 | *.elf
6 |
7 | # Precompiled Headers
8 | *.gch
9 | *.pch
10 |
11 | # Libraries
12 | *.lib
13 | *.a
14 | *.la
15 | *.lo
16 |
17 | # Shared objects (inc. Windows DLLs)
18 | *.dll
19 | *.so
20 | *.so.*
21 | *.dylib
22 |
23 | # Executables
24 | *.exe
25 | *.out
26 | *.app
27 | *.i*86
28 | *.x86_64
29 | *.hex
30 |
31 | # Debug files
32 | *.dSYM/
33 | *.su
34 |
--------------------------------------------------------------------------------
/COPYING:
--------------------------------------------------------------------------------
1 | GNU GENERAL PUBLIC LICENSE
2 | Version 3, 29 June 2007
3 |
4 | Copyright (C) 2007 Free Software Foundation, Inc.
5 | Everyone is permitted to copy and distribute verbatim copies
6 | of this license document, but changing it is not allowed.
7 |
8 | Preamble
9 |
10 | The GNU General Public License is a free, copyleft license for
11 | software and other kinds of works.
12 |
13 | The licenses for most software and other practical works are designed
14 | to take away your freedom to share and change the works. By contrast,
15 | the GNU General Public License is intended to guarantee your freedom to
16 | share and change all versions of a program--to make sure it remains free
17 | software for all its users. We, the Free Software Foundation, use the
18 | GNU General Public License for most of our software; it applies also to
19 | any other work released this way by its authors. You can apply it to
20 | your programs, too.
21 |
22 | When we speak of free software, we are referring to freedom, not
23 | price. Our General Public Licenses are designed to make sure that you
24 | have the freedom to distribute copies of free software (and charge for
25 | them if you wish), that you receive source code or can get it if you
26 | want it, that you can change the software or use pieces of it in new
27 | free programs, and that you know you can do these things.
28 |
29 | To protect your rights, we need to prevent others from denying you
30 | these rights or asking you to surrender the rights. Therefore, you have
31 | certain responsibilities if you distribute copies of the software, or if
32 | you modify it: responsibilities to respect the freedom of others.
33 |
34 | For example, if you distribute copies of such a program, whether
35 | gratis or for a fee, you must pass on to the recipients the same
36 | freedoms that you received. You must make sure that they, too, receive
37 | or can get the source code. And you must show them these terms so they
38 | know their rights.
39 |
40 | Developers that use the GNU GPL protect your rights with two steps:
41 | (1) assert copyright on the software, and (2) offer you this License
42 | giving you legal permission to copy, distribute and/or modify it.
43 |
44 | For the developers' and authors' protection, the GPL clearly explains
45 | that there is no warranty for this free software. For both users' and
46 | authors' sake, the GPL requires that modified versions be marked as
47 | changed, so that their problems will not be attributed erroneously to
48 | authors of previous versions.
49 |
50 | Some devices are designed to deny users access to install or run
51 | modified versions of the software inside them, although the manufacturer
52 | can do so. This is fundamentally incompatible with the aim of
53 | protecting users' freedom to change the software. The systematic
54 | pattern of such abuse occurs in the area of products for individuals to
55 | use, which is precisely where it is most unacceptable. Therefore, we
56 | have designed this version of the GPL to prohibit the practice for those
57 | products. If such problems arise substantially in other domains, we
58 | stand ready to extend this provision to those domains in future versions
59 | of the GPL, as needed to protect the freedom of users.
60 |
61 | Finally, every program is threatened constantly by software patents.
62 | States should not allow patents to restrict development and use of
63 | software on general-purpose computers, but in those that do, we wish to
64 | avoid the special danger that patents applied to a free program could
65 | make it effectively proprietary. To prevent this, the GPL assures that
66 | patents cannot be used to render the program non-free.
67 |
68 | The precise terms and conditions for copying, distribution and
69 | modification follow.
70 |
71 | TERMS AND CONDITIONS
72 |
73 | 0. Definitions.
74 |
75 | "This License" refers to version 3 of the GNU General Public License.
76 |
77 | "Copyright" also means copyright-like laws that apply to other kinds of
78 | works, such as semiconductor masks.
79 |
80 | "The Program" refers to any copyrightable work licensed under this
81 | License. Each licensee is addressed as "you". "Licensees" and
82 | "recipients" may be individuals or organizations.
83 |
84 | To "modify" a work means to copy from or adapt all or part of the work
85 | in a fashion requiring copyright permission, other than the making of an
86 | exact copy. The resulting work is called a "modified version" of the
87 | earlier work or a work "based on" the earlier work.
88 |
89 | A "covered work" means either the unmodified Program or a work based
90 | on the Program.
91 |
92 | To "propagate" a work means to do anything with it that, without
93 | permission, would make you directly or secondarily liable for
94 | infringement under applicable copyright law, except executing it on a
95 | computer or modifying a private copy. Propagation includes copying,
96 | distribution (with or without modification), making available to the
97 | public, and in some countries other activities as well.
98 |
99 | To "convey" a work means any kind of propagation that enables other
100 | parties to make or receive copies. Mere interaction with a user through
101 | a computer network, with no transfer of a copy, is not conveying.
102 |
103 | An interactive user interface displays "Appropriate Legal Notices"
104 | to the extent that it includes a convenient and prominently visible
105 | feature that (1) displays an appropriate copyright notice, and (2)
106 | tells the user that there is no warranty for the work (except to the
107 | extent that warranties are provided), that licensees may convey the
108 | work under this License, and how to view a copy of this License. If
109 | the interface presents a list of user commands or options, such as a
110 | menu, a prominent item in the list meets this criterion.
111 |
112 | 1. Source Code.
113 |
114 | The "source code" for a work means the preferred form of the work
115 | for making modifications to it. "Object code" means any non-source
116 | form of a work.
117 |
118 | A "Standard Interface" means an interface that either is an official
119 | standard defined by a recognized standards body, or, in the case of
120 | interfaces specified for a particular programming language, one that
121 | is widely used among developers working in that language.
122 |
123 | The "System Libraries" of an executable work include anything, other
124 | than the work as a whole, that (a) is included in the normal form of
125 | packaging a Major Component, but which is not part of that Major
126 | Component, and (b) serves only to enable use of the work with that
127 | Major Component, or to implement a Standard Interface for which an
128 | implementation is available to the public in source code form. A
129 | "Major Component", in this context, means a major essential component
130 | (kernel, window system, and so on) of the specific operating system
131 | (if any) on which the executable work runs, or a compiler used to
132 | produce the work, or an object code interpreter used to run it.
133 |
134 | The "Corresponding Source" for a work in object code form means all
135 | the source code needed to generate, install, and (for an executable
136 | work) run the object code and to modify the work, including scripts to
137 | control those activities. However, it does not include the work's
138 | System Libraries, or general-purpose tools or generally available free
139 | programs which are used unmodified in performing those activities but
140 | which are not part of the work. For example, Corresponding Source
141 | includes interface definition files associated with source files for
142 | the work, and the source code for shared libraries and dynamically
143 | linked subprograms that the work is specifically designed to require,
144 | such as by intimate data communication or control flow between those
145 | subprograms and other parts of the work.
146 |
147 | The Corresponding Source need not include anything that users
148 | can regenerate automatically from other parts of the Corresponding
149 | Source.
150 |
151 | The Corresponding Source for a work in source code form is that
152 | same work.
153 |
154 | 2. Basic Permissions.
155 |
156 | All rights granted under this License are granted for the term of
157 | copyright on the Program, and are irrevocable provided the stated
158 | conditions are met. This License explicitly affirms your unlimited
159 | permission to run the unmodified Program. The output from running a
160 | covered work is covered by this License only if the output, given its
161 | content, constitutes a covered work. This License acknowledges your
162 | rights of fair use or other equivalent, as provided by copyright law.
163 |
164 | You may make, run and propagate covered works that you do not
165 | convey, without conditions so long as your license otherwise remains
166 | in force. You may convey covered works to others for the sole purpose
167 | of having them make modifications exclusively for you, or provide you
168 | with facilities for running those works, provided that you comply with
169 | the terms of this License in conveying all material for which you do
170 | not control copyright. Those thus making or running the covered works
171 | for you must do so exclusively on your behalf, under your direction
172 | and control, on terms that prohibit them from making any copies of
173 | your copyrighted material outside their relationship with you.
174 |
175 | Conveying under any other circumstances is permitted solely under
176 | the conditions stated below. Sublicensing is not allowed; section 10
177 | makes it unnecessary.
178 |
179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
180 |
181 | No covered work shall be deemed part of an effective technological
182 | measure under any applicable law fulfilling obligations under article
183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
184 | similar laws prohibiting or restricting circumvention of such
185 | measures.
186 |
187 | When you convey a covered work, you waive any legal power to forbid
188 | circumvention of technological measures to the extent such circumvention
189 | is effected by exercising rights under this License with respect to
190 | the covered work, and you disclaim any intention to limit operation or
191 | modification of the work as a means of enforcing, against the work's
192 | users, your or third parties' legal rights to forbid circumvention of
193 | technological measures.
194 |
195 | 4. Conveying Verbatim Copies.
196 |
197 | You may convey verbatim copies of the Program's source code as you
198 | receive it, in any medium, provided that you conspicuously and
199 | appropriately publish on each copy an appropriate copyright notice;
200 | keep intact all notices stating that this License and any
201 | non-permissive terms added in accord with section 7 apply to the code;
202 | keep intact all notices of the absence of any warranty; and give all
203 | recipients a copy of this License along with the Program.
204 |
205 | You may charge any price or no price for each copy that you convey,
206 | and you may offer support or warranty protection for a fee.
207 |
208 | 5. Conveying Modified Source Versions.
209 |
210 | You may convey a work based on the Program, or the modifications to
211 | produce it from the Program, in the form of source code under the
212 | terms of section 4, provided that you also meet all of these conditions:
213 |
214 | a) The work must carry prominent notices stating that you modified
215 | it, and giving a relevant date.
216 |
217 | b) The work must carry prominent notices stating that it is
218 | released under this License and any conditions added under section
219 | 7. This requirement modifies the requirement in section 4 to
220 | "keep intact all notices".
221 |
222 | c) You must license the entire work, as a whole, under this
223 | License to anyone who comes into possession of a copy. This
224 | License will therefore apply, along with any applicable section 7
225 | additional terms, to the whole of the work, and all its parts,
226 | regardless of how they are packaged. This License gives no
227 | permission to license the work in any other way, but it does not
228 | invalidate such permission if you have separately received it.
229 |
230 | d) If the work has interactive user interfaces, each must display
231 | Appropriate Legal Notices; however, if the Program has interactive
232 | interfaces that do not display Appropriate Legal Notices, your
233 | work need not make them do so.
234 |
235 | A compilation of a covered work with other separate and independent
236 | works, which are not by their nature extensions of the covered work,
237 | and which are not combined with it such as to form a larger program,
238 | in or on a volume of a storage or distribution medium, is called an
239 | "aggregate" if the compilation and its resulting copyright are not
240 | used to limit the access or legal rights of the compilation's users
241 | beyond what the individual works permit. Inclusion of a covered work
242 | in an aggregate does not cause this License to apply to the other
243 | parts of the aggregate.
244 |
245 | 6. Conveying Non-Source Forms.
246 |
247 | You may convey a covered work in object code form under the terms
248 | of sections 4 and 5, provided that you also convey the
249 | machine-readable Corresponding Source under the terms of this License,
250 | in one of these ways:
251 |
252 | a) Convey the object code in, or embodied in, a physical product
253 | (including a physical distribution medium), accompanied by the
254 | Corresponding Source fixed on a durable physical medium
255 | customarily used for software interchange.
256 |
257 | b) Convey the object code in, or embodied in, a physical product
258 | (including a physical distribution medium), accompanied by a
259 | written offer, valid for at least three years and valid for as
260 | long as you offer spare parts or customer support for that product
261 | model, to give anyone who possesses the object code either (1) a
262 | copy of the Corresponding Source for all the software in the
263 | product that is covered by this License, on a durable physical
264 | medium customarily used for software interchange, for a price no
265 | more than your reasonable cost of physically performing this
266 | conveying of source, or (2) access to copy the
267 | Corresponding Source from a network server at no charge.
268 |
269 | c) Convey individual copies of the object code with a copy of the
270 | written offer to provide the Corresponding Source. This
271 | alternative is allowed only occasionally and noncommercially, and
272 | only if you received the object code with such an offer, in accord
273 | with subsection 6b.
274 |
275 | d) Convey the object code by offering access from a designated
276 | place (gratis or for a charge), and offer equivalent access to the
277 | Corresponding Source in the same way through the same place at no
278 | further charge. You need not require recipients to copy the
279 | Corresponding Source along with the object code. If the place to
280 | copy the object code is a network server, the Corresponding Source
281 | may be on a different server (operated by you or a third party)
282 | that supports equivalent copying facilities, provided you maintain
283 | clear directions next to the object code saying where to find the
284 | Corresponding Source. Regardless of what server hosts the
285 | Corresponding Source, you remain obligated to ensure that it is
286 | available for as long as needed to satisfy these requirements.
287 |
288 | e) Convey the object code using peer-to-peer transmission, provided
289 | you inform other peers where the object code and Corresponding
290 | Source of the work are being offered to the general public at no
291 | charge under subsection 6d.
292 |
293 | A separable portion of the object code, whose source code is excluded
294 | from the Corresponding Source as a System Library, need not be
295 | included in conveying the object code work.
296 |
297 | A "User Product" is either (1) a "consumer product", which means any
298 | tangible personal property which is normally used for personal, family,
299 | or household purposes, or (2) anything designed or sold for incorporation
300 | into a dwelling. In determining whether a product is a consumer product,
301 | doubtful cases shall be resolved in favor of coverage. For a particular
302 | product received by a particular user, "normally used" refers to a
303 | typical or common use of that class of product, regardless of the status
304 | of the particular user or of the way in which the particular user
305 | actually uses, or expects or is expected to use, the product. A product
306 | is a consumer product regardless of whether the product has substantial
307 | commercial, industrial or non-consumer uses, unless such uses represent
308 | the only significant mode of use of the product.
309 |
310 | "Installation Information" for a User Product means any methods,
311 | procedures, authorization keys, or other information required to install
312 | and execute modified versions of a covered work in that User Product from
313 | a modified version of its Corresponding Source. The information must
314 | suffice to ensure that the continued functioning of the modified object
315 | code is in no case prevented or interfered with solely because
316 | modification has been made.
317 |
318 | If you convey an object code work under this section in, or with, or
319 | specifically for use in, a User Product, and the conveying occurs as
320 | part of a transaction in which the right of possession and use of the
321 | User Product is transferred to the recipient in perpetuity or for a
322 | fixed term (regardless of how the transaction is characterized), the
323 | Corresponding Source conveyed under this section must be accompanied
324 | by the Installation Information. But this requirement does not apply
325 | if neither you nor any third party retains the ability to install
326 | modified object code on the User Product (for example, the work has
327 | been installed in ROM).
328 |
329 | The requirement to provide Installation Information does not include a
330 | requirement to continue to provide support service, warranty, or updates
331 | for a work that has been modified or installed by the recipient, or for
332 | the User Product in which it has been modified or installed. Access to a
333 | network may be denied when the modification itself materially and
334 | adversely affects the operation of the network or violates the rules and
335 | protocols for communication across the network.
336 |
337 | Corresponding Source conveyed, and Installation Information provided,
338 | in accord with this section must be in a format that is publicly
339 | documented (and with an implementation available to the public in
340 | source code form), and must require no special password or key for
341 | unpacking, reading or copying.
342 |
343 | 7. Additional Terms.
344 |
345 | "Additional permissions" are terms that supplement the terms of this
346 | License by making exceptions from one or more of its conditions.
347 | Additional permissions that are applicable to the entire Program shall
348 | be treated as though they were included in this License, to the extent
349 | that they are valid under applicable law. If additional permissions
350 | apply only to part of the Program, that part may be used separately
351 | under those permissions, but the entire Program remains governed by
352 | this License without regard to the additional permissions.
353 |
354 | When you convey a copy of a covered work, you may at your option
355 | remove any additional permissions from that copy, or from any part of
356 | it. (Additional permissions may be written to require their own
357 | removal in certain cases when you modify the work.) You may place
358 | additional permissions on material, added by you to a covered work,
359 | for which you have or can give appropriate copyright permission.
360 |
361 | Notwithstanding any other provision of this License, for material you
362 | add to a covered work, you may (if authorized by the copyright holders of
363 | that material) supplement the terms of this License with terms:
364 |
365 | a) Disclaiming warranty or limiting liability differently from the
366 | terms of sections 15 and 16 of this License; or
367 |
368 | b) Requiring preservation of specified reasonable legal notices or
369 | author attributions in that material or in the Appropriate Legal
370 | Notices displayed by works containing it; or
371 |
372 | c) Prohibiting misrepresentation of the origin of that material, or
373 | requiring that modified versions of such material be marked in
374 | reasonable ways as different from the original version; or
375 |
376 | d) Limiting the use for publicity purposes of names of licensors or
377 | authors of the material; or
378 |
379 | e) Declining to grant rights under trademark law for use of some
380 | trade names, trademarks, or service marks; or
381 |
382 | f) Requiring indemnification of licensors and authors of that
383 | material by anyone who conveys the material (or modified versions of
384 | it) with contractual assumptions of liability to the recipient, for
385 | any liability that these contractual assumptions directly impose on
386 | those licensors and authors.
387 |
388 | All other non-permissive additional terms are considered "further
389 | restrictions" within the meaning of section 10. If the Program as you
390 | received it, or any part of it, contains a notice stating that it is
391 | governed by this License along with a term that is a further
392 | restriction, you may remove that term. If a license document contains
393 | a further restriction but permits relicensing or conveying under this
394 | License, you may add to a covered work material governed by the terms
395 | of that license document, provided that the further restriction does
396 | not survive such relicensing or conveying.
397 |
398 | If you add terms to a covered work in accord with this section, you
399 | must place, in the relevant source files, a statement of the
400 | additional terms that apply to those files, or a notice indicating
401 | where to find the applicable terms.
402 |
403 | Additional terms, permissive or non-permissive, may be stated in the
404 | form of a separately written license, or stated as exceptions;
405 | the above requirements apply either way.
406 |
407 | 8. Termination.
408 |
409 | You may not propagate or modify a covered work except as expressly
410 | provided under this License. Any attempt otherwise to propagate or
411 | modify it is void, and will automatically terminate your rights under
412 | this License (including any patent licenses granted under the third
413 | paragraph of section 11).
414 |
415 | However, if you cease all violation of this License, then your
416 | license from a particular copyright holder is reinstated (a)
417 | provisionally, unless and until the copyright holder explicitly and
418 | finally terminates your license, and (b) permanently, if the copyright
419 | holder fails to notify you of the violation by some reasonable means
420 | prior to 60 days after the cessation.
421 |
422 | Moreover, your license from a particular copyright holder is
423 | reinstated permanently if the copyright holder notifies you of the
424 | violation by some reasonable means, this is the first time you have
425 | received notice of violation of this License (for any work) from that
426 | copyright holder, and you cure the violation prior to 30 days after
427 | your receipt of the notice.
428 |
429 | Termination of your rights under this section does not terminate the
430 | licenses of parties who have received copies or rights from you under
431 | this License. If your rights have been terminated and not permanently
432 | reinstated, you do not qualify to receive new licenses for the same
433 | material under section 10.
434 |
435 | 9. Acceptance Not Required for Having Copies.
436 |
437 | You are not required to accept this License in order to receive or
438 | run a copy of the Program. Ancillary propagation of a covered work
439 | occurring solely as a consequence of using peer-to-peer transmission
440 | to receive a copy likewise does not require acceptance. However,
441 | nothing other than this License grants you permission to propagate or
442 | modify any covered work. These actions infringe copyright if you do
443 | not accept this License. Therefore, by modifying or propagating a
444 | covered work, you indicate your acceptance of this License to do so.
445 |
446 | 10. Automatic Licensing of Downstream Recipients.
447 |
448 | Each time you convey a covered work, the recipient automatically
449 | receives a license from the original licensors, to run, modify and
450 | propagate that work, subject to this License. You are not responsible
451 | for enforcing compliance by third parties with this License.
452 |
453 | An "entity transaction" is a transaction transferring control of an
454 | organization, or substantially all assets of one, or subdividing an
455 | organization, or merging organizations. If propagation of a covered
456 | work results from an entity transaction, each party to that
457 | transaction who receives a copy of the work also receives whatever
458 | licenses to the work the party's predecessor in interest had or could
459 | give under the previous paragraph, plus a right to possession of the
460 | Corresponding Source of the work from the predecessor in interest, if
461 | the predecessor has it or can get it with reasonable efforts.
462 |
463 | You may not impose any further restrictions on the exercise of the
464 | rights granted or affirmed under this License. For example, you may
465 | not impose a license fee, royalty, or other charge for exercise of
466 | rights granted under this License, and you may not initiate litigation
467 | (including a cross-claim or counterclaim in a lawsuit) alleging that
468 | any patent claim is infringed by making, using, selling, offering for
469 | sale, or importing the Program or any portion of it.
470 |
471 | 11. Patents.
472 |
473 | A "contributor" is a copyright holder who authorizes use under this
474 | License of the Program or a work on which the Program is based. The
475 | work thus licensed is called the contributor's "contributor version".
476 |
477 | A contributor's "essential patent claims" are all patent claims
478 | owned or controlled by the contributor, whether already acquired or
479 | hereafter acquired, that would be infringed by some manner, permitted
480 | by this License, of making, using, or selling its contributor version,
481 | but do not include claims that would be infringed only as a
482 | consequence of further modification of the contributor version. For
483 | purposes of this definition, "control" includes the right to grant
484 | patent sublicenses in a manner consistent with the requirements of
485 | this License.
486 |
487 | Each contributor grants you a non-exclusive, worldwide, royalty-free
488 | patent license under the contributor's essential patent claims, to
489 | make, use, sell, offer for sale, import and otherwise run, modify and
490 | propagate the contents of its contributor version.
491 |
492 | In the following three paragraphs, a "patent license" is any express
493 | agreement or commitment, however denominated, not to enforce a patent
494 | (such as an express permission to practice a patent or covenant not to
495 | sue for patent infringement). To "grant" such a patent license to a
496 | party means to make such an agreement or commitment not to enforce a
497 | patent against the party.
498 |
499 | If you convey a covered work, knowingly relying on a patent license,
500 | and the Corresponding Source of the work is not available for anyone
501 | to copy, free of charge and under the terms of this License, through a
502 | publicly available network server or other readily accessible means,
503 | then you must either (1) cause the Corresponding Source to be so
504 | available, or (2) arrange to deprive yourself of the benefit of the
505 | patent license for this particular work, or (3) arrange, in a manner
506 | consistent with the requirements of this License, to extend the patent
507 | license to downstream recipients. "Knowingly relying" means you have
508 | actual knowledge that, but for the patent license, your conveying the
509 | covered work in a country, or your recipient's use of the covered work
510 | in a country, would infringe one or more identifiable patents in that
511 | country that you have reason to believe are valid.
512 |
513 | If, pursuant to or in connection with a single transaction or
514 | arrangement, you convey, or propagate by procuring conveyance of, a
515 | covered work, and grant a patent license to some of the parties
516 | receiving the covered work authorizing them to use, propagate, modify
517 | or convey a specific copy of the covered work, then the patent license
518 | you grant is automatically extended to all recipients of the covered
519 | work and works based on it.
520 |
521 | A patent license is "discriminatory" if it does not include within
522 | the scope of its coverage, prohibits the exercise of, or is
523 | conditioned on the non-exercise of one or more of the rights that are
524 | specifically granted under this License. You may not convey a covered
525 | work if you are a party to an arrangement with a third party that is
526 | in the business of distributing software, under which you make payment
527 | to the third party based on the extent of your activity of conveying
528 | the work, and under which the third party grants, to any of the
529 | parties who would receive the covered work from you, a discriminatory
530 | patent license (a) in connection with copies of the covered work
531 | conveyed by you (or copies made from those copies), or (b) primarily
532 | for and in connection with specific products or compilations that
533 | contain the covered work, unless you entered into that arrangement,
534 | or that patent license was granted, prior to 28 March 2007.
535 |
536 | Nothing in this License shall be construed as excluding or limiting
537 | any implied license or other defenses to infringement that may
538 | otherwise be available to you under applicable patent law.
539 |
540 | 12. No Surrender of Others' Freedom.
541 |
542 | If conditions are imposed on you (whether by court order, agreement or
543 | otherwise) that contradict the conditions of this License, they do not
544 | excuse you from the conditions of this License. If you cannot convey a
545 | covered work so as to satisfy simultaneously your obligations under this
546 | License and any other pertinent obligations, then as a consequence you may
547 | not convey it at all. For example, if you agree to terms that obligate you
548 | to collect a royalty for further conveying from those to whom you convey
549 | the Program, the only way you could satisfy both those terms and this
550 | License would be to refrain entirely from conveying the Program.
551 |
552 | 13. Use with the GNU Affero General Public License.
553 |
554 | Notwithstanding any other provision of this License, you have
555 | permission to link or combine any covered work with a work licensed
556 | under version 3 of the GNU Affero General Public License into a single
557 | combined work, and to convey the resulting work. The terms of this
558 | License will continue to apply to the part which is the covered work,
559 | but the special requirements of the GNU Affero General Public License,
560 | section 13, concerning interaction through a network will apply to the
561 | combination as such.
562 |
563 | 14. Revised Versions of this License.
564 |
565 | The Free Software Foundation may publish revised and/or new versions of
566 | the GNU General Public License from time to time. Such new versions will
567 | be similar in spirit to the present version, but may differ in detail to
568 | address new problems or concerns.
569 |
570 | Each version is given a distinguishing version number. If the
571 | Program specifies that a certain numbered version of the GNU General
572 | Public License "or any later version" applies to it, you have the
573 | option of following the terms and conditions either of that numbered
574 | version or of any later version published by the Free Software
575 | Foundation. If the Program does not specify a version number of the
576 | GNU General Public License, you may choose any version ever published
577 | by the Free Software Foundation.
578 |
579 | If the Program specifies that a proxy can decide which future
580 | versions of the GNU General Public License can be used, that proxy's
581 | public statement of acceptance of a version permanently authorizes you
582 | to choose that version for the Program.
583 |
584 | Later license versions may give you additional or different
585 | permissions. However, no additional obligations are imposed on any
586 | author or copyright holder as a result of your choosing to follow a
587 | later version.
588 |
589 | 15. Disclaimer of Warranty.
590 |
591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
599 |
600 | 16. Limitation of Liability.
601 |
602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
610 | SUCH DAMAGES.
611 |
612 | 17. Interpretation of Sections 15 and 16.
613 |
614 | If the disclaimer of warranty and limitation of liability provided
615 | above cannot be given local legal effect according to their terms,
616 | reviewing courts shall apply local law that most closely approximates
617 | an absolute waiver of all civil liability in connection with the
618 | Program, unless a warranty or assumption of liability accompanies a
619 | copy of the Program in return for a fee.
620 |
621 | END OF TERMS AND CONDITIONS
622 |
623 | How to Apply These Terms to Your New Programs
624 |
625 | If you develop a new program, and you want it to be of the greatest
626 | possible use to the public, the best way to achieve this is to make it
627 | free software which everyone can redistribute and change under these terms.
628 |
629 | To do so, attach the following notices to the program. It is safest
630 | to attach them to the start of each source file to most effectively
631 | state the exclusion of warranty; and each file should have at least
632 | the "copyright" line and a pointer to where the full notice is found.
633 |
634 |
635 | Copyright (C)
636 |
637 | This program is free software: you can redistribute it and/or modify
638 | it under the terms of the GNU General Public License as published by
639 | the Free Software Foundation, either version 3 of the License, or
640 | (at your option) any later version.
641 |
642 | This program is distributed in the hope that it will be useful,
643 | but WITHOUT ANY WARRANTY; without even the implied warranty of
644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
645 | GNU General Public License for more details.
646 |
647 | You should have received a copy of the GNU General Public License
648 | along with this program. If not, see .
649 |
650 | Also add information on how to contact you by electronic and paper mail.
651 |
652 | If the program does terminal interaction, make it output a short
653 | notice like this when it starts in an interactive mode:
654 |
655 | Copyright (C)
656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
657 | This is free software, and you are welcome to redistribute it
658 | under certain conditions; type `show c' for details.
659 |
660 | The hypothetical commands `show w' and `show c' should show the appropriate
661 | parts of the General Public License. Of course, your program's commands
662 | might be different; for a GUI interface, you would use an "about box".
663 |
664 | You should also get your employer (if you work as a programmer) or school,
665 | if any, to sign a "copyright disclaimer" for the program, if necessary.
666 | For more information on this, and how to apply and follow the GNU GPL, see
667 | .
668 |
669 | The GNU General Public License does not permit incorporating your program
670 | into proprietary programs. If your program is a subroutine library, you
671 | may consider it more useful to permit linking proprietary applications with
672 | the library. If this is what you want to do, use the GNU Lesser General
673 | Public License instead of this License. But first, please read
674 | .
675 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | GNU GENERAL PUBLIC LICENSE
2 | Version 3, 29 June 2007
3 |
4 | Copyright (C) 2007 Free Software Foundation, Inc.
5 | Everyone is permitted to copy and distribute verbatim copies
6 | of this license document, but changing it is not allowed.
7 |
8 | Preamble
9 |
10 | The GNU General Public License is a free, copyleft license for
11 | software and other kinds of works.
12 |
13 | The licenses for most software and other practical works are designed
14 | to take away your freedom to share and change the works. By contrast,
15 | the GNU General Public License is intended to guarantee your freedom to
16 | share and change all versions of a program--to make sure it remains free
17 | software for all its users. We, the Free Software Foundation, use the
18 | GNU General Public License for most of our software; it applies also to
19 | any other work released this way by its authors. You can apply it to
20 | your programs, too.
21 |
22 | When we speak of free software, we are referring to freedom, not
23 | price. Our General Public Licenses are designed to make sure that you
24 | have the freedom to distribute copies of free software (and charge for
25 | them if you wish), that you receive source code or can get it if you
26 | want it, that you can change the software or use pieces of it in new
27 | free programs, and that you know you can do these things.
28 |
29 | To protect your rights, we need to prevent others from denying you
30 | these rights or asking you to surrender the rights. Therefore, you have
31 | certain responsibilities if you distribute copies of the software, or if
32 | you modify it: responsibilities to respect the freedom of others.
33 |
34 | For example, if you distribute copies of such a program, whether
35 | gratis or for a fee, you must pass on to the recipients the same
36 | freedoms that you received. You must make sure that they, too, receive
37 | or can get the source code. And you must show them these terms so they
38 | know their rights.
39 |
40 | Developers that use the GNU GPL protect your rights with two steps:
41 | (1) assert copyright on the software, and (2) offer you this License
42 | giving you legal permission to copy, distribute and/or modify it.
43 |
44 | For the developers' and authors' protection, the GPL clearly explains
45 | that there is no warranty for this free software. For both users' and
46 | authors' sake, the GPL requires that modified versions be marked as
47 | changed, so that their problems will not be attributed erroneously to
48 | authors of previous versions.
49 |
50 | Some devices are designed to deny users access to install or run
51 | modified versions of the software inside them, although the manufacturer
52 | can do so. This is fundamentally incompatible with the aim of
53 | protecting users' freedom to change the software. The systematic
54 | pattern of such abuse occurs in the area of products for individuals to
55 | use, which is precisely where it is most unacceptable. Therefore, we
56 | have designed this version of the GPL to prohibit the practice for those
57 | products. If such problems arise substantially in other domains, we
58 | stand ready to extend this provision to those domains in future versions
59 | of the GPL, as needed to protect the freedom of users.
60 |
61 | Finally, every program is threatened constantly by software patents.
62 | States should not allow patents to restrict development and use of
63 | software on general-purpose computers, but in those that do, we wish to
64 | avoid the special danger that patents applied to a free program could
65 | make it effectively proprietary. To prevent this, the GPL assures that
66 | patents cannot be used to render the program non-free.
67 |
68 | The precise terms and conditions for copying, distribution and
69 | modification follow.
70 |
71 | TERMS AND CONDITIONS
72 |
73 | 0. Definitions.
74 |
75 | "This License" refers to version 3 of the GNU General Public License.
76 |
77 | "Copyright" also means copyright-like laws that apply to other kinds of
78 | works, such as semiconductor masks.
79 |
80 | "The Program" refers to any copyrightable work licensed under this
81 | License. Each licensee is addressed as "you". "Licensees" and
82 | "recipients" may be individuals or organizations.
83 |
84 | To "modify" a work means to copy from or adapt all or part of the work
85 | in a fashion requiring copyright permission, other than the making of an
86 | exact copy. The resulting work is called a "modified version" of the
87 | earlier work or a work "based on" the earlier work.
88 |
89 | A "covered work" means either the unmodified Program or a work based
90 | on the Program.
91 |
92 | To "propagate" a work means to do anything with it that, without
93 | permission, would make you directly or secondarily liable for
94 | infringement under applicable copyright law, except executing it on a
95 | computer or modifying a private copy. Propagation includes copying,
96 | distribution (with or without modification), making available to the
97 | public, and in some countries other activities as well.
98 |
99 | To "convey" a work means any kind of propagation that enables other
100 | parties to make or receive copies. Mere interaction with a user through
101 | a computer network, with no transfer of a copy, is not conveying.
102 |
103 | An interactive user interface displays "Appropriate Legal Notices"
104 | to the extent that it includes a convenient and prominently visible
105 | feature that (1) displays an appropriate copyright notice, and (2)
106 | tells the user that there is no warranty for the work (except to the
107 | extent that warranties are provided), that licensees may convey the
108 | work under this License, and how to view a copy of this License. If
109 | the interface presents a list of user commands or options, such as a
110 | menu, a prominent item in the list meets this criterion.
111 |
112 | 1. Source Code.
113 |
114 | The "source code" for a work means the preferred form of the work
115 | for making modifications to it. "Object code" means any non-source
116 | form of a work.
117 |
118 | A "Standard Interface" means an interface that either is an official
119 | standard defined by a recognized standards body, or, in the case of
120 | interfaces specified for a particular programming language, one that
121 | is widely used among developers working in that language.
122 |
123 | The "System Libraries" of an executable work include anything, other
124 | than the work as a whole, that (a) is included in the normal form of
125 | packaging a Major Component, but which is not part of that Major
126 | Component, and (b) serves only to enable use of the work with that
127 | Major Component, or to implement a Standard Interface for which an
128 | implementation is available to the public in source code form. A
129 | "Major Component", in this context, means a major essential component
130 | (kernel, window system, and so on) of the specific operating system
131 | (if any) on which the executable work runs, or a compiler used to
132 | produce the work, or an object code interpreter used to run it.
133 |
134 | The "Corresponding Source" for a work in object code form means all
135 | the source code needed to generate, install, and (for an executable
136 | work) run the object code and to modify the work, including scripts to
137 | control those activities. However, it does not include the work's
138 | System Libraries, or general-purpose tools or generally available free
139 | programs which are used unmodified in performing those activities but
140 | which are not part of the work. For example, Corresponding Source
141 | includes interface definition files associated with source files for
142 | the work, and the source code for shared libraries and dynamically
143 | linked subprograms that the work is specifically designed to require,
144 | such as by intimate data communication or control flow between those
145 | subprograms and other parts of the work.
146 |
147 | The Corresponding Source need not include anything that users
148 | can regenerate automatically from other parts of the Corresponding
149 | Source.
150 |
151 | The Corresponding Source for a work in source code form is that
152 | same work.
153 |
154 | 2. Basic Permissions.
155 |
156 | All rights granted under this License are granted for the term of
157 | copyright on the Program, and are irrevocable provided the stated
158 | conditions are met. This License explicitly affirms your unlimited
159 | permission to run the unmodified Program. The output from running a
160 | covered work is covered by this License only if the output, given its
161 | content, constitutes a covered work. This License acknowledges your
162 | rights of fair use or other equivalent, as provided by copyright law.
163 |
164 | You may make, run and propagate covered works that you do not
165 | convey, without conditions so long as your license otherwise remains
166 | in force. You may convey covered works to others for the sole purpose
167 | of having them make modifications exclusively for you, or provide you
168 | with facilities for running those works, provided that you comply with
169 | the terms of this License in conveying all material for which you do
170 | not control copyright. Those thus making or running the covered works
171 | for you must do so exclusively on your behalf, under your direction
172 | and control, on terms that prohibit them from making any copies of
173 | your copyrighted material outside their relationship with you.
174 |
175 | Conveying under any other circumstances is permitted solely under
176 | the conditions stated below. Sublicensing is not allowed; section 10
177 | makes it unnecessary.
178 |
179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
180 |
181 | No covered work shall be deemed part of an effective technological
182 | measure under any applicable law fulfilling obligations under article
183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
184 | similar laws prohibiting or restricting circumvention of such
185 | measures.
186 |
187 | When you convey a covered work, you waive any legal power to forbid
188 | circumvention of technological measures to the extent such circumvention
189 | is effected by exercising rights under this License with respect to
190 | the covered work, and you disclaim any intention to limit operation or
191 | modification of the work as a means of enforcing, against the work's
192 | users, your or third parties' legal rights to forbid circumvention of
193 | technological measures.
194 |
195 | 4. Conveying Verbatim Copies.
196 |
197 | You may convey verbatim copies of the Program's source code as you
198 | receive it, in any medium, provided that you conspicuously and
199 | appropriately publish on each copy an appropriate copyright notice;
200 | keep intact all notices stating that this License and any
201 | non-permissive terms added in accord with section 7 apply to the code;
202 | keep intact all notices of the absence of any warranty; and give all
203 | recipients a copy of this License along with the Program.
204 |
205 | You may charge any price or no price for each copy that you convey,
206 | and you may offer support or warranty protection for a fee.
207 |
208 | 5. Conveying Modified Source Versions.
209 |
210 | You may convey a work based on the Program, or the modifications to
211 | produce it from the Program, in the form of source code under the
212 | terms of section 4, provided that you also meet all of these conditions:
213 |
214 | a) The work must carry prominent notices stating that you modified
215 | it, and giving a relevant date.
216 |
217 | b) The work must carry prominent notices stating that it is
218 | released under this License and any conditions added under section
219 | 7. This requirement modifies the requirement in section 4 to
220 | "keep intact all notices".
221 |
222 | c) You must license the entire work, as a whole, under this
223 | License to anyone who comes into possession of a copy. This
224 | License will therefore apply, along with any applicable section 7
225 | additional terms, to the whole of the work, and all its parts,
226 | regardless of how they are packaged. This License gives no
227 | permission to license the work in any other way, but it does not
228 | invalidate such permission if you have separately received it.
229 |
230 | d) If the work has interactive user interfaces, each must display
231 | Appropriate Legal Notices; however, if the Program has interactive
232 | interfaces that do not display Appropriate Legal Notices, your
233 | work need not make them do so.
234 |
235 | A compilation of a covered work with other separate and independent
236 | works, which are not by their nature extensions of the covered work,
237 | and which are not combined with it such as to form a larger program,
238 | in or on a volume of a storage or distribution medium, is called an
239 | "aggregate" if the compilation and its resulting copyright are not
240 | used to limit the access or legal rights of the compilation's users
241 | beyond what the individual works permit. Inclusion of a covered work
242 | in an aggregate does not cause this License to apply to the other
243 | parts of the aggregate.
244 |
245 | 6. Conveying Non-Source Forms.
246 |
247 | You may convey a covered work in object code form under the terms
248 | of sections 4 and 5, provided that you also convey the
249 | machine-readable Corresponding Source under the terms of this License,
250 | in one of these ways:
251 |
252 | a) Convey the object code in, or embodied in, a physical product
253 | (including a physical distribution medium), accompanied by the
254 | Corresponding Source fixed on a durable physical medium
255 | customarily used for software interchange.
256 |
257 | b) Convey the object code in, or embodied in, a physical product
258 | (including a physical distribution medium), accompanied by a
259 | written offer, valid for at least three years and valid for as
260 | long as you offer spare parts or customer support for that product
261 | model, to give anyone who possesses the object code either (1) a
262 | copy of the Corresponding Source for all the software in the
263 | product that is covered by this License, on a durable physical
264 | medium customarily used for software interchange, for a price no
265 | more than your reasonable cost of physically performing this
266 | conveying of source, or (2) access to copy the
267 | Corresponding Source from a network server at no charge.
268 |
269 | c) Convey individual copies of the object code with a copy of the
270 | written offer to provide the Corresponding Source. This
271 | alternative is allowed only occasionally and noncommercially, and
272 | only if you received the object code with such an offer, in accord
273 | with subsection 6b.
274 |
275 | d) Convey the object code by offering access from a designated
276 | place (gratis or for a charge), and offer equivalent access to the
277 | Corresponding Source in the same way through the same place at no
278 | further charge. You need not require recipients to copy the
279 | Corresponding Source along with the object code. If the place to
280 | copy the object code is a network server, the Corresponding Source
281 | may be on a different server (operated by you or a third party)
282 | that supports equivalent copying facilities, provided you maintain
283 | clear directions next to the object code saying where to find the
284 | Corresponding Source. Regardless of what server hosts the
285 | Corresponding Source, you remain obligated to ensure that it is
286 | available for as long as needed to satisfy these requirements.
287 |
288 | e) Convey the object code using peer-to-peer transmission, provided
289 | you inform other peers where the object code and Corresponding
290 | Source of the work are being offered to the general public at no
291 | charge under subsection 6d.
292 |
293 | A separable portion of the object code, whose source code is excluded
294 | from the Corresponding Source as a System Library, need not be
295 | included in conveying the object code work.
296 |
297 | A "User Product" is either (1) a "consumer product", which means any
298 | tangible personal property which is normally used for personal, family,
299 | or household purposes, or (2) anything designed or sold for incorporation
300 | into a dwelling. In determining whether a product is a consumer product,
301 | doubtful cases shall be resolved in favor of coverage. For a particular
302 | product received by a particular user, "normally used" refers to a
303 | typical or common use of that class of product, regardless of the status
304 | of the particular user or of the way in which the particular user
305 | actually uses, or expects or is expected to use, the product. A product
306 | is a consumer product regardless of whether the product has substantial
307 | commercial, industrial or non-consumer uses, unless such uses represent
308 | the only significant mode of use of the product.
309 |
310 | "Installation Information" for a User Product means any methods,
311 | procedures, authorization keys, or other information required to install
312 | and execute modified versions of a covered work in that User Product from
313 | a modified version of its Corresponding Source. The information must
314 | suffice to ensure that the continued functioning of the modified object
315 | code is in no case prevented or interfered with solely because
316 | modification has been made.
317 |
318 | If you convey an object code work under this section in, or with, or
319 | specifically for use in, a User Product, and the conveying occurs as
320 | part of a transaction in which the right of possession and use of the
321 | User Product is transferred to the recipient in perpetuity or for a
322 | fixed term (regardless of how the transaction is characterized), the
323 | Corresponding Source conveyed under this section must be accompanied
324 | by the Installation Information. But this requirement does not apply
325 | if neither you nor any third party retains the ability to install
326 | modified object code on the User Product (for example, the work has
327 | been installed in ROM).
328 |
329 | The requirement to provide Installation Information does not include a
330 | requirement to continue to provide support service, warranty, or updates
331 | for a work that has been modified or installed by the recipient, or for
332 | the User Product in which it has been modified or installed. Access to a
333 | network may be denied when the modification itself materially and
334 | adversely affects the operation of the network or violates the rules and
335 | protocols for communication across the network.
336 |
337 | Corresponding Source conveyed, and Installation Information provided,
338 | in accord with this section must be in a format that is publicly
339 | documented (and with an implementation available to the public in
340 | source code form), and must require no special password or key for
341 | unpacking, reading or copying.
342 |
343 | 7. Additional Terms.
344 |
345 | "Additional permissions" are terms that supplement the terms of this
346 | License by making exceptions from one or more of its conditions.
347 | Additional permissions that are applicable to the entire Program shall
348 | be treated as though they were included in this License, to the extent
349 | that they are valid under applicable law. If additional permissions
350 | apply only to part of the Program, that part may be used separately
351 | under those permissions, but the entire Program remains governed by
352 | this License without regard to the additional permissions.
353 |
354 | When you convey a copy of a covered work, you may at your option
355 | remove any additional permissions from that copy, or from any part of
356 | it. (Additional permissions may be written to require their own
357 | removal in certain cases when you modify the work.) You may place
358 | additional permissions on material, added by you to a covered work,
359 | for which you have or can give appropriate copyright permission.
360 |
361 | Notwithstanding any other provision of this License, for material you
362 | add to a covered work, you may (if authorized by the copyright holders of
363 | that material) supplement the terms of this License with terms:
364 |
365 | a) Disclaiming warranty or limiting liability differently from the
366 | terms of sections 15 and 16 of this License; or
367 |
368 | b) Requiring preservation of specified reasonable legal notices or
369 | author attributions in that material or in the Appropriate Legal
370 | Notices displayed by works containing it; or
371 |
372 | c) Prohibiting misrepresentation of the origin of that material, or
373 | requiring that modified versions of such material be marked in
374 | reasonable ways as different from the original version; or
375 |
376 | d) Limiting the use for publicity purposes of names of licensors or
377 | authors of the material; or
378 |
379 | e) Declining to grant rights under trademark law for use of some
380 | trade names, trademarks, or service marks; or
381 |
382 | f) Requiring indemnification of licensors and authors of that
383 | material by anyone who conveys the material (or modified versions of
384 | it) with contractual assumptions of liability to the recipient, for
385 | any liability that these contractual assumptions directly impose on
386 | those licensors and authors.
387 |
388 | All other non-permissive additional terms are considered "further
389 | restrictions" within the meaning of section 10. If the Program as you
390 | received it, or any part of it, contains a notice stating that it is
391 | governed by this License along with a term that is a further
392 | restriction, you may remove that term. If a license document contains
393 | a further restriction but permits relicensing or conveying under this
394 | License, you may add to a covered work material governed by the terms
395 | of that license document, provided that the further restriction does
396 | not survive such relicensing or conveying.
397 |
398 | If you add terms to a covered work in accord with this section, you
399 | must place, in the relevant source files, a statement of the
400 | additional terms that apply to those files, or a notice indicating
401 | where to find the applicable terms.
402 |
403 | Additional terms, permissive or non-permissive, may be stated in the
404 | form of a separately written license, or stated as exceptions;
405 | the above requirements apply either way.
406 |
407 | 8. Termination.
408 |
409 | You may not propagate or modify a covered work except as expressly
410 | provided under this License. Any attempt otherwise to propagate or
411 | modify it is void, and will automatically terminate your rights under
412 | this License (including any patent licenses granted under the third
413 | paragraph of section 11).
414 |
415 | However, if you cease all violation of this License, then your
416 | license from a particular copyright holder is reinstated (a)
417 | provisionally, unless and until the copyright holder explicitly and
418 | finally terminates your license, and (b) permanently, if the copyright
419 | holder fails to notify you of the violation by some reasonable means
420 | prior to 60 days after the cessation.
421 |
422 | Moreover, your license from a particular copyright holder is
423 | reinstated permanently if the copyright holder notifies you of the
424 | violation by some reasonable means, this is the first time you have
425 | received notice of violation of this License (for any work) from that
426 | copyright holder, and you cure the violation prior to 30 days after
427 | your receipt of the notice.
428 |
429 | Termination of your rights under this section does not terminate the
430 | licenses of parties who have received copies or rights from you under
431 | this License. If your rights have been terminated and not permanently
432 | reinstated, you do not qualify to receive new licenses for the same
433 | material under section 10.
434 |
435 | 9. Acceptance Not Required for Having Copies.
436 |
437 | You are not required to accept this License in order to receive or
438 | run a copy of the Program. Ancillary propagation of a covered work
439 | occurring solely as a consequence of using peer-to-peer transmission
440 | to receive a copy likewise does not require acceptance. However,
441 | nothing other than this License grants you permission to propagate or
442 | modify any covered work. These actions infringe copyright if you do
443 | not accept this License. Therefore, by modifying or propagating a
444 | covered work, you indicate your acceptance of this License to do so.
445 |
446 | 10. Automatic Licensing of Downstream Recipients.
447 |
448 | Each time you convey a covered work, the recipient automatically
449 | receives a license from the original licensors, to run, modify and
450 | propagate that work, subject to this License. You are not responsible
451 | for enforcing compliance by third parties with this License.
452 |
453 | An "entity transaction" is a transaction transferring control of an
454 | organization, or substantially all assets of one, or subdividing an
455 | organization, or merging organizations. If propagation of a covered
456 | work results from an entity transaction, each party to that
457 | transaction who receives a copy of the work also receives whatever
458 | licenses to the work the party's predecessor in interest had or could
459 | give under the previous paragraph, plus a right to possession of the
460 | Corresponding Source of the work from the predecessor in interest, if
461 | the predecessor has it or can get it with reasonable efforts.
462 |
463 | You may not impose any further restrictions on the exercise of the
464 | rights granted or affirmed under this License. For example, you may
465 | not impose a license fee, royalty, or other charge for exercise of
466 | rights granted under this License, and you may not initiate litigation
467 | (including a cross-claim or counterclaim in a lawsuit) alleging that
468 | any patent claim is infringed by making, using, selling, offering for
469 | sale, or importing the Program or any portion of it.
470 |
471 | 11. Patents.
472 |
473 | A "contributor" is a copyright holder who authorizes use under this
474 | License of the Program or a work on which the Program is based. The
475 | work thus licensed is called the contributor's "contributor version".
476 |
477 | A contributor's "essential patent claims" are all patent claims
478 | owned or controlled by the contributor, whether already acquired or
479 | hereafter acquired, that would be infringed by some manner, permitted
480 | by this License, of making, using, or selling its contributor version,
481 | but do not include claims that would be infringed only as a
482 | consequence of further modification of the contributor version. For
483 | purposes of this definition, "control" includes the right to grant
484 | patent sublicenses in a manner consistent with the requirements of
485 | this License.
486 |
487 | Each contributor grants you a non-exclusive, worldwide, royalty-free
488 | patent license under the contributor's essential patent claims, to
489 | make, use, sell, offer for sale, import and otherwise run, modify and
490 | propagate the contents of its contributor version.
491 |
492 | In the following three paragraphs, a "patent license" is any express
493 | agreement or commitment, however denominated, not to enforce a patent
494 | (such as an express permission to practice a patent or covenant not to
495 | sue for patent infringement). To "grant" such a patent license to a
496 | party means to make such an agreement or commitment not to enforce a
497 | patent against the party.
498 |
499 | If you convey a covered work, knowingly relying on a patent license,
500 | and the Corresponding Source of the work is not available for anyone
501 | to copy, free of charge and under the terms of this License, through a
502 | publicly available network server or other readily accessible means,
503 | then you must either (1) cause the Corresponding Source to be so
504 | available, or (2) arrange to deprive yourself of the benefit of the
505 | patent license for this particular work, or (3) arrange, in a manner
506 | consistent with the requirements of this License, to extend the patent
507 | license to downstream recipients. "Knowingly relying" means you have
508 | actual knowledge that, but for the patent license, your conveying the
509 | covered work in a country, or your recipient's use of the covered work
510 | in a country, would infringe one or more identifiable patents in that
511 | country that you have reason to believe are valid.
512 |
513 | If, pursuant to or in connection with a single transaction or
514 | arrangement, you convey, or propagate by procuring conveyance of, a
515 | covered work, and grant a patent license to some of the parties
516 | receiving the covered work authorizing them to use, propagate, modify
517 | or convey a specific copy of the covered work, then the patent license
518 | you grant is automatically extended to all recipients of the covered
519 | work and works based on it.
520 |
521 | A patent license is "discriminatory" if it does not include within
522 | the scope of its coverage, prohibits the exercise of, or is
523 | conditioned on the non-exercise of one or more of the rights that are
524 | specifically granted under this License. You may not convey a covered
525 | work if you are a party to an arrangement with a third party that is
526 | in the business of distributing software, under which you make payment
527 | to the third party based on the extent of your activity of conveying
528 | the work, and under which the third party grants, to any of the
529 | parties who would receive the covered work from you, a discriminatory
530 | patent license (a) in connection with copies of the covered work
531 | conveyed by you (or copies made from those copies), or (b) primarily
532 | for and in connection with specific products or compilations that
533 | contain the covered work, unless you entered into that arrangement,
534 | or that patent license was granted, prior to 28 March 2007.
535 |
536 | Nothing in this License shall be construed as excluding or limiting
537 | any implied license or other defenses to infringement that may
538 | otherwise be available to you under applicable patent law.
539 |
540 | 12. No Surrender of Others' Freedom.
541 |
542 | If conditions are imposed on you (whether by court order, agreement or
543 | otherwise) that contradict the conditions of this License, they do not
544 | excuse you from the conditions of this License. If you cannot convey a
545 | covered work so as to satisfy simultaneously your obligations under this
546 | License and any other pertinent obligations, then as a consequence you may
547 | not convey it at all. For example, if you agree to terms that obligate you
548 | to collect a royalty for further conveying from those to whom you convey
549 | the Program, the only way you could satisfy both those terms and this
550 | License would be to refrain entirely from conveying the Program.
551 |
552 | 13. Use with the GNU Affero General Public License.
553 |
554 | Notwithstanding any other provision of this License, you have
555 | permission to link or combine any covered work with a work licensed
556 | under version 3 of the GNU Affero General Public License into a single
557 | combined work, and to convey the resulting work. The terms of this
558 | License will continue to apply to the part which is the covered work,
559 | but the special requirements of the GNU Affero General Public License,
560 | section 13, concerning interaction through a network will apply to the
561 | combination as such.
562 |
563 | 14. Revised Versions of this License.
564 |
565 | The Free Software Foundation may publish revised and/or new versions of
566 | the GNU General Public License from time to time. Such new versions will
567 | be similar in spirit to the present version, but may differ in detail to
568 | address new problems or concerns.
569 |
570 | Each version is given a distinguishing version number. If the
571 | Program specifies that a certain numbered version of the GNU General
572 | Public License "or any later version" applies to it, you have the
573 | option of following the terms and conditions either of that numbered
574 | version or of any later version published by the Free Software
575 | Foundation. If the Program does not specify a version number of the
576 | GNU General Public License, you may choose any version ever published
577 | by the Free Software Foundation.
578 |
579 | If the Program specifies that a proxy can decide which future
580 | versions of the GNU General Public License can be used, that proxy's
581 | public statement of acceptance of a version permanently authorizes you
582 | to choose that version for the Program.
583 |
584 | Later license versions may give you additional or different
585 | permissions. However, no additional obligations are imposed on any
586 | author or copyright holder as a result of your choosing to follow a
587 | later version.
588 |
589 | 15. Disclaimer of Warranty.
590 |
591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
599 |
600 | 16. Limitation of Liability.
601 |
602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
610 | SUCH DAMAGES.
611 |
612 | 17. Interpretation of Sections 15 and 16.
613 |
614 | If the disclaimer of warranty and limitation of liability provided
615 | above cannot be given local legal effect according to their terms,
616 | reviewing courts shall apply local law that most closely approximates
617 | an absolute waiver of all civil liability in connection with the
618 | Program, unless a warranty or assumption of liability accompanies a
619 | copy of the Program in return for a fee.
620 |
621 | END OF TERMS AND CONDITIONS
622 |
623 | How to Apply These Terms to Your New Programs
624 |
625 | If you develop a new program, and you want it to be of the greatest
626 | possible use to the public, the best way to achieve this is to make it
627 | free software which everyone can redistribute and change under these terms.
628 |
629 | To do so, attach the following notices to the program. It is safest
630 | to attach them to the start of each source file to most effectively
631 | state the exclusion of warranty; and each file should have at least
632 | the "copyright" line and a pointer to where the full notice is found.
633 |
634 | {one line to give the program's name and a brief idea of what it does.}
635 | Copyright (C) {year} {name of author}
636 |
637 | This program is free software: you can redistribute it and/or modify
638 | it under the terms of the GNU General Public License as published by
639 | the Free Software Foundation, either version 3 of the License, or
640 | (at your option) any later version.
641 |
642 | This program is distributed in the hope that it will be useful,
643 | but WITHOUT ANY WARRANTY; without even the implied warranty of
644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
645 | GNU General Public License for more details.
646 |
647 | You should have received a copy of the GNU General Public License
648 | along with this program. If not, see .
649 |
650 | Also add information on how to contact you by electronic and paper mail.
651 |
652 | If the program does terminal interaction, make it output a short
653 | notice like this when it starts in an interactive mode:
654 |
655 | {project} Copyright (C) {year} {fullname}
656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
657 | This is free software, and you are welcome to redistribute it
658 | under certain conditions; type `show c' for details.
659 |
660 | The hypothetical commands `show w' and `show c' should show the appropriate
661 | parts of the General Public License. Of course, your program's commands
662 | might be different; for a GUI interface, you would use an "about box".
663 |
664 | You should also get your employer (if you work as a programmer) or school,
665 | if any, to sign a "copyright disclaimer" for the program, if necessary.
666 | For more information on this, and how to apply and follow the GNU GPL, see
667 | .
668 |
669 | The GNU General Public License does not permit incorporating your program
670 | into proprietary programs. If your program is a subroutine library, you
671 | may consider it more useful to permit linking proprietary applications with
672 | the library. If this is what you want to do, use the GNU Lesser General
673 | Public License instead of this License. But first, please read
674 | .
675 |
--------------------------------------------------------------------------------
/Makefile:
--------------------------------------------------------------------------------
1 | DEPS = src
2 | PHONY = $(DEPS) clean mrproper
3 |
4 | all: $(DEPS)
5 | mv src/canny .
6 |
7 | $(DEPS):
8 | $(MAKE) -C $@ $(MAKECMDGOALS)
9 |
10 | clean: $(DEPS)
11 |
12 | mrproper: $(DEPS)
13 | rm -rf canny *~
14 |
15 | .PHONY: $(PHONY)
16 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # canny - A simple CAN-over-IP gateway
2 |
3 | The original purpose of canny was to allow multiple machines to communicate with
4 | a CAN bus without the need for multiple CAN controllers. It was originally meant
5 | for development/evaluation and is **NOT** intended to be used in production
6 | environments.
7 | There are no security precautions taken to authenticate devices connecting from
8 | the IP-network, and messages are blindly forwarded without sanitizing their
9 | contents. It should go without saying that this is not meant to be used in an
10 | actual car or industrial control network.
11 |
12 |
13 | ## Usage
14 |
15 | There are two possible use-cases for canny:
16 |
17 | * To connect IP-based machines to a CAN bus
18 | * To connect two CAN buses over an IP network
19 |
20 | How to use canny in these situations will be described in the following sections.
21 |
22 |
23 | ### IP-to-CAN gateway
24 |
25 | In the first case, canny can be started like this:
26 |
27 | ```
28 | $ canny -p 1234
29 | ```
30 |
31 | This way, canny will listen for incoming TCP connections on port 1234 and forward
32 | messages between *all* connected CAN buses and established TCP connections. However,
33 | messages received on one CAN bus will not be forwarded to another.
34 |
35 |
36 | ### CAN-over-IP tunnel
37 |
38 | To connect two CAN buses over an IP network, start canny on two different machines
39 | like the following example.
40 |
41 | Start a canny server on machine A (let's assume its IP is 10.0.0.1):
42 |
43 | ```
44 | $ canny -p 1234
45 | ```
46 |
47 | Then, start canny as a client on machine B:
48 |
49 | ```
50 | $ canny -c 10.0.0.1 -p 1234
51 | ```
52 |
53 | Now, messages received on any CAN interfaces on machine A will be forwarded to all
54 | CAN interfaces of machine B, and vice-versa. Again, messages will not be forwarded
55 | between different CAN interfaces of the same machine.
56 |
57 |
58 | ### Notes
59 |
60 | You do not have to tell canny what SocketCAN interfaces to use for sending and
61 | receiving messages to and from the connected CAN buses. Upon startup, canny will
62 | iterate over all network interfaces, looking for interfaces containing the string
63 | "can". This way, most common interfaces (e.g. can0, vcan0) will be automatically
64 | detected.
65 |
66 |
67 | ## License
68 |
69 | Canny is free software, distributed under the terms of the GNU GPLv3+. For further
70 | information, see the COPYING file.
71 |
--------------------------------------------------------------------------------
/config.h:
--------------------------------------------------------------------------------
1 | /*
2 | * Canny - A simple CAN-over-IP gateway
3 | * Copyright (C) 2016 Matthias Kruk
4 | *
5 | * Canny is free software; you can redistribute it and/or modify
6 | * it under the terms of the GNU General Public License as published
7 | * by the Free Software Foundation; either version 3, or (at your
8 | * option) any later version.
9 | *
10 | * Canny is distributed in the hope that it will be useful, but
11 | * WITHOUT ANY WARRANTY; without even the implied warranty of
12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 | * General Public License for more details.
14 | *
15 | * You should have received a copy of the GNU General Public License
16 | * along with canny; see the file COPYING. If not, write to the
17 | * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18 | * Boston, MA 02111-1307, USA.
19 | */
20 |
21 |
22 | #ifndef __CANNY_CONFIG_H
23 | #define __CANNY_CONFIG_H
24 |
25 | #define CONFIG_MY_NAME "canny"
26 |
27 | #define CONFIG_INET_PORT 3840
28 | #define CONFIG_INET_BACKLOG 16
29 |
30 | #define CONFIG_EPOLL_INITSIZE 18
31 | #define CONFIG_BUFFER_FRAMES 8
32 |
33 | #endif /* __CANNY_CONFIG_H */
34 |
--------------------------------------------------------------------------------
/src/Makefile:
--------------------------------------------------------------------------------
1 | CFLAGS = -Wall -g -Wextra -Wdouble-promotion -Wmissing-include-dirs -Wswitch-default -Wswitch-enum -c -fPIC -I.. -I.
2 | LDFLAGS = -lpthread
3 | OBJECTS = main.o array.o log.o
4 | OUTNAME = canny
5 |
6 | all: $(OUTNAME)
7 |
8 | $(OUTNAME): $(OBJECTS)
9 | gcc -g -Wall -o $@ $(OBJECTS) $(LDFLAGS)
10 |
11 | clean:
12 | rm -rf $(OBJECTS) $(OUTNAME)
13 |
14 | mrproper:
15 | rm -rf $(OBJECTS) $(OUTNAME) *~
16 |
17 | .PHONY: clean mrproper
18 |
--------------------------------------------------------------------------------
/src/array.c:
--------------------------------------------------------------------------------
1 | /*
2 | * Canny - A simple CAN-over-IP gateway
3 | * Copyright (C) 2016-2023 Matthias Kruk
4 | *
5 | * Canny is free software; you can redistribute it and/or modify
6 | * it under the terms of the GNU General Public License as published
7 | * by the Free Software Foundation; either version 3, or (at your
8 | * option) any later version.
9 | *
10 | * Canny is distributed in the hope that it will be useful, but
11 | * WITHOUT ANY WARRANTY; without even the implied warranty of
12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 | * General Public License for more details.
14 | *
15 | * You should have received a copy of the GNU General Public License
16 | * along with canny; see the file COPYING. If not, write to the
17 | * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18 | * Boston, MA 02111-1307, USA.
19 | */
20 |
21 | #include
22 | #include
23 | #include
24 | #include
25 | #include
26 | #include
27 | #include
28 | #include
29 |
30 | #define ARRAY_INIT_SIZE 16
31 | #define ARRAY_INC_SHIFT 1
32 | #define ARRAY_DEC_SHIFT 1
33 |
34 | static size_t _array_increase(array_t *this)
35 | {
36 | size_t nsize, nsize_raw;
37 | void **ndata;
38 |
39 | assert(this);
40 |
41 | nsize = this->a_size << ARRAY_INC_SHIFT;
42 | nsize_raw = nsize * sizeof(void*);
43 | ndata = malloc(nsize_raw);
44 |
45 | if(ndata) {
46 | memset(ndata, 0, nsize_raw);
47 | memcpy(ndata, this->a_data, this->a_size * sizeof(void*));
48 | free(this->a_data);
49 | this->a_next = this->a_size;
50 | this->a_size = nsize;
51 | this->a_data = ndata;
52 |
53 | return(nsize);
54 | }
55 | return(0);
56 | }
57 |
58 | static size_t _array_decrease(array_t *this)
59 | {
60 | size_t nsize, nsize_raw;
61 | void **ndata;
62 |
63 | assert(this);
64 | assert((this->a_size >> ARRAY_DEC_SHIFT) >= this->a_used);
65 |
66 | nsize = this->a_size >> ARRAY_DEC_SHIFT;
67 | nsize_raw = nsize * sizeof(void*);
68 | ndata = malloc(nsize_raw);
69 |
70 | if(ndata) {
71 | int i, n;
72 |
73 | memset(ndata, 0, nsize_raw);
74 |
75 | for(i = 0, n = 0; i < this->a_size && n < this->a_used; i++) {
76 | if(this->a_data[i] > ARRAY_DIRTY_MARK) {
77 | ndata[n] = this->a_data[i];
78 | n++;
79 | }
80 | }
81 | free(this->a_data);
82 |
83 | this->a_data = ndata;
84 | this->a_size = nsize;
85 | this->a_next = this->a_used;
86 |
87 | return(nsize);
88 | }
89 | return(0);
90 | }
91 |
92 | /**
93 | * Allocate a new array
94 | * @return a pointer to the new array, or NULL in case of an error
95 | */
96 | array_t* array_alloc(void)
97 | {
98 | array_t *a;
99 |
100 | if((a = malloc(sizeof(*a)))) {
101 | memset(a, 0, sizeof(*a));
102 | a->a_used = 0;
103 | a->a_next = 0;
104 | a->a_size = ARRAY_INIT_SIZE;
105 | a->a_data = malloc(ARRAY_INIT_SIZE * sizeof(void*));
106 | assert(pthread_mutex_init(&(a->a_lock), NULL) == 0);
107 |
108 | if(!a->a_data) {
109 | pthread_mutex_destroy(&(a->a_lock));
110 | free(a);
111 | a = NULL;
112 | } else {
113 | memset(a->a_data, 0, ARRAY_INIT_SIZE * sizeof(void*));
114 | }
115 | }
116 | return(a);
117 | }
118 |
119 | /**
120 | * Free the memory occupied by an array
121 | * @param this the array to be freed
122 | * @return void
123 | */
124 | void array_free(array_t *this)
125 | {
126 | assert(this);
127 | assert(pthread_mutex_lock(&(this->a_lock)) == 0);
128 |
129 | /* FIXME: We never unlock it - might cause deadlocks */
130 |
131 | if(this->a_data) {
132 | free(this->a_data);
133 | }
134 | free(this);
135 |
136 | return;
137 | }
138 |
139 | /**
140 | * Return the number of elements in the array
141 | * @param this the array
142 | * @return the number of elements in the array
143 | */
144 | int array_get_length(array_t *this)
145 | {
146 | int len;
147 |
148 | assert(this);
149 |
150 | assert(pthread_mutex_lock(&(this->a_lock)) == 0);
151 | len = this->a_used;
152 | assert(pthread_mutex_unlock(&(this->a_lock)) == 0);
153 |
154 | return(len);
155 | }
156 |
157 | /**
158 | * Insert an element into the array
159 | * @param this the array to insert the element into
160 | * @param ptr the element to be inserted
161 | * @return a non-negative value on success, or a negative value in case of an error
162 | */
163 | int array_insert(array_t *this, const void *ptr)
164 | {
165 | int i;
166 |
167 | assert(this != NULL);
168 | assert(ptr != NULL);
169 | assert(ptr != ARRAY_DIRTY_MARK);
170 |
171 | assert(pthread_mutex_lock(&(this->a_lock)) == 0);
172 |
173 | if(this->a_used == this->a_size) {
174 | assert(_array_increase(this));
175 | }
176 |
177 | i = this->a_next;
178 | do {
179 | if(this->a_data[i] <= ARRAY_DIRTY_MARK) {
180 | this->a_data[i] = (void*)ptr;
181 | this->a_used++;
182 | this->a_next = (i + 1) % this->a_size;
183 | assert(pthread_mutex_unlock(&(this->a_lock)) == 0);
184 | return(i);
185 | }
186 | i = (i + 1) % this->a_size;
187 | } while(i != this->a_next);
188 |
189 | assert(pthread_mutex_unlock(&(this->a_lock)) == 0);
190 | return(-1);
191 | }
192 |
193 | /**
194 | * Remove an element from an array
195 | * @param this the array to remove from
196 | * @param ptr the element to be removed
197 | * @return a non-negative value on success, or a negative value of the element was not found
198 | */
199 | int array_remove(array_t *this, const void *ptr)
200 | {
201 | int i;
202 |
203 | assert(this);
204 | assert(ptr);
205 | assert(ptr != ARRAY_DIRTY_MARK);
206 |
207 | assert(pthread_mutex_lock(&(this->a_lock)) == 0);
208 |
209 | for(i = 0; i < this->a_size; i++) {
210 | if(this->a_data[i] == ptr) {
211 | this->a_data[i] = ARRAY_DIRTY_MARK;
212 | this->a_used--;
213 | this->a_next = i;
214 |
215 | if(this->a_size > ARRAY_INIT_SIZE && (this->a_size >> ARRAY_DEC_SHIFT) > this->a_used) {
216 | _array_decrease(this);
217 | }
218 |
219 | assert(pthread_mutex_unlock(&(this->a_lock)) == 0);
220 | return(i);
221 | }
222 | }
223 | assert(pthread_mutex_unlock(&(this->a_lock)) == 0);
224 | return(-1);
225 | }
226 |
227 | /**
228 | * Call a function for each of the elements of an array
229 | * @param this the array
230 | * @param func the function to call for each element
231 | * @return void
232 | */
233 | void array_foreach(array_t *this, void (*func)(void*))
234 | {
235 | int i, d;
236 |
237 | assert(this);
238 | assert(func);
239 |
240 | assert(pthread_mutex_lock(&(this->a_lock)) == 0);
241 |
242 | for(i = 0, d = 0; i < this->a_size && d < this->a_used; i++) {
243 | if(this->a_data[i] > ARRAY_DIRTY_MARK) {
244 | func(this->a_data[i]);
245 | d++;
246 | }
247 | }
248 |
249 | assert(pthread_mutex_unlock(&(this->a_lock)) == 0);
250 | return;
251 | }
252 |
253 | /**
254 | * Call a function for each of the elements of an array and pass an additional argument
255 | * @param this the array
256 | * @param func the function to call for each element
257 | * @param data the value to pass as the second argument to the function
258 | * @return void
259 | */
260 | void array_foreach2(array_t *this, void (*func)(void*, void*), void *data)
261 | {
262 | int i, d;
263 |
264 | assert(this);
265 | assert(func);
266 |
267 | assert(pthread_mutex_lock(&(this->a_lock)) == 0);
268 |
269 | for(i = 0, d = 0; i < this->a_size && d < this->a_used; i++) {
270 | if(this->a_data[i] > ARRAY_DIRTY_MARK) {
271 | func(this->a_data[i], data);
272 | d++;
273 | }
274 | }
275 |
276 | assert(pthread_mutex_unlock(&(this->a_lock)) == 0);
277 | return;
278 | }
279 |
280 | /**
281 | * Get the nth element of an array
282 | * @param this the array
283 | * @param n the index into the array
284 | * @return a pointer to the nth element in the array, or NULL if n is outside the array bounds
285 | */
286 | void* array_get_nth(array_t *this, int n)
287 | {
288 | int i;
289 | void *ptr;
290 |
291 | assert(this);
292 | assert(n < this->a_used);
293 |
294 | ptr = NULL;
295 |
296 | assert(pthread_mutex_lock(&(this->a_lock)) == 0);
297 |
298 | for(i = 0; i < this->a_size; i++) {
299 | if(this->a_data[i] > ARRAY_DIRTY_MARK) {
300 | if(n--) {
301 | continue;
302 | }
303 | ptr = this->a_data[i];
304 | break;
305 | }
306 | }
307 |
308 | assert(pthread_mutex_unlock(&(this->a_lock)) == 0);
309 | return(ptr);
310 | }
311 |
312 | /**
313 | * Find an element in an array, using a caller-specified comparator
314 | * @param this the array to iterate over
315 | * @param cmp a pointer to the comparator function
316 | * @param arg the second argument to the comparator function
317 | * @return a pointer to the located element, or NULL if no element could be found
318 | */
319 | void* array_find(array_t *this, int (*cmp)(void*, void*), void *arg)
320 | {
321 | int i, d;
322 | void *ptr;
323 |
324 | assert(this);
325 | assert(cmp);
326 | assert(arg);
327 |
328 | assert(pthread_mutex_lock(&(this->a_lock)) == 0);
329 |
330 | for(i = 0, d = 0; i < this->a_size && d < this->a_used; i++) {
331 | ptr = this->a_data[i];
332 |
333 | if(ptr > ARRAY_DIRTY_MARK) {
334 | if(cmp(ptr, arg) == 0) {
335 | assert(pthread_mutex_unlock(&(this->a_lock)) == 0);
336 | return(ptr);
337 | }
338 | d++;
339 | }
340 | }
341 |
342 | assert(pthread_mutex_unlock(&(this->a_lock)) == 0);
343 | return(NULL);
344 | }
345 |
346 | /**
347 | * Duplicate an array
348 | * @param this the array to duplicate
349 | * @return a pointer to the newly created array, or NULL if an error occurred
350 | */
351 | array_t* array_dup(array_t *this)
352 | {
353 | array_t *a;
354 |
355 | assert(this);
356 |
357 | if((a = array_alloc())) {
358 | ARRAY_FOREACH(this, void, elem, {
359 | array_insert(a, elem);
360 | });
361 | }
362 |
363 | return(a);
364 | }
365 |
--------------------------------------------------------------------------------
/src/array.h:
--------------------------------------------------------------------------------
1 | /*
2 | * Canny - A simple CAN-over-IP gateway
3 | * Copyright (C) 2016-2023 Matthias Kruk
4 | *
5 | * Canny is free software; you can redistribute it and/or modify
6 | * it under the terms of the GNU General Public License as published
7 | * by the Free Software Foundation; either version 3, or (at your
8 | * option) any later version.
9 | *
10 | * Canny is distributed in the hope that it will be useful, but
11 | * WITHOUT ANY WARRANTY; without even the implied warranty of
12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 | * General Public License for more details.
14 | *
15 | * You should have received a copy of the GNU General Public License
16 | * along with canny; see the file COPYING. If not, write to the
17 | * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18 | * Boston, MA 02111-1307, USA.
19 | */
20 |
21 | #ifndef __ARRAY_H
22 | #define __ARRAY_H
23 |
24 | #include
25 |
26 | typedef struct array array_t;
27 |
28 | struct array {
29 | int a_size;
30 | int a_used;
31 | int a_next;
32 | void **a_data;
33 |
34 | pthread_mutex_t a_lock;
35 | };
36 |
37 | #define ARRAY_DIRTY_MARK ((void*)0x1)
38 |
39 | #define ARRAY_FOREACH(arr,type,elem,what) if(pthread_mutex_lock(&((arr)->a_lock)) == 0) { \
40 | int __iter_##elem; \
41 | for(__iter_##elem = 0; __iter_##elem < (arr)->a_size; __iter_##elem++) { \
42 | type *elem = (type*)(arr)->a_data[__iter_##elem]; \
43 | if((void*)elem > ARRAY_DIRTY_MARK) \
44 | what \
45 | } \
46 | assert(pthread_mutex_unlock(&((arr)->a_lock)) == 0); \
47 | }
48 |
49 | array_t* array_alloc(void);
50 | void array_free(array_t*);
51 |
52 | int array_insert(array_t*, const void*);
53 | int array_remove(array_t*, const void*);
54 |
55 | void* array_get_nth(array_t*, int);
56 | int array_get_length(array_t*);
57 |
58 | void array_foreach(array_t*, void(*)(void*));
59 | void array_foreach2(array_t*, void(*)(void*, void*), void*);
60 | void* array_find(array_t*, int(*)(void*,void*), void*);
61 | array_t* array_dup(array_t*);
62 |
63 | void array_debug(array_t*);
64 |
65 | #endif /* __ARRAY_H */
66 |
--------------------------------------------------------------------------------
/src/log.c:
--------------------------------------------------------------------------------
1 | /*
2 | * Canny - A simple CAN-over-IP gateway
3 | * Copyright (C) 2016-2023 Matthias Kruk
4 | *
5 | * Canny is free software; you can redistribute it and/or modify
6 | * it under the terms of the GNU General Public License as published
7 | * by the Free Software Foundation; either version 3, or (at your
8 | * option) any later version.
9 | *
10 | * Canny is distributed in the hope that it will be useful, but
11 | * WITHOUT ANY WARRANTY; without even the implied warranty of
12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 | * General Public License for more details.
14 | *
15 | * You should have received a copy of the GNU General Public License
16 | * along with canny; see the file COPYING. If not, write to the
17 | * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18 | * Boston, MA 02111-1307, USA.
19 | */
20 |
21 | #include
22 | #include
23 | #include
24 | #include
25 | #include "log.h"
26 |
27 | static int verbosity = LOG_WARN;
28 |
29 | int log_increase_verbosity(int inc)
30 | {
31 | verbosity += inc;
32 |
33 | if (verbosity > LOG_DEBUG) {
34 | verbosity = LOG_DEBUG;
35 | }
36 | if (verbosity < LOG_ERROR) {
37 | verbosity = LOG_ERROR;
38 | }
39 |
40 | return verbosity;
41 | }
42 |
43 | int make_timestamp(char *dst, size_t dst_size)
44 | {
45 | time_t now;
46 | struct tm curtime;
47 |
48 | now = time(NULL);
49 | if (!localtime_r(&now, &curtime)) {
50 | return -errno;
51 | }
52 |
53 | return strftime(dst, dst_size, "%Y-%m-%d %H:%M:%S%z", &curtime);
54 | }
55 |
56 | void log_write(int level, const char *prefix, const char *fmt, ...)
57 | {
58 | char timestamp[32];
59 | va_list args;
60 |
61 | if (level > verbosity) {
62 | return;
63 | }
64 |
65 | if (make_timestamp(timestamp, sizeof(timestamp)) < 0) {
66 | return;
67 | }
68 |
69 | fprintf(stderr, "%s %s ", timestamp, prefix);
70 | va_start(args, fmt);
71 | vfprintf(stderr, fmt, args);
72 | va_end(args);
73 | }
74 |
--------------------------------------------------------------------------------
/src/log.h:
--------------------------------------------------------------------------------
1 | /*
2 | * Canny - A simple CAN-over-IP gateway
3 | * Copyright (C) 2016-2023 Matthias Kruk
4 | *
5 | * Canny is free software; you can redistribute it and/or modify
6 | * it under the terms of the GNU General Public License as published
7 | * by the Free Software Foundation; either version 3, or (at your
8 | * option) any later version.
9 | *
10 | * Canny is distributed in the hope that it will be useful, but
11 | * WITHOUT ANY WARRANTY; without even the implied warranty of
12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 | * General Public License for more details.
14 | *
15 | * You should have received a copy of the GNU General Public License
16 | * along with canny; see the file COPYING. If not, write to the
17 | * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18 | * Boston, MA 02111-1307, USA.
19 | */
20 |
21 | #ifndef LOG_H
22 | #define LOG_H
23 |
24 | #define LOG_ERROR 0
25 | #define LOG_WARN 1
26 | #define LOG_INFO 2
27 | #define LOG_DEBUG 3
28 |
29 | #define log_info(fmt, ...) log_write(LOG_INFO, "[INF]", fmt, ##__VA_ARGS__)
30 | #define log_warn(fmt, ...) log_write(LOG_WARN, "[WRN]", fmt, ##__VA_ARGS__)
31 | #define log_error(fmt, ...) log_write(LOG_ERROR, "[ERR]", fmt, ##__VA_ARGS__)
32 | #define log_perror(msg) log_error("%s: %s\n", msg, strerror(errno))
33 |
34 | int log_increase_verbosity(int inc);
35 | void log_write(int level, const char *prefix, const char *fmt, ...);
36 |
37 | #endif /* LOG_H */
38 |
--------------------------------------------------------------------------------
/src/main.c:
--------------------------------------------------------------------------------
1 | /*
2 | * Canny - A simple CAN-over-IP gateway
3 | * Copyright (C) 2016-2023 Matthias Kruk
4 | *
5 | * Canny is free software; you can redistribute it and/or modify
6 | * it under the terms of the GNU General Public License as published
7 | * by the Free Software Foundation; either version 3, or (at your
8 | * option) any later version.
9 | *
10 | * Canny is distributed in the hope that it will be useful, but
11 | * WITHOUT ANY WARRANTY; without even the implied warranty of
12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 | * General Public License for more details.
14 | *
15 | * You should have received a copy of the GNU General Public License
16 | * along with canny; see the file COPYING. If not, write to the
17 | * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18 | * Boston, MA 02111-1307, USA.
19 | */
20 |
21 | #include
22 | #include
23 | #include
24 | #include
25 | #include
26 | #include
27 | #include
28 | #include
29 | #include
30 | #include
31 | #include
32 | #include
33 | #include
34 | #include
35 | #include
36 | #include
37 | #include
38 | #include
39 | #include
40 | #include "log.h"
41 |
42 | #define FLAG_DAEMON 1
43 | #define FLAG_LISTEN 2
44 |
45 | #define SHORTOPTS "dc:p:hvq"
46 |
47 | static const struct option cmd_opts[] = {
48 | { "dont-fork", no_argument, 0, 'd' },
49 | { "connect", required_argument, 0, 'c' },
50 | { "port", required_argument, 0, 'p' },
51 | { "help", no_argument, 0, 'h' },
52 | { "verbose", no_argument, 0, 'v' },
53 | { "quiet", no_argument, 0, 'q' },
54 | { 0, 0, 0, 0 }
55 | };
56 |
57 | #define CANNY_MSG_VER 1
58 | #define CANNY_MSG_TYPE_20B CAN_TYPE_20B
59 | #define CANNY_MSG_TYPE_FD CAN_TYPE_FD
60 |
61 | struct canny_message {
62 | uint8_t ver;
63 | uint8_t type;
64 | uint16_t len;
65 |
66 | union {
67 | struct can_frame can;
68 | struct canfd_frame canfd;
69 | } payload;
70 | } __attribute__((packed));
71 |
72 | struct connection {
73 | int fd;
74 | struct sockaddr *addr;
75 | socklen_t addr_size;
76 |
77 | void (*input_event)(struct connection*);
78 | void (*close_event)(struct connection*);
79 | };
80 |
81 | struct in6_connection {
82 | struct connection conn;
83 | struct sockaddr_in6 addr;
84 |
85 | union {
86 | struct canny_message msg[CONFIG_BUFFER_FRAMES];
87 | unsigned char raw[CONFIG_BUFFER_FRAMES * sizeof(struct canny_message)];
88 | } __attribute__((packed)) data;
89 | size_t dlen;
90 | };
91 |
92 | struct in6_server {
93 | struct connection conn;
94 | struct sockaddr_in6 addr;
95 | };
96 |
97 | typedef enum {
98 | CAN_TYPE_20B = 1,
99 | CAN_TYPE_FD
100 | } can_type_t;
101 |
102 | struct can_iface {
103 | struct connection conn;
104 | struct sockaddr_can addr;
105 | char name[32];
106 | can_type_t type;
107 | int mtu;
108 | };
109 |
110 | static array_t *conns;
111 | static array_t *ifaces;
112 | static int run;
113 | static int epfd;
114 |
115 | static void can_input_event(struct can_iface *iface);
116 | static void in6_client_input_event(struct in6_connection *client);
117 | static void in6_client_close_event(struct in6_connection *client);
118 | static void in6_server_input_event(struct in6_server *server);
119 |
120 | static int in6connect(const char *host, unsigned short port)
121 | {
122 | struct addrinfo hints, *res, *p;
123 | char portstr[6];
124 | int ret_val, err;
125 |
126 | ret_val = -EHOSTUNREACH;
127 | memset(&hints, 0, sizeof(hints));
128 | hints.ai_family = AF_UNSPEC;
129 | hints.ai_socktype = SOCK_STREAM;
130 | snprintf(portstr, sizeof(portstr), "%hu", port);
131 |
132 | if((err = getaddrinfo(host, portstr, &hints, &res)) != 0) {
133 | log_error("getaddrinfo: %s\n", gai_strerror(err));
134 | ret_val = -ENOENT;
135 | } else {
136 | for(p = res; p; p = p->ai_next) {
137 | int fd;
138 |
139 | if((fd = socket(p->ai_family, p->ai_socktype, p->ai_protocol)) < 0) {
140 | ret_val = -errno;
141 | log_perror("socket");
142 | continue;
143 | }
144 |
145 | if((err = connect(fd, p->ai_addr, p->ai_addrlen)) < 0) {
146 | ret_val = -errno;
147 | log_perror("connect");
148 | close(fd);
149 | } else {
150 | ret_val = fd;
151 | break;
152 | }
153 | }
154 |
155 | freeaddrinfo(res);
156 | }
157 |
158 | return(ret_val);
159 | }
160 |
161 | static int in6listen(unsigned short port)
162 | {
163 | struct sockaddr_in6 addr;
164 | int err;
165 | int fd;
166 |
167 | if((fd = socket(PF_INET6, SOCK_STREAM, 0)) < 0) {
168 | err = errno;
169 | log_perror("socket");
170 | return(-err);
171 | }
172 |
173 | memset(&addr, 0, sizeof(addr));
174 | addr.sin6_family = AF_INET6;
175 | addr.sin6_port = htons(port);
176 | addr.sin6_addr = in6addr_any;
177 | err = 1;
178 |
179 | if(setsockopt(fd, SOL_SOCKET, SO_REUSEADDR, &err, sizeof(err)) < 0) {
180 | log_perror("setsockopt");
181 | }
182 |
183 | if(bind(fd, (struct sockaddr*)&addr, sizeof(addr)) < 0) {
184 | err = errno;
185 | log_perror("bind");
186 | close(fd);
187 | return(-err);
188 | }
189 |
190 | if(listen(fd, CONFIG_INET_BACKLOG) < 0) {
191 | err = errno;
192 | log_perror("listen");
193 | close(fd);
194 | return(-err);
195 | }
196 |
197 | return(fd);
198 | }
199 |
200 | static struct in6_server* in6_server(unsigned short port)
201 | {
202 | struct in6_server *server;
203 | int fd;
204 |
205 | if((fd = in6listen(port)) < 0) {
206 | return NULL;
207 | }
208 |
209 | if (!(server = calloc(1, sizeof(*server)))) {
210 | close(fd);
211 | } else {
212 | /*
213 | * We don't need the address structure, so we don't really
214 | * bother that in6listen() does not use the one in the
215 | * in6_server we're allocating here. This will need to be
216 | * changed in case we ever need the address.
217 | */
218 | server->conn.fd = fd;
219 | server->conn.addr = (struct sockaddr*)&server->addr;
220 | server->conn.addr_size = sizeof(server->addr);
221 | server->conn.input_event = (void(*)(struct connection*))in6_server_input_event;
222 | }
223 |
224 | return server;
225 | }
226 |
227 | static struct in6_connection* in6_client(const char *hostname, unsigned short port)
228 | {
229 | struct in6_connection *conn;
230 | int fd;
231 |
232 | if ((fd = in6connect(hostname, port) < 0)) {
233 | log_error("Unable to connect to %s:%d\n", hostname, port & 0xffff);
234 | return NULL;
235 | }
236 |
237 | if (!(conn = calloc(1, sizeof(*conn)))) {
238 | close(fd);
239 | } else {
240 | conn->conn.fd = fd;
241 | conn->conn.addr = (struct sockaddr*)&conn->addr;
242 | conn->conn.addr_size = sizeof(conn->addr);
243 | conn->conn.input_event = (void(*)(struct connection*))in6_client_input_event;
244 | conn->conn.close_event = (void(*)(struct connection*))in6_client_close_event;
245 | }
246 |
247 | return conn;
248 | }
249 |
250 | static int cansock(int ifindex)
251 | {
252 | struct sockaddr_can addr;
253 | int result;
254 | int fd;
255 |
256 | memset(&addr, 0, sizeof(addr));
257 | addr.can_family = AF_CAN;
258 | addr.can_ifindex = ifindex;
259 |
260 | if ((fd = socket(PF_CAN, SOCK_RAW, CAN_RAW)) < 0) {
261 | result = -errno;
262 | log_perror("socket");
263 | } else if(bind(fd, (struct sockaddr*)&addr, sizeof(addr)) < 0) {
264 | result = -errno;
265 | log_perror("bind");
266 | close(fd);
267 | } else {
268 | result = fd;
269 | }
270 |
271 | return result;
272 | }
273 |
274 | static int watch_fd(int fd, void *data)
275 | {
276 | struct epoll_event ev;
277 | int err;
278 |
279 | memset(&ev, 0, sizeof(ev));
280 | ev.data.ptr = data;
281 | ev.events = EPOLLIN;
282 | err = 0;
283 |
284 | if (epoll_ctl(epfd, EPOLL_CTL_ADD, fd, &ev) < 0) {
285 | log_perror("epoll_ctl");
286 | err = 1;
287 | }
288 |
289 | return err;
290 | }
291 |
292 | static int get_iface_mtu(const char *ifname)
293 | {
294 | struct ifreq ifr;
295 | int ret_val;
296 | int fd;
297 |
298 | if ((fd = socket(PF_CAN, SOCK_RAW, CAN_RAW)) < 0) {
299 | ret_val = -errno;
300 | log_perror("socket");
301 | } else {
302 | memset(&ifr, 0, sizeof(ifr));
303 | snprintf(ifr.ifr_name, sizeof(ifr.ifr_name), "%s", ifname);
304 |
305 | if (ioctl(fd, SIOCGIFMTU, &ifr) < 0) {
306 | ret_val = -errno;
307 | log_perror("ioctl");
308 | } else {
309 | ret_val = ifr.ifr_mtu;
310 | }
311 |
312 | close(fd);
313 | }
314 |
315 | return ret_val;
316 | }
317 |
318 | static int enable_canfd(int sock)
319 | {
320 | int err;
321 | int value;
322 |
323 | value = 1;
324 | err = setsockopt(sock, SOL_CAN_RAW, CAN_RAW_FD_FRAMES,
325 | &value, sizeof(value));
326 |
327 | if (err < 0) {
328 | err = -errno;
329 | log_perror("setsockopt");
330 | }
331 |
332 | return err;
333 | }
334 |
335 | static struct can_iface* can_open(const char *ifname, int ifindex)
336 | {
337 | struct can_iface *iface;
338 | int fd;
339 |
340 | if ((fd = cansock(ifindex)) < 0) {
341 | return NULL;
342 | }
343 |
344 | if (!(iface = calloc(1, sizeof(*iface)))) {
345 | close(fd);
346 | } else {
347 | iface->conn.fd = fd;
348 | iface->conn.addr = (struct sockaddr*)&iface->addr;
349 | iface->conn.addr_size = sizeof(iface->addr);
350 | iface->conn.input_event = (void(*)(struct connection*))can_input_event;
351 | iface->addr.can_family = AF_CAN;
352 | iface->addr.can_ifindex = ifindex;
353 | snprintf(iface->name, sizeof(iface->name), "%s", ifname);
354 |
355 | if ((iface->mtu = get_iface_mtu(iface->name)) < 0) {
356 | log_warn("Could not determine MTU of %s. Assuming %d.\n", iface->name, CAN_MTU);
357 | iface->mtu = CAN_MTU;
358 | }
359 |
360 | switch (iface->mtu) {
361 | default:
362 | log_warn("MTU of %s is neither %d nor %d. Assuming CAN2.0B.\n",
363 | iface->name, CAN_MTU, CANFD_MTU);
364 | /* fall-through */
365 | case CAN_MTU:
366 | iface->type = CAN_TYPE_20B;
367 | break;
368 |
369 | case CANFD_MTU:
370 | iface->type = CAN_TYPE_FD;
371 |
372 | if (enable_canfd(fd) < 0) {
373 | log_error("Could not enable CANFD mode on %s. Falling back to CAN2.0B.\n",
374 | iface->name);
375 | iface->type = CAN_TYPE_20B;
376 | }
377 |
378 | break;
379 | }
380 | }
381 |
382 | return iface;
383 | }
384 |
385 | static void can_free(struct can_iface *iface)
386 | {
387 | close(iface->conn.fd);
388 | free(iface);
389 | }
390 |
391 | static int can_init(void)
392 | {
393 | struct ifreq ifr;
394 | int fd;
395 | int err;
396 |
397 | if((fd = socket(PF_CAN, SOCK_RAW, CAN_RAW)) < 0) {
398 | err = -errno;
399 | log_perror("socket");
400 | return err;
401 | }
402 |
403 | memset(&ifr, 0, sizeof(ifr));
404 | ifr.ifr_ifindex = 1;
405 |
406 | while ((err = ioctl(fd, SIOCGIFNAME, &ifr)) >= 0) {
407 | if (strstr(ifr.ifr_name, "can") != NULL) {
408 | struct can_iface *iface;
409 |
410 | log_info("Found CAN interface: %s\n", ifr.ifr_name);
411 |
412 | if (!(iface = can_open(ifr.ifr_name, ifr.ifr_ifindex))) {
413 | log_warn("Could not open interface %s\n", ifr.ifr_name);
414 |
415 | } else if (watch_fd(iface->conn.fd, iface) < 0) {
416 | log_error("Could not add interface %s (fd %d) to epoll set\n",
417 | ifr.ifr_name, iface->conn.fd);
418 | can_free(iface);
419 |
420 | } else if (array_insert(ifaces, iface) < 0) {
421 | log_warn("Could not add %s to interface list\n", ifr.ifr_name);
422 | can_free(iface);
423 |
424 | } else {
425 | log_info("Listening for messages on %s (fd %d)\n",
426 | ifr.ifr_name, iface->conn.fd);
427 | }
428 | }
429 |
430 | ifr.ifr_ifindex++;
431 | }
432 |
433 | close(fd);
434 | return 0;
435 | }
436 |
437 | static void in6_server_free(struct in6_server *server)
438 | {
439 | close(server->conn.fd);
440 | free(server);
441 | }
442 |
443 | static void in6_connection_free(struct in6_connection *conn)
444 | {
445 | close(conn->conn.fd);
446 | free(conn);
447 | }
448 |
449 | static int server_init(unsigned short port)
450 | {
451 | struct in6_server *server;
452 |
453 | if (!(server = in6_server(port & 0xffff))) {
454 | log_error("Could not listen on port %hu\n", port);
455 | return 1;
456 |
457 | } else if (watch_fd(server->conn.fd, server) < 0) {
458 | log_error("Could not add server (fd %d) to epoll set\n", server->conn.fd);
459 | in6_server_free(server);
460 |
461 | } else {
462 | log_info("Waiting for clients on port %hu (fd %d)\n", port, server->conn.fd);
463 | }
464 |
465 | return 0;
466 | }
467 |
468 | static int client_init(const char *hostname, unsigned short port)
469 | {
470 | struct in6_connection *client;
471 |
472 | if (!(client = in6_client(hostname, port))) {
473 | log_error("Could not connect to %s:%hu\n", hostname, port);
474 | return 1;
475 |
476 | } else if (watch_fd(client->conn.fd, client) < 0) {
477 | log_error("Could not add client (fd %d) to epoll set\n", client->conn.fd);
478 | in6_connection_free(client);
479 | return 1;
480 |
481 | } else if (array_insert(conns, client) < 0) {
482 | log_error("Could not add client to connection array\n");
483 | in6_connection_free(client);
484 | return 1;
485 |
486 | } else {
487 | log_info("Connected to %s:%hu (fd %d)\n", hostname, port, client->conn.fd);
488 | }
489 |
490 | return 0;
491 | }
492 |
493 | static void broadcast_msg_to_can(struct canny_message *msg)
494 | {
495 | size_t len;
496 |
497 | len = msg->type == CANNY_MSG_TYPE_20B ? CAN_MTU : CANFD_MTU;
498 |
499 | ARRAY_FOREACH(ifaces, struct connection, con, {
500 | if (msg->type == CANNY_MSG_TYPE_FD &&
501 | ((struct can_iface*)con)->type != CAN_TYPE_FD) {
502 | /* don't forward FD frames on non-FD interfaces */
503 | continue;
504 | }
505 |
506 | if(sendto(con->fd, &msg->payload, len, 0, con->addr, con->addr_size) < 0) {
507 | log_perror("sendto");
508 | }
509 | });
510 |
511 | return;
512 | }
513 |
514 | static int frame_to_message(struct canny_message *msg, struct canfd_frame *frame, size_t framesize)
515 | {
516 | int err;
517 |
518 | memset(msg, 0, sizeof(*msg));
519 | msg->ver = CANNY_MSG_VER;
520 | msg->len = framesize;
521 | err = 0;
522 |
523 | switch (framesize) {
524 | case CANFD_MTU:
525 | memcpy(&msg->payload.canfd, frame, CANFD_MTU);
526 | msg->type = CANNY_MSG_TYPE_FD;
527 | break;
528 |
529 | case CAN_MTU:
530 | memcpy(&msg->payload.can, frame, CAN_MTU);
531 | msg->type = CANNY_MSG_TYPE_20B;
532 | break;
533 |
534 | default:
535 | err = -EINVAL;
536 | break;
537 | }
538 |
539 | return err;
540 | }
541 |
542 | static void broadcast_frame_to_net(struct canfd_frame *frm, size_t len)
543 | {
544 | struct canny_message msg;
545 |
546 | if (frame_to_message(&msg, frm, len) < 0) {
547 | log_error("Invalid frame length: %llu\n", len);
548 | return;
549 | }
550 |
551 | ARRAY_FOREACH(conns, struct connection, con, {
552 | if(send(con->fd, &msg, sizeof(msg), 0) < 0) {
553 | log_perror("send");
554 | }
555 | });
556 |
557 | return;
558 | }
559 |
560 | static void broadcast_msg_to_net(struct canny_message *msg, struct connection *src)
561 | {
562 | ARRAY_FOREACH(conns, struct connection, con, {
563 | if(con->fd == src->fd) {
564 | continue;
565 | }
566 |
567 | if(send(con->fd, msg, sizeof(*msg), 0) < 0) {
568 | log_perror("send");
569 | }
570 | });
571 |
572 | return;
573 | }
574 |
575 | static void can_input_event(struct can_iface *iface)
576 | {
577 | struct canfd_frame frm;
578 | int flen;
579 |
580 | if((flen = read(iface->conn.fd, &frm, sizeof(frm))) < 0) {
581 | log_perror("read");
582 | } else if (flen == CAN_MTU || flen == CANFD_MTU) {
583 | broadcast_frame_to_net(&frm, (size_t)flen);
584 | } else {
585 | log_error("Received %d bytes message on %s. Expected %d or %d bytes.\n",
586 | flen, iface->name, CAN_MTU, CANFD_MTU);
587 | }
588 | }
589 |
590 | static void in6_client_input_event(struct in6_connection *client)
591 | {
592 | size_t rsize;
593 | int len;
594 |
595 | rsize = sizeof(client->data) - client->dlen;
596 | len = 1;
597 |
598 | if(rsize > 0) {
599 | len = recv(client->conn.fd, client->data.raw + client->dlen, rsize, 0);
600 |
601 | if(len > 0) {
602 | client->dlen += len;
603 | }
604 | }
605 |
606 | /* broadcast buffered frames */
607 | if(client->dlen >= sizeof(struct canny_message)) {
608 | size_t new_dlen;
609 | int idx;
610 |
611 | idx = 0;
612 | new_dlen = client->dlen;
613 |
614 | /* send out the frames that were fully buffered */
615 |
616 | while(idx < CONFIG_BUFFER_FRAMES && new_dlen >= sizeof(struct canny_message)) {
617 | broadcast_msg_to_can(&(client->data.msg[idx]));
618 | broadcast_msg_to_net(&(client->data.msg[idx]), (struct connection*)client);
619 | idx++;
620 | new_dlen -= sizeof(struct canny_message);
621 | }
622 |
623 | /* if we have a partial frame, move it to the front of the buffer */
624 | if(new_dlen > 0) {
625 | memcpy(client->data.raw, client->data.raw + (client->dlen - new_dlen), new_dlen);
626 | }
627 |
628 | client->dlen = new_dlen;
629 | }
630 |
631 | if(len <= 0) {
632 | /* error (-1) or connection closed (0) */
633 | if (client->conn.close_event) {
634 | client->conn.close_event((struct connection*)client);
635 | }
636 |
637 | array_remove(conns, client);
638 | in6_connection_free(client);
639 | }
640 | }
641 |
642 | static void in6_client_close_event(struct in6_connection *client)
643 | {
644 | /*
645 | * This event is attached only when canny is acting as a client.
646 | * When the connection to the server is closed, stop the main loop.
647 | */
648 | log_info("Connection to server (fd %d) closed. Quitting.\n", client->conn.fd);
649 | run = 0;
650 | }
651 |
652 | static void in6_server_input_event(struct in6_server *server)
653 | {
654 | struct epoll_event nev;
655 | struct in6_connection *new_client;
656 | int err;
657 |
658 | if (!(new_client = calloc(1, sizeof(*new_client)))) {
659 | log_perror("calloc");
660 | } else {
661 | new_client->conn.addr = (struct sockaddr*)&new_client->addr;
662 | new_client->conn.addr_size = sizeof(new_client->addr);
663 | new_client->conn.fd = accept(server->conn.fd, new_client->conn.addr,
664 | &new_client->conn.addr_size);
665 | new_client->conn.input_event = (void(*)(struct connection*))in6_client_input_event;
666 | /* don't need the close_event when canny is acting as server */
667 |
668 | if(new_client->conn.fd < 0) {
669 | free(new_client);
670 | } else {
671 | nev.data.ptr = new_client;
672 | nev.events = EPOLLIN;
673 |
674 | if(epoll_ctl(epfd, EPOLL_CTL_ADD, new_client->conn.fd, &nev) < 0) {
675 | log_perror("epoll_ctl");
676 | close(new_client->conn.fd);
677 | free(new_client);
678 | } else if((err = array_insert(conns, new_client)) < 0) {
679 | log_error("array_insert: %s\n", strerror(-err));
680 | close(new_client->conn.fd);
681 | free(new_client);
682 | }
683 | }
684 | }
685 | }
686 |
687 | static void handle_signal(int sig)
688 | {
689 | switch(sig) {
690 | case SIGINT:
691 | case SIGHUP:
692 | case SIGTERM:
693 | case SIGUSR1:
694 | run = 0;
695 | default:
696 | break;
697 | }
698 |
699 | return;
700 | }
701 |
702 | static void sigsetup(void)
703 | {
704 | struct sigaction sa;
705 |
706 | memset(&sa, 0, sizeof(sa));
707 | sa.sa_handler = handle_signal;
708 |
709 | sigaction(SIGINT, &sa, NULL);
710 | sigaction(SIGHUP, &sa, NULL);
711 | sigaction(SIGTERM, &sa, NULL);
712 | sigaction(SIGUSR1, &sa, NULL);
713 |
714 | return;
715 | }
716 |
717 | static void print_usage(const char *argv0)
718 | {
719 | printf("Usage: %s [OPTIONS]\n"
720 | "Provide an IP-to-CAN gateway. By default, %s will fork to the background\n"
721 | "and listen for incoming connections on port %d.\n"
722 | "\n"
723 | "The following options are recognized:\n"
724 | " -d, --dont-fork don't fork to the background\n"
725 | " -c, --connect connect to the host specified by the next argument\n"
726 | " -p, --port use the port specified by the next argument\n"
727 | " -h, --help display this help and exit\n"
728 | " -v, --verbose be more verbose\n"
729 | " -q, --quiet be less verbose\n",
730 | argv0, CONFIG_MY_NAME, CONFIG_INET_PORT);
731 | }
732 |
733 | static int parse_cmdline(int argc, char *argv[], int *flags, int *port, char **hostname)
734 | {
735 | int option;
736 |
737 | do {
738 | option = getopt_long(argc, argv, SHORTOPTS, cmd_opts, NULL);
739 |
740 | switch (option) {
741 | case 'd':
742 | *flags &= ~FLAG_DAEMON;
743 | break;
744 |
745 | case 'c':
746 | *flags &= ~FLAG_LISTEN;
747 | *hostname = optarg;
748 | break;
749 |
750 | case 'p':
751 | *port = strtol(optarg, NULL, 10);
752 |
753 | if(*port > (1 << 16) || errno == ERANGE) {
754 | log_error("Invalid port specified\n");
755 | return -ERANGE;
756 | }
757 | break;
758 |
759 | case 'h':
760 | print_usage(argv[0]);
761 | return -1;
762 |
763 | case 'v':
764 | log_increase_verbosity(1);
765 | break;
766 |
767 | case 'q':
768 | log_increase_verbosity(-1);
769 | break;
770 |
771 | case '?':
772 | log_error("Unrecognized command line option `%s'\n", optarg);
773 | return -EINVAL;
774 |
775 | default:
776 | option = -1;
777 | }
778 | } while (option >= 0);
779 |
780 | return 0;
781 | }
782 |
783 | int main(int argc, char *argv[])
784 | {
785 | struct epoll_event ev[CONFIG_EPOLL_INITSIZE];
786 | char *hostname;
787 | int port;
788 | int ret_val;
789 | int flags;
790 |
791 | port = CONFIG_INET_PORT;
792 | flags = FLAG_DAEMON | FLAG_LISTEN;
793 | hostname = NULL;
794 | ret_val = 1;
795 | run = 1;
796 |
797 | if (parse_cmdline(argc, argv, &flags, &port, &hostname) < 0) {
798 | return 1;
799 | }
800 |
801 | if(!(conns = array_alloc())) {
802 | log_error("Not enough memory for connection array\n");
803 | return(1);
804 | }
805 | if(!(ifaces = array_alloc())) {
806 | log_error("Not enough memory for interface array\n");
807 | return(1);
808 | }
809 |
810 | ret_val = 1;
811 |
812 | if(flags & FLAG_DAEMON) {
813 | int pid;
814 |
815 | pid = fork();
816 |
817 | if(pid > 0) {
818 | return(0);
819 | } else if(pid < 0) {
820 | log_perror("fork");
821 | return(1);
822 | }
823 |
824 | setsid();
825 | }
826 | sigsetup();
827 |
828 | if ((epfd = epoll_create(CONFIG_EPOLL_INITSIZE)) < 0) {
829 | log_perror("epoll_create");
830 | return(1);
831 | }
832 |
833 | if(can_init() < 0) {
834 | log_error("Failed to initialize CAN sockets\n");
835 | return(1);
836 | }
837 |
838 | if(flags & FLAG_LISTEN) {
839 | if (server_init(port & 0xffff) < 0) {
840 | return 1;
841 | }
842 | } else {
843 | if (client_init(hostname, port & 0xffff) < 0) {
844 | return 1;
845 | }
846 | }
847 |
848 | while(run) {
849 | int n;
850 |
851 | n = epoll_wait(epfd, ev, CONFIG_EPOLL_INITSIZE, -1);
852 |
853 | while(--n >= 0) {
854 | struct connection *con;
855 |
856 | con = ev[n].data.ptr;
857 |
858 | if (!con->input_event) {
859 | continue;
860 | }
861 | con->input_event(con);
862 | }
863 | }
864 |
865 | close(epfd);
866 |
867 | return(ret_val);
868 | }
869 |
--------------------------------------------------------------------------------