├── .gitignore ├── CMakeLists.txt ├── LICENSE ├── README.md ├── man ├── CMakeLists.txt └── pipectl.1.scd ├── scripts └── release.sh └── src └── main.c /.gitignore: -------------------------------------------------------------------------------- 1 | build/ 2 | dist/ 3 | -------------------------------------------------------------------------------- /CMakeLists.txt: -------------------------------------------------------------------------------- 1 | cmake_minimum_required(VERSION 3.20) 2 | set(CMAKE_EXPORT_COMPILE_COMMANDS ON) 3 | 4 | project(pipectl C) 5 | 6 | # options 7 | option(INSTALL_DOCUMENTATION "install pipectl manual pages" OFF) 8 | 9 | # manual pages 10 | add_subdirectory(man) 11 | if (${BUILD_DOCUMENTATION}) 12 | build_scdoc_man_page(pipectl 1) 13 | endif() 14 | 15 | # main target 16 | file(GLOB sources src/*.c) 17 | add_executable(pipectl ${sources}) 18 | target_compile_options(pipectl PRIVATE -Wall -Wextra) 19 | 20 | # installation rules 21 | include(GNUInstallDirs) 22 | 23 | install(TARGETS pipectl DESTINATION "${CMAKE_INSTALL_BINDIR}") 24 | 25 | if (${INSTALL_DOCUMENTATION}) 26 | install_scdoc_man_page(pipectl 1) 27 | endif() 28 | -------------------------------------------------------------------------------- /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 | 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 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # `pipectl` - a simple named pipe management utility 2 | 3 | `pipectl` is a tool to create and manage short-lived named pipes that can be 4 | used to e.g. control a longer-lived program using short commands from elsewhere 5 | in the system without needing a complex IPC mechanism such as UNIX domain 6 | sockets. 7 | 8 | ## Features 9 | 10 | - Create a named pipe using `pipectl -o | long-running-program` 11 | - Send something to that program's stdin using `echo "input line" | pipectl -i` 12 | - Create multiple named pipes simultaneously by naming them with `--name` or `-n` 13 | - Create a named pipe at a custom path by using `--path` or `-p` 14 | - Cleans up after itself when the program exits and removes the pipe 15 | - Allows synchronizing writes to the pipe with the `--lock` or `-l` option 16 | 17 | ![demo screenshot](https://user-images.githubusercontent.com/4077106/147712401-7de95c84-a381-44f8-9b67-74507215f14a.png) 18 | 19 | ## Usage 20 | 21 | ``` 22 | usage: pipectl [options] 23 | 24 | options: 25 | -h, --help show this help 26 | -o, --out create a pipe and print its contents to stdout 27 | -i, --in write stdin to an open pipe 28 | -n, --name N use a pipe with a custom name instead of the default 29 | -p, --path P use a custom path P for the pipe created by pipectl 30 | -f, --force force create a pipe even if one already exists 31 | -l, --lock use flock(2) to synchronize writes to the pipe 32 | -v, --verbose print debug messages on stderr 33 | ``` 34 | 35 | ## Environment Variables 36 | 37 | `pipectl` will use the environment variables `XDG_RUNTIME_PATH` and `TMPDIR` to 38 | discover the preferred directory for the named pipes created by it. If both are 39 | unset, `pipectl` falls back to placing the pipe in `/tmp`. 40 | 41 | ## Installation 42 | 43 | `pipectl` is already packaged in many distros and can be installed via the 44 | package manager: 45 | 46 | [![Packaging Status](https://repology.org/badge/vertical-allrepos/pipectl.svg?columns=3)](https://repology.org/project/pipectl/versions) 47 | 48 | ## Dependencies 49 | 50 | - `CMake` 51 | - `scdoc` (for man pages) 52 | 53 | ## Building 54 | 55 | - Run `cmake -B build` 56 | - Run `cmake --build build` 57 | 58 | ## Files 59 | 60 | - `src/main.c`: the whole program 61 | 62 | ## License 63 | 64 | This project is licensed under the GNU GPL version 3.0 or later (SPDX 65 | [GPL-3.0-or-later](https://spdx.org/licenses/GPL-3.0-or-later.html)). The full 66 | license text can also be found in the [LICENSE](/LICENSE) file. 67 | -------------------------------------------------------------------------------- /man/CMakeLists.txt: -------------------------------------------------------------------------------- 1 | # check if documentation must be built 2 | if (${INSTALL_DOCUMENTATION}) 3 | set(SCDOC_REQUIRED REQUIRED) 4 | else() 5 | set(SCDOC_REQUIRED) 6 | endif() 7 | 8 | # determine if documentation can be built 9 | find_program(SCDOC scdoc ${SCDOC_REQUIRED}) 10 | if (SCDOC) 11 | set(BUILD_DOCUMENTATION ON PARENT_SCOPE) 12 | else() 13 | set(BUILD_DOCUMENTATION OFF PARENT_SCOPE) 14 | endif() 15 | 16 | function(build_scdoc_man_page name section) 17 | file(MAKE_DIRECTORY "${CMAKE_BINARY_DIR}/man/") 18 | set(man-src "${CMAKE_SOURCE_DIR}/man/${name}.${section}.scd") 19 | set(man-bin "${CMAKE_BINARY_DIR}/man/${name}.${section}") 20 | add_custom_command( 21 | OUTPUT "${man-bin}" 22 | MAIN_DEPENDENCY "${man-src}" 23 | COMMAND scdoc < "${man-src}" > "${man-bin}" 24 | ) 25 | add_custom_target(gen-man-${name}-${section} ALL DEPENDS "${man-bin}") 26 | endfunction() 27 | 28 | function(install_scdoc_man_page name section) 29 | set(man-bin "${CMAKE_BINARY_DIR}/man/${name}.${section}") 30 | install(FILES "${man-bin}" DESTINATION "${CMAKE_INSTALL_MANDIR}/man${section}/") 31 | endfunction() 32 | -------------------------------------------------------------------------------- /man/pipectl.1.scd: -------------------------------------------------------------------------------- 1 | pipectl(1) 2 | 3 | # NAME 4 | 5 | pipectl - a simple named pipe management utility 6 | 7 | # SYNOPSIS 8 | 9 | *pipectl* [-h,-o,-i,-n N,-p P,-f,-l] 10 | 11 | # DESCRIPTION 12 | 13 | *pipectl* is a tool to create and manage short-lived named pipes that can be 14 | used to feed stdin to a longer-lived program from elsewhere in the system 15 | without needing a complex IPC mechanism such as UNIX domain sockets. 16 | 17 | *pipectl* is intended to be used in pairs, one call to *pipectl* opens the pipe 18 | (*-o*) and feeds it to a process, and all others with the same name or path will 19 | write to the stdin of that process: 20 | 21 | $ pipectl -o | daemon-process 22 | 23 | $ echo "do-the-thing --color red" | pipectl -i 24 | 25 | $ echo "quit" | pipectl -i 26 | 27 | The daemon process process will never observe an EOF on its stdin. *pipectl* 28 | will instead block until another input pipe (*-i*) is openend and will then feed 29 | the stdin of that process to the daemon process asynchronously. 30 | 31 | When the daemon process exits or closes its stdin, *pipectl* will clean up and 32 | remove the created named pipe automatically. 33 | 34 | # OPTIONS 35 | 36 | *-h, --help* 37 | Show help message and exit. 38 | 39 | *-o, --out* 40 | Create a named pipe and print its contents to stdout. 41 | 42 | *-i, --in* 43 | Write stdin to an open named pipe created with *-o*. 44 | 45 | *-n N, --name N* 46 | Create named pipe with a custom name. See *PATHS*. 47 | 48 | *-p P, --path P* 49 | Create a names pipe at a custom path. See *PATHS*. 50 | 51 | *-f, --force* 52 | Force overwrite an existing named pipe event if it already exists (only usable with *-o*). 53 | 54 | *-l, --lock* 55 | Use *flock*(2) to synchronize writes to the pipe (only usable with *-i*). 56 | 57 | # PATHS 58 | 59 | By default, *pipectl* will create the named pipe in a temporary directory 60 | (*TMP*). The first available directory of these will be used: 61 | 62 | - *$XDG_RUNTIME_DIR* 63 | - *$TMPDIR* 64 | - /tmp 65 | 66 | The resulting path of the named pipe is as follows: 67 | 68 | *default* 69 | *TMP*/pipectl.*UID*.pipe 70 | 71 | *with --name NAME* 72 | *TMP*/pipectl.*UID*.*NAME*.pipe 73 | 74 | *with --path PATH* 75 | *PATH* 76 | 77 | where *UID* is the real user id of the *pipectl* process (see *getuid*(3)). 78 | 79 | # AUTHORS 80 | 81 | Maintained by Ferdinand Bachmann . More information on *pipectl* can be found at . 82 | 83 | # SEE ALSO 84 | 85 | *pipectl*(1) *mkfifo*(1) *flock*(2) *getuid*(3) 86 | -------------------------------------------------------------------------------- /scripts/release.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | set -euo pipefail 3 | 4 | # environment variables for reproducible archive 5 | SOURCE_EPOCH=$(git show --no-patch --format=%ct) 6 | TARFLAGS=" 7 | --sort=name 8 | --mtime=@$SOURCE_EPOCH 9 | --owner=0 --group=0 --numeric-owner 10 | --pax-option=exthdr.name=%d/PaxHeaders/%f,delete=atime,delete=ctime 11 | " 12 | # wrapper function for reproducible archive 13 | tar() { 14 | LC_ALL="C.UTF-8" command tar $TARFLAGS "$@" 15 | } 16 | 17 | SCRIPTDIR=$(realpath "$(dirname "${BASH_SOURCE[0]}")") 18 | REPODIR=$(realpath "$SCRIPTDIR/..") 19 | 20 | TEMPDIR=$(mktemp -d) 21 | cleanup() { 22 | if [[ ! -z "$TEMPDIR" && -d "$TEMPDIR" ]]; then 23 | rm -rf "$TEMPDIR" 24 | fi 25 | } 26 | trap cleanup EXIT 27 | 28 | cd "$REPODIR" 29 | 30 | TAGS=( $(git tag -l --contains HEAD) ) 31 | NUM_TAGS="${#TAGS[@]}" 32 | if [[ $NUM_TAGS -eq 0 ]]; then 33 | echo "error: no tag on current commit" 34 | exit 1 35 | elif [[ $NUM_TAGS -gt 1 ]]; then 36 | echo "error: multiple tags on current commit" 37 | echo "info: found tags ( ${TAGS[@]} )" 38 | exit 1 39 | fi 40 | 41 | TAG="${TAGS[0]}" 42 | if [[ ! $TAG =~ v[0-9]+.[0-9]+.[0-9]+ ]]; then 43 | echo "error: tag does not match version regex" 44 | echo "info: tag was $TAG" 45 | exit 1 46 | fi 47 | 48 | VERSION="${TAG##v}" 49 | echo ">> creating release $VERSION" 50 | 51 | echo "- cloning repo" 52 | cd "$TEMPDIR" 53 | git clone --recursive "$REPODIR" "pipectl-$VERSION" 54 | 55 | echo "- removing unneeded files" 56 | rm -rf "pipectl-$VERSION/.git" 57 | rm -rf "pipectl-$VERSION/.gitignore" 58 | 59 | echo "- adding version file" 60 | echo "$TAG" > "pipectl-$VERSION/version.txt" 61 | 62 | echo "- creating archive" 63 | mkdir -p "$REPODIR/dist" 64 | tar -caf "$REPODIR/dist/pipectl-$VERSION.tar.gz" "pipectl-$VERSION/" 65 | 66 | if [[ ! -z "${SIGKEY+z}" ]]; then 67 | echo "- signing archive" 68 | gpg --yes -u "$SIGKEY" -o "$REPODIR/dist/pipectl-$VERSION.tar.gz.asc" --armor --detach-sig "$REPODIR/dist/pipectl-$VERSION.tar.gz" 69 | gpg --yes -o "$REPODIR/dist/pipectl-$VERSION.tar.gz.sig" --dearmor "$REPODIR/dist/pipectl-$VERSION.tar.gz.asc" 70 | else 71 | echo "- skipping signing archive (SIGKEY not set)" 72 | fi 73 | 74 | echo "- success" 75 | -------------------------------------------------------------------------------- /src/main.c: -------------------------------------------------------------------------------- 1 | #define _GNU_SOURCE 2 | #include 3 | #include 4 | #include 5 | #include 6 | #include 7 | #include 8 | #include 9 | #include 10 | #include 11 | #include 12 | #include 13 | #include 14 | #include 15 | 16 | #define log_debug(ctx, fmt, ...) if ((ctx)->verbose) fprintf(stderr, "debug: " fmt, ##__VA_ARGS__) 17 | #define log_error(fmt, ...) fprintf(stderr, "error: " fmt, ##__VA_ARGS__) 18 | 19 | #define ARRAY_SIZE(arr) ((sizeof (arr)) / (sizeof ((arr)[0]))) 20 | 21 | #define BUFFER_SIZE 4096 22 | 23 | typedef struct { 24 | char * data; 25 | size_t size; 26 | size_t capacity; 27 | } buf_t; 28 | 29 | typedef struct { 30 | bool out; 31 | bool in; 32 | bool force; 33 | bool lock; 34 | bool verbose; 35 | char * name; 36 | 37 | char * pipe_path; 38 | buf_t pipe_out_buffer; 39 | buf_t pipe_in_buffer; 40 | int pipe_out_fd; 41 | int pipe_in_fd; 42 | bool pipe_dangling; 43 | } ctx_t; 44 | 45 | ctx_t * sig_ctx; 46 | 47 | bool pipe_needs_cleanup(ctx_t * ctx) { 48 | // always remove the pipe if we tried to create it but failed to open it 49 | if (ctx->pipe_dangling) return true; 50 | // otherwise, perform stat check to see if we should remove it 51 | if (!ctx->out || ctx->pipe_path == NULL || ctx->pipe_out_fd == -1) return false; 52 | 53 | struct stat stat; 54 | if (fstat(ctx->pipe_out_fd, &stat) == -1) { 55 | log_error("failed to stat pipe fd: %s\n", strerror(errno)); 56 | return false; 57 | } 58 | 59 | // pipe needs cleanup as long as there are still links 60 | return stat.st_nlink != 0; 61 | } 62 | 63 | void cleanup(ctx_t * ctx) { 64 | if (pipe_needs_cleanup(ctx)) unlink(ctx->pipe_path); 65 | if (ctx->pipe_out_fd != -1) close(ctx->pipe_out_fd); 66 | if (ctx->pipe_in_fd != -1) close(ctx->pipe_in_fd); 67 | free(ctx->pipe_path); 68 | free(ctx->pipe_out_buffer.data); 69 | free(ctx->pipe_in_buffer.data); 70 | sig_ctx = NULL; 71 | } 72 | 73 | noreturn void exit_fail(ctx_t * ctx) { 74 | cleanup(ctx); 75 | exit(1); 76 | } 77 | 78 | void usage(ctx_t * ctx) { 79 | printf("usage: pipectl [options]\n"); 80 | printf("\n"); 81 | printf("options:\n"); 82 | printf(" -h, --help show this help\n"); 83 | printf(" -o, --out create a pipe and print its contents to stdout\n"); 84 | printf(" -i, --in write stdin to an open pipe\n"); 85 | printf(" -n, --name N use a pipe with a custom name instead of the default\n"); 86 | printf(" -p, --path P use a custom path P for the pipe created by pipectl\n"); 87 | printf(" -f, --force force create a pipe even if one already exists\n"); 88 | printf(" -l, --lock use flock(2) to synchronize writes to the pipe\n"); 89 | printf(" -v, --verbose print debug messages on stderr\n"); 90 | cleanup(ctx); 91 | exit(0); 92 | } 93 | 94 | void parse_opt(ctx_t * ctx, int argc, char ** argv) { 95 | if (argc > 0) { 96 | // skip program name 97 | argv++; 98 | argc--; 99 | } 100 | 101 | while (argc > 0 && argv[0][0] == '-') { 102 | if (strcmp(argv[0], "-h") == 0 || strcmp(argv[0], "--help") == 0) { 103 | usage(ctx); 104 | } else if (strcmp(argv[0], "-o") == 0 || strcmp(argv[0], "--out") == 0) { 105 | ctx->out = true; 106 | } else if (strcmp(argv[0], "-i") == 0 || strcmp(argv[0], "--in") == 0) { 107 | ctx->in = true; 108 | } else if (strcmp(argv[0], "-f") == 0 || strcmp(argv[0], "--force") == 0) { 109 | ctx->force = true; 110 | } else if (strcmp(argv[0], "-l") == 0 || strcmp(argv[0], "--lock") == 0) { 111 | ctx->lock = true; 112 | } else if (strcmp(argv[0], "-v") == 0 || strcmp(argv[0], "--verbose") == 0) { 113 | ctx->verbose = true; 114 | } else if (strcmp(argv[0], "-n") == 0 || strcmp(argv[0], "--name") == 0) { 115 | if (argc < 2) { 116 | log_error("option '%s' requires an argument\n", argv[0]); 117 | exit_fail(ctx); 118 | } 119 | 120 | if (strcspn(argv[1], "/") != strlen(argv[1])) { 121 | log_error("option '%s': pipe name may not contain slashes\n", argv[0]); 122 | exit_fail(ctx); 123 | } 124 | 125 | ctx->name = argv[1]; 126 | 127 | argv++; 128 | argc--; 129 | } else if (strcmp(argv[0], "-p") == 0 || strcmp(argv[0], "--path") == 0) { 130 | if (argc < 2) { 131 | log_error("option '%s' requires an argument\n", argv[0]); 132 | exit_fail(ctx); 133 | } 134 | 135 | char * path = strdup(argv[1]); 136 | if (path == NULL) { 137 | log_error("option '%s': failed to allocate copy of custom path '%s'\n", argv[0], argv[1]); 138 | exit_fail(ctx); 139 | } 140 | 141 | ctx->pipe_path = path; 142 | 143 | argv++; 144 | argc--; 145 | } else if (strcmp(argv[0], "--") == 0) { 146 | argv++; 147 | argc--; 148 | break; 149 | } else { 150 | log_error("invalid option '%s'\n", argv[0]); 151 | exit_fail(ctx); 152 | } 153 | 154 | argv++; 155 | argc--; 156 | } 157 | 158 | if (argc > 0 || (!ctx->in && !ctx->out)) { 159 | usage(ctx); 160 | } 161 | } 162 | 163 | char * get_tmp_dir(void) { 164 | char * tmp_dir = NULL; 165 | 166 | if (tmp_dir == NULL) tmp_dir = getenv("XDG_RUNTIME_DIR"); 167 | if (tmp_dir == NULL) tmp_dir = getenv("TMPDIR"); 168 | if (tmp_dir == NULL) tmp_dir = "/tmp"; 169 | 170 | return tmp_dir; 171 | } 172 | 173 | void get_pipe_path(ctx_t * ctx) { 174 | int uid = getuid(); 175 | 176 | char * tmp_dir = get_tmp_dir(); 177 | 178 | char * path = NULL; 179 | int status; 180 | if (ctx->name == NULL) { 181 | status = asprintf(&path, "%s/pipectl.%d.pipe", tmp_dir, uid); 182 | } else { 183 | status = asprintf(&path, "%s/pipectl.%d.%s.pipe", tmp_dir, uid, ctx->name); 184 | } 185 | 186 | if (status == -1) { 187 | log_error("failed to allocate formatted pipe path\n"); 188 | exit_fail(ctx); 189 | } 190 | 191 | ctx->pipe_path = path; 192 | } 193 | 194 | void cleanup_on_signal(int signum) { 195 | (void)signum; 196 | 197 | cleanup(sig_ctx); 198 | exit(0); 199 | } 200 | 201 | void register_signal_handlers(ctx_t * ctx) { 202 | sig_ctx = ctx; 203 | signal(SIGINT, cleanup_on_signal); 204 | signal(SIGHUP, cleanup_on_signal); 205 | signal(SIGTERM, cleanup_on_signal); 206 | signal(SIGPIPE, cleanup_on_signal); 207 | } 208 | 209 | void buf_allocate(ctx_t * ctx, buf_t * buffer, char * label) { 210 | buffer->data = malloc(sizeof (char) * BUFFER_SIZE); 211 | if (buffer->data == NULL) { 212 | log_error("failed to allocate %s buffer\n", label); 213 | exit_fail(ctx); 214 | } 215 | 216 | buffer->capacity = BUFFER_SIZE; 217 | } 218 | 219 | int open_pipe(ctx_t * ctx, int mode) { 220 | int fd = open(ctx->pipe_path, mode); 221 | if (fd == -1) { 222 | log_error("could not open pipe at '%s': %s\n", ctx->pipe_path, strerror(errno)); 223 | exit_fail(ctx); 224 | } 225 | 226 | struct stat stat; 227 | if (fstat(fd, &stat) == -1) { 228 | log_error("could not open pipe at '%s': %s\n", ctx->pipe_path, strerror(errno)); 229 | close(fd); 230 | exit_fail(ctx); 231 | } 232 | 233 | if (!S_ISFIFO(stat.st_mode)) { 234 | log_error("could not open pipe at '%s': File is not a named pipe\n", ctx->pipe_path); 235 | close(fd); 236 | exit_fail(ctx); 237 | } 238 | 239 | // make reading from and writing to pipe nonblocking 240 | int flags = fcntl(ctx->pipe_out_fd, F_GETFL); 241 | flags |= O_NONBLOCK; 242 | fcntl(ctx->pipe_out_fd, F_SETFL, flags); 243 | 244 | return fd; 245 | } 246 | 247 | void create_out_pipe(ctx_t * ctx) { 248 | if (ctx->force) { 249 | if (unlink(ctx->pipe_path) == -1 && errno != ENOENT) { 250 | log_error("could not remove old pipe at '%s': %s\n", ctx->pipe_path, strerror(errno)); 251 | exit_fail(ctx); 252 | } 253 | } 254 | 255 | if (mkfifo(ctx->pipe_path, 0666) == -1) { 256 | log_error("could not create pipe at '%s': %s\n", ctx->pipe_path, strerror(errno)); 257 | exit_fail(ctx); 258 | } 259 | 260 | // mark the pipe as dangling before trying to open it 261 | // to ensure it's removed if we fail 262 | ctx->pipe_dangling = true; 263 | ctx->pipe_out_fd = open_pipe(ctx, O_RDWR); 264 | ctx->pipe_dangling = false; 265 | 266 | buf_allocate(ctx, &ctx->pipe_out_buffer, "output"); 267 | 268 | // make writing to stdout nonblocking 269 | int flags = fcntl(STDOUT_FILENO, F_GETFL); 270 | flags |= O_NONBLOCK; 271 | fcntl(STDOUT_FILENO, F_SETFL, flags); 272 | } 273 | 274 | void open_in_pipe(ctx_t * ctx) { 275 | ctx->pipe_in_fd = open_pipe(ctx, O_WRONLY); 276 | 277 | if (ctx->lock) flock(ctx->pipe_in_fd, LOCK_EX); 278 | 279 | buf_allocate(ctx, &ctx->pipe_in_buffer, "input"); 280 | 281 | // make reading from stdin nonblocking 282 | int flags = fcntl(STDIN_FILENO, F_GETFL); 283 | flags |= O_NONBLOCK; 284 | fcntl(STDIN_FILENO, F_SETFL, flags); 285 | } 286 | 287 | bool buf_can_read(buf_t * buffer) { 288 | return buffer->size < buffer->capacity; 289 | } 290 | 291 | bool buf_can_write(buf_t * buffer) { 292 | return buffer->size > 0; 293 | } 294 | 295 | ssize_t pipe_to_buffer(ctx_t * ctx, int from_fd, buf_t * to_buffer, char * label) { 296 | ssize_t num = read(from_fd, to_buffer->data + to_buffer->size, to_buffer->capacity - to_buffer->size); 297 | if (num == -1 && errno == EWOULDBLOCK) { 298 | log_debug(ctx, "reading from %s would block\n", label); 299 | } else if (num == -1) { 300 | log_error("failed to read data from %s: %s\n", label, strerror(errno)); 301 | exit_fail(ctx); 302 | } else { 303 | to_buffer->size += num; 304 | } 305 | 306 | return num; 307 | } 308 | 309 | ssize_t pipe_from_buffer(ctx_t * ctx, buf_t * from_buffer, int to_fd, char * label) { 310 | ssize_t num = write(to_fd, from_buffer->data, from_buffer->size); 311 | if (num == -1 && errno == EWOULDBLOCK) { 312 | log_debug(ctx, "writing to %s would block\n", label); 313 | } else if (num == -1) { 314 | log_error("failed to write data to %s: %s\n", label, strerror(errno)); 315 | exit_fail(ctx); 316 | } else { 317 | from_buffer->size -= num; 318 | memmove(from_buffer->data, from_buffer->data + num, from_buffer->size); 319 | } 320 | 321 | return num; 322 | } 323 | 324 | void event_loop(ctx_t * ctx) { 325 | struct pollfd pollfds[5]; 326 | struct pollfd * poll_stdin = &pollfds[0]; 327 | struct pollfd * poll_pipe_in = &pollfds[1]; 328 | struct pollfd * poll_pipe_out = &pollfds[2]; 329 | struct pollfd * poll_stdout = &pollfds[3]; 330 | struct pollfd * poll_stdout_closed = &pollfds[4]; 331 | 332 | poll_stdin->revents = 0; 333 | poll_pipe_in->revents = 0; 334 | poll_pipe_out->revents = 0; 335 | poll_stdout->revents = 0; 336 | poll_stdout_closed->revents = 0; 337 | 338 | bool out_closed = !ctx->out; 339 | bool in_closed = !ctx->in; 340 | bool in_pending = false; 341 | bool closing = false; 342 | do { 343 | // --- stdin ----------------------------------------------------------- 344 | if (poll_stdin->revents & (POLLERR | POLLHUP)) { 345 | log_debug(ctx, "stdin closed\n"); 346 | in_closed = true; 347 | } 348 | 349 | if (poll_stdin->revents & POLLIN) { 350 | log_debug(ctx, "reading from stdin\n"); 351 | if (pipe_to_buffer(ctx, poll_stdin->fd, &ctx->pipe_in_buffer, "stdin") == 0) { 352 | log_debug(ctx, "stdin closed due to empty read\n"); 353 | in_closed = true; 354 | } 355 | } 356 | 357 | poll_stdin->fd = !in_closed && buf_can_read(&ctx->pipe_in_buffer) ? STDIN_FILENO : -1; 358 | poll_stdin->events = POLLIN; 359 | poll_stdin->revents = 0; 360 | 361 | // --- pipe_in --------------------------------------------------------- 362 | if (poll_pipe_in->revents & POLLERR) { 363 | log_error("failed to write to pipe: POLLERR\n"); 364 | exit_fail(ctx); 365 | } 366 | 367 | if (poll_pipe_in->revents & POLLOUT) { 368 | log_debug(ctx, "writing to pipe\n"); 369 | pipe_from_buffer(ctx, &ctx->pipe_in_buffer, poll_pipe_in->fd, "pipe"); 370 | } 371 | 372 | in_pending = buf_can_write(&ctx->pipe_in_buffer); 373 | poll_pipe_in->fd = in_pending ? ctx->pipe_in_fd : -1; 374 | poll_pipe_in->events = POLLOUT; 375 | poll_pipe_in->revents = 0; 376 | 377 | // --- pipe_out -------------------------------------------------------- 378 | if (poll_pipe_out->revents & POLLERR) { 379 | log_error("failed to read from pipe: POLLERR\n"); 380 | exit_fail(ctx); 381 | } 382 | 383 | if (poll_pipe_out->revents & POLLIN) { 384 | log_debug(ctx, "reading from pipe\n"); 385 | pipe_to_buffer(ctx, poll_pipe_out->fd, &ctx->pipe_out_buffer, "pipe"); 386 | } 387 | 388 | poll_pipe_out->fd = !out_closed && buf_can_read(&ctx->pipe_out_buffer) ? ctx->pipe_out_fd : -1; 389 | poll_pipe_out->events = POLLIN; 390 | poll_pipe_out->revents = 0; 391 | 392 | // --- stdout ---------------------------------------------------------- 393 | if (poll_stdout->revents & POLLOUT) { 394 | log_debug(ctx, "writing to stdout\n"); 395 | pipe_from_buffer(ctx, &ctx->pipe_out_buffer, poll_stdout->fd, "stdout"); 396 | } 397 | 398 | poll_stdout->fd = !out_closed && buf_can_write(&ctx->pipe_out_buffer) ? STDOUT_FILENO : -1; 399 | poll_stdout->events = POLLOUT; 400 | poll_stdout->revents = 0; 401 | 402 | // --- stdout_closed --------------------------------------------------- 403 | if (poll_stdout_closed->revents & POLLERR) { 404 | log_debug(ctx, "stdout closed\n"); 405 | out_closed = true; 406 | } 407 | 408 | poll_stdout_closed->fd = !out_closed ? STDOUT_FILENO : -1; 409 | poll_stdout_closed->events = 0; 410 | poll_stdout_closed->revents = 0; 411 | 412 | // --- closing flag ---------------------------------------------------- 413 | if (ctx->out) { 414 | closing = out_closed; 415 | } else { 416 | closing = in_closed && !in_pending; 417 | } 418 | 419 | log_debug(ctx, "polling\n"); 420 | } while (!closing && poll(pollfds, ARRAY_SIZE(pollfds), -1) >= 0); 421 | } 422 | 423 | void init(ctx_t * ctx) { 424 | ctx->out = false; 425 | ctx->in = false; 426 | ctx->force = false; 427 | ctx->lock = false; 428 | ctx->verbose = false; 429 | ctx->name = NULL; 430 | ctx->pipe_path = NULL; 431 | ctx->pipe_in_buffer.data = NULL; 432 | ctx->pipe_in_buffer.size = 0; 433 | ctx->pipe_in_buffer.capacity = 0; 434 | ctx->pipe_out_buffer.data = NULL; 435 | ctx->pipe_out_buffer.size = 0; 436 | ctx->pipe_out_buffer.capacity = 0; 437 | ctx->pipe_out_fd = -1; 438 | ctx->pipe_in_fd = -1; 439 | ctx->pipe_dangling = false; 440 | 441 | register_signal_handlers(ctx); 442 | } 443 | 444 | 445 | int main(int argc, char ** argv) { 446 | ctx_t ctx; 447 | init(&ctx); 448 | 449 | parse_opt(&ctx, argc, argv); 450 | 451 | if (ctx.pipe_path == NULL) get_pipe_path(&ctx); 452 | if (ctx.out) create_out_pipe(&ctx); 453 | if (ctx.in) open_in_pipe(&ctx); 454 | 455 | event_loop(&ctx); 456 | 457 | cleanup(&ctx); 458 | } 459 | --------------------------------------------------------------------------------