docs/afb-binding-references.md

   1 # Binding Reference
   2
   3 ## Structure for declaring binding
   4
   5 ### struct afb_binding_v2
   6
   7 The main structure, of type **afb_binding_v2**, for describing the binding
   8 must be exported under the name **afbBindingV2**.
   9
  10 This structure is defined as below.
  11
  12 ```C
  13 /*
  14  * Description of the bindings of type version 2
  15  */
  16 struct afb_binding_v2
  17 {
  18         const char *api;                        /* api name for the binding */
  19         const char *specification;              /* textual openAPIv3 specification of the binding */
  20         const char *info;                       /* some info about the api, can be NULL */
  21         const struct afb_verb_v2 *verbs;        /* array of descriptions of verbs terminated by a NULL name */
  22         int (*preinit)();                       /* callback at load of the binding */
  23         int (*init)();                          /* callback for starting the service */
  24         void (*onevent)(const char *event, struct json_object *object); /* callback for handling events */
  25         unsigned noconcurrency: 1;              /* avoids concurrent requests to verbs */
  26 };
  27 ```
  28
  29 ### struct afb_verb_v2
  30
  31 Each verb is described with a structure of type **afb_verb_v2**
  32 defined below:
  33
  34 ```C
  35 /*
  36  * Description of one verb of the API provided by the binding
  37  * This enumeration is valid for bindings of type version 2
  38  */
  39 struct afb_verb_v2
  40 {
  41         const char *verb;                       /* name of the verb */
  42         void (*callback)(struct afb_req req);   /* callback function implementing the verb */
  43         const struct afb_auth *auth;            /* required authorization */
  44         const char *info;                       /* some info about the verb, can be NULL */
  45         uint32_t session;                       /* authorization and session requirements of the verb */
  46 };
  47 ```
  48
  49 The **session** flags is one of the constant defined below:
  50
  51 - AFB_SESSION_NONE : no flag, synonym to 0
  52 - AFB_SESSION_LOA_0 : Requires the LOA to be 0 or more, synonym to 0 or AFB_SESSION_NONE
  53 - AFB_SESSION_LOA_1 : Requires the LOA to be 1 or more
  54 - AFB_SESSION_LOA_2 : Requires the LOA to be 2 or more
  55 - AFB_SESSION_LOA_3 : Requires the LOA to be 3 or more
  56 - AFB_SESSION_CHECK : Requires the token to be set and valid
  57 - AFB_SESSION_REFRESH : Implies a token refresh
  58 - AFB_SESSION_CLOSE : Implies cloing the session
  59
  60 The LOA (Level Of Assurance) is set, by binding, using the function **afb_req_session_set_LOA**.
  61
  62 ### struct afb_auth and enum afb_auth_type
  63
  64 The structure **afb_auth** is used within verb description to
  65 set security requirements.
  66 The interpretation of the structure depends on the value of the field **type**.
  67
  68 ```C
  69 struct afb_auth
  70 {
  71         const enum afb_auth_type type;
  72         union {
  73                 const char *text;
  74                 const unsigned loa;
  75                 const struct afb_auth *first;
  76         };
  77         const struct afb_auth *next;
  78 };
  79 ```
  80
  81 The possible values for **type** is defined here:
  82
  83 ```C
  84 /*
  85  * Enum for Session/Token/Assurance middleware.
  86  */
  87 enum afb_auth_type
  88 {
  89         afb_auth_No = 0,        /** never authorized, no data */
  90         afb_auth_Token,         /** authorized if token valid, no data */
  91         afb_auth_LOA,           /** authorized if LOA greater than data 'loa' */
  92         afb_auth_Permission,    /** authorized if permission 'text' is granted */
  93         afb_auth_Or,            /** authorized if 'first' or 'next' is authorized */
  94         afb_auth_And,           /** authorized if 'first' and 'next' are authorized */
  95         afb_auth_Not,           /** authorized if 'first' is not authorized */
  96         afb_auth_Yes            /** always authorized, no data */
  97 };
  98 ```
  99
 100 Example:
 101
 102 ```C
 103 static const struct afb_auth _afb_auths_v2_monitor[] = {
 104     { .type = afb_auth_Permission, .text = "urn:AGL:permission:monitor:public:set" },
 105     { .type = afb_auth_Permission, .text = "urn:AGL:permission:monitor:public:get" },
 106     { .type = afb_auth_Or, .first = &_afb_auths_v2_monitor[1], .next = &_afb_auths_v2_monitor[0] }
 107 };
 108 ```
 109
 110 ## Functions of class afb_daemon
 111
 112 The 3 following functions are linked to libsystemd.
 113 They allow use of **sd_event** features and access
 114 to **sd_bus** features.
 115
 116 ```C
 117 /*
 118  * Retrieves the common systemd's event loop of AFB
 119  */
 120 struct sd_event *afb_daemon_get_event_loop();
 121
 122 /*
 123  * Retrieves the common systemd's user/session d-bus of AFB
 124  */
 125 struct sd_bus *afb_daemon_get_user_bus();
 126
 127 /*
 128  * Retrieves the common systemd's system d-bus of AFB
 129  */
 130 struct sd_bus *afb_daemon_get_system_bus();
 131 ```
 132
 133 The 2 following functions are linked to event management.
 134 Broadcasting an event send it to any possible listener.
 135
 136 ```C
 137 /*
 138  * Broadcasts widely the event of 'name' with the data 'object'.
 139  * 'object' can be NULL.
 140  *
 141  * For convenience, the function calls 'json_object_put' for 'object'.
 142  * Thus, in the case where 'object' should remain available after
 143  * the function returns, the function 'json_object_get' shall be used.
 144  *
 145  * Returns the count of clients that received the event.
 146  */
 147 int afb_daemon_broadcast_event(const char *name, struct json_object *object);
 148
 149 /*
 150  * Creates an event of 'name' and returns it.
 151  *
 152  * See afb_event_is_valid to check if there is an error.
 153  */
 154 struct afb_event afb_daemon_make_event(const char *name);
 155 ```
 156
 157 The following function is used by logging macros and should normally
 158 not be used.
 159 Instead, you should use the macros:
 160
 161 - **AFB\_ERROR**
 162 - **AFB\_WARNING**
 163 - **AFB\_NOTICE**
 164 - **AFB\_INFO**
 165 - **AFB\_DEBUG**
 166
 167 ```C
 168 /*
 169  * Send a message described by 'fmt' and following parameters
 170  * to the journal for the verbosity 'level'.
 171  *
 172  * 'file', 'line' and 'func' are indicators of position of the code in source files
 173  * (see macros __FILE__, __LINE__ and __func__).
 174  *
 175  * 'level' is defined by syslog standard:
 176  *      EMERGENCY         0        System is unusable
 177  *      ALERT             1        Action must be taken immediately
 178  *      CRITICAL          2        Critical conditions
 179  *      ERROR             3        Error conditions
 180  *      WARNING           4        Warning conditions
 181  *      NOTICE            5        Normal but significant condition
 182  *      INFO              6        Informational
 183  *      DEBUG             7        Debug-level messages
 184  */
 185 void afb_daemon_verbose(int level, const char *file, int line, const char * func, const char *fmt, ...);
 186 ```
 187
 188 The 2 following functions MUST be used to access data of the bindings.
 189
 190 ```C
 191 /*
 192  * Get the root directory file descriptor. This file descriptor can
 193  * be used with functions 'openat', 'fstatat', ...
 194  */
 195 int afb_daemon_rootdir_get_fd();
 196
 197 /*
 198  * Opens 'filename' within the root directory with 'flags' (see function openat)
 199  * using the 'locale' definition (example: "jp,en-US") that can be NULL.
 200  * Returns the file descriptor or -1 in case of error.
 201  */
 202 int afb_daemon_rootdir_open_locale(const char *filename, int flags, const char *locale);
 203 ```
 204
 205 The following function is used to queue jobs.
 206
 207 ```C
 208 /*
 209  * Queue the job defined by 'callback' and 'argument' for being executed asynchronously
 210  * in this thread (later) or in an other thread.
 211  * If 'group' is not NUL, the jobs queued with a same value (as the pointer value 'group')
 212  * are executed in sequence in the order of there submission.
 213  * If 'timeout' is not 0, it represent the maximum execution time for the job in seconds.
 214  * At first, the job is called with 0 as signum and the given argument.
 215  * The job is executed with the monitoring of its time and some signals like SIGSEGV and
 216  * SIGFPE. When a such signal is catched, the job is terminated and re-executed but with
 217  * signum being the signal number (SIGALRM when timeout expired).
 218  *
 219  * Returns 0 in case of success or -1 in case of error.
 220  */
 221 int afb_daemon_queue_job(void (*callback)(int signum, void *arg), void *argument, void *group, int timeout)
 222 ```
 223
 224 The following function must be used when a binding depends on other
 225 bindings at its initialization.
 226
 227 ```C
 228 /*
 229  * Tells that it requires the API of "name" to exist
 230  * and if 'initialized' is not null to be initialized.
 231  * Returns 0 in case of success or -1 in case of error.
 232  */
 233 int afb_daemon_require_api(const char *name, int initialized)
 234 ```
 235
 236 ## Functions of class afb_service
 237
 238 The following functions allow services to call verbs of other
 239 bindings for themselves.
 240
 241 ```C
 242 /**
 243  * Calls the 'verb' of the 'api' with the arguments 'args' and 'verb' in the name of the binding.
 244  * The result of the call is delivered to the 'callback' function with the 'callback_closure'.
 245  *
 246  * For convenience, the function calls 'json_object_put' for 'args'.
 247  * Thus, in the case where 'args' should remain available after
 248  * the function returns, the function 'json_object_get' shall be used.
 249  *
 250  * The 'callback' receives 3 arguments:
 251  *  1. 'closure' the user defined closure pointer 'callback_closure',
 252  *  2. 'status' a status being 0 on success or negative when an error occured,
 253  *  2. 'result' the resulting data as a JSON object.
 254  *
 255  * @param api      The api name of the method to call
 256  * @param verb     The verb name of the method to call
 257  * @param args     The arguments to pass to the method
 258  * @param callback The to call on completion
 259  * @param callback_closure The closure to pass to the callback
 260  *
 261  * @see also 'afb_req_subcall'
 262  */
 263 void afb_service_call(
 264     const char *api,
 265     const char *verb,
 266     struct json_object *args,
 267     void (*callback)(void*closure, int status, struct json_object *result),
 268     void *callback_closure);
 269
 270 /**
 271  * Calls the 'verb' of the 'api' with the arguments 'args' and 'verb' in the name of the binding.
 272  * 'result' will receive the response.
 273  *
 274  * For convenience, the function calls 'json_object_put' for 'args'.
 275  * Thus, in the case where 'args' should remain available after
 276  * the function returns, the function 'json_object_get' shall be used.
 277  *
 278  * @param api      The api name of the method to call
 279  * @param verb     The verb name of the method to call
 280  * @param args     The arguments to pass to the method
 281  * @param result   Where to store the result - should call json_object_put on it -
 282  *
 283  * @returns 0 in case of success or a negative value in case of error.
 284  *
 285  * @see also 'afb_req_subcall'
 286  */
 287 int afb_service_call_sync(
 288     const char *api,
 289     const char *verb,
 290     struct json_object *args,
 291     struct json_object **result);
 292 ```
 293
 294 ## Functions of class afb_event
 295
 296 This function checks whether the event is valid.
 297 It must be used when creating events.
 298
 299 ```C
 300 /*
 301  * Checks wether the 'event' is valid or not.
 302  *
 303  * Returns 0 if not valid or 1 if valid.
 304  */
 305 int afb_event_is_valid(struct afb_event event);
 306 ```
 307
 308 The two following functions are used to broadcast or push
 309 event with its data.
 310
 311 ```C
 312 /*
 313  * Broadcasts widely the 'event' with the data 'object'.
 314  * 'object' can be NULL.
 315  *
 316  * For convenience, the function calls 'json_object_put' for 'object'.
 317  * Thus, in the case where 'object' should remain available after
 318  * the function returns, the function 'json_object_get' shall be used.
 319  *
 320  * Returns the count of clients that received the event.
 321  */
 322 int afb_event_broadcast(struct afb_event event, struct json_object *object);
 323
 324 /*
 325  * Pushes the 'event' with the data 'object' to its observers.
 326  * 'object' can be NULL.
 327  *
 328  * For convenience, the function calls 'json_object_put' for 'object'.
 329  * Thus, in the case where 'object' should remain available after
 330  * the function returns, the function 'json_object_get' shall be used.
 331  *
 332  * Returns the count of clients that received the event.
 333  */
 334 int afb_event_push(struct afb_event event, struct json_object *object);
 335 ```
 336
 337 The following function destiys the event.
 338
 339 ```C
 340 /*
 341  * Drops the data associated to the 'event'
 342  * After calling this function, the event
 343  * MUST NOT BE USED ANYMORE.
 344  */
 345 void afb_event_drop(struct afb_event event);
 346 ```
 347
 348 This function allows to retrieve the exact name of the event.
 349
 350 ```C
 351 /*
 352  * Gets the name associated to the 'event'.
 353  */
 354 const char *afb_event_name(struct afb_event event);
 355 ```
 356
 357 ## Functions of class afb_req
 358
 359 This function checks the validity of the **req**.
 360
 361 ```C
 362 /*
 363  * Checks wether the request 'req' is valid or not.
 364  *
 365  * Returns 0 if not valid or 1 if valid.
 366  */
 367 int afb_req_is_valid(struct afb_req req);
 368 ```
 369
 370 The following functions retrieves parameters of the request.
 371
 372 ```C
 373 /*
 374  * Gets from the request 'req' the argument of 'name'.
 375  * Returns a PLAIN structure of type 'struct afb_arg'.
 376  * When the argument of 'name' is not found, all fields of result are set to NULL.
 377  * When the argument of 'name' is found, the fields are filled,
 378  * in particular, the field 'result.name' is set to 'name'.
 379  *
 380  * There is a special name value: the empty string.
 381  * The argument of name "" is defined only if the request was made using
 382  * an HTTP POST of Content-Type "application/json". In that case, the
 383  * argument of name "" receives the value of the body of the HTTP request.
 384  */
 385 struct afb_arg afb_req_get(struct afb_req req, const char *name);
 386
 387 /*
 388  * Gets from the request 'req' the string value of the argument of 'name'.
 389  * Returns NULL if when there is no argument of 'name'.
 390  * Returns the value of the argument of 'name' otherwise.
 391  *
 392  * Shortcut for: afb_req_get(req, name).value
 393  */
 394 const char *afb_req_value(struct afb_req req, const char *name);
 395
 396 /*
 397  * Gets from the request 'req' the path for file attached to the argument of 'name'.
 398  * Returns NULL if when there is no argument of 'name' or when there is no file.
 399  * Returns the path of the argument of 'name' otherwise.
 400  *
 401  * Shortcut for: afb_req_get(req, name).path
 402  */
 403 const char *afb_req_path(struct afb_req req, const char *name);
 404
 405 /*
 406  * Gets from the request 'req' the json object hashing the arguments.
 407  * The returned object must not be released using 'json_object_put'.
 408  */
 409 struct json_object *afb_req_json(struct afb_req req);
 410 ```
 411
 412 The following functions emit the reply to the request.
 413
 414 ```C
 415 /*
 416  * Sends a reply of kind success to the request 'req'.
 417  * The status of the reply is automatically set to "success".
 418  * Its send the object 'obj' (can be NULL) with an
 419  * informationnal comment 'info (can also be NULL).
 420  *
 421  * For convenience, the function calls 'json_object_put' for 'obj'.
 422  * Thus, in the case where 'obj' should remain available after
 423  * the function returns, the function 'json_object_get' shall be used.
 424  */
 425 void afb_req_success(struct afb_req req, struct json_object *obj, const char *info);
 426
 427 /*
 428  * Same as 'afb_req_success' but the 'info' is a formatting
 429  * string followed by arguments.
 430  *
 431  * For convenience, the function calls 'json_object_put' for 'obj'.
 432  * Thus, in the case where 'obj' should remain available after
 433  * the function returns, the function 'json_object_get' shall be used.
 434  */
 435 void afb_req_success_f(struct afb_req req, struct json_object *obj, const char *info, ...);
 436
 437 /*
 438  * Same as 'afb_req_success_f' but the arguments to the format 'info'
 439  * are given as a variable argument list instance.
 440  *
 441  * For convenience, the function calls 'json_object_put' for 'obj'.
 442  * Thus, in the case where 'obj' should remain available after
 443  * the function returns, the function 'json_object_get' shall be used.
 444  */
 445 void afb_req_success_v(struct afb_req req, struct json_object *obj, const char *info, va_list args);
 446
 447 /*
 448  * Sends a reply of kind failure to the request 'req'.
 449  * The status of the reply is set to 'status' and an
 450  * informationnal comment 'info' (can also be NULL) can be added.
 451  *
 452  * Note that calling afb_req_fail("success", info) is equivalent
 453  * to call afb_req_success(NULL, info). Thus even if possible it
 454  * is strongly recommended to NEVER use "success" for status.
 455  */
 456 void afb_req_fail(struct afb_req req, const char *status, const char *info);
 457
 458 /*
 459  * Same as 'afb_req_fail' but the 'info' is a formatting
 460  * string followed by arguments.
 461  */
 462 void afb_req_fail_f(struct afb_req req, const char *status, const char *info, ...);
 463
 464 /*
 465  * Same as 'afb_req_fail_f' but the arguments to the format 'info'
 466  * are given as a variable argument list instance.
 467  */
 468 void afb_req_fail_v(struct afb_req req, const char *status, const char *info, va_list args);
 469 ```
 470
 471 The following functions handle the session data.
 472
 473 ```C
 474 /*
 475  * Gets the pointer stored by the binding for the session of 'req'.
 476  * When the binding has not yet recorded a pointer, NULL is returned.
 477  */
 478 void *afb_req_context_get(struct afb_req req);
 479
 480 /*
 481  * Stores for the binding the pointer 'context' to the session of 'req'.
 482  * The function 'free_context' will be called when the session is closed
 483  * or if binding stores an other pointer.
 484  */
 485 void afb_req_context_set(struct afb_req req, void *context, void (*free_context)(void*));
 486
 487 /*
 488  * Gets the pointer stored by the binding for the session of 'req'.
 489  * If the stored pointer is NULL, indicating that no pointer was
 490  * already stored, afb_req_context creates a new context by calling
 491  * the function 'create_context' and stores it with the freeing function
 492  * 'free_context'.
 493  */
 494 void *afb_req_context(struct afb_req req, void *(*create_context)(), void (*free_context)(void*));
 495
 496 /*
 497  * Frees the pointer stored by the binding for the session of 'req'
 498  * and sets it to NULL.
 499  *
 500  * Shortcut for: afb_req_context_set(req, NULL, NULL)
 501  */
 502 void afb_req_context_clear(struct afb_req req);
 503
 504 /*
 505  * Closes the session associated with 'req'
 506  * and delete all associated contexts.
 507  */
 508 void afb_req_session_close(struct afb_req req);
 509
 510 /*
 511  * Sets the level of assurance of the session of 'req'
 512  * to 'level'. The effect of this function is subject of
 513  * security policies.
 514  * Returns 1 on success or 0 if failed.
 515  */
 516 int afb_req_session_set_LOA(struct afb_req req, unsigned level);
 517 ```
 518
 519 The 4 following functions must be used for asynchronous handling requests.
 520
 521 ```C
 522 /*
 523  * Adds one to the count of references of 'req'.
 524  * This function MUST be called by asynchronous implementations
 525  * of verbs if no reply was sent before returning.
 526  */
 527 void afb_req_addref(struct afb_req req);
 528
 529 /*
 530  * Substracts one to the count of references of 'req'.
 531  * This function MUST be called by asynchronous implementations
 532  * of verbs after sending the asynchronous reply.
 533  */
 534 void afb_req_unref(struct afb_req req);
 535
 536 /*
 537  * Stores 'req' on heap for asynchronous use.
 538  * Returns a handler to the stored 'req' or NULL on memory depletion.
 539  * The count of reference to 'req' is incremented on success
 540  * (see afb_req_addref).
 541  */
 542 struct afb_stored_req *afb_req_store(struct afb_req req);
 543
 544 /*
 545  * Retrieves the afb_req stored at 'sreq'.
 546  * Returns the stored request.
 547  * The count of reference is UNCHANGED, thus, the
 548  * function 'afb_req_unref' should be called on the result
 549  * after that the asynchronous reply if sent.
 550  */
 551 struct afb_req afb_req_unstore(struct afb_stored_req *sreq);
 552 ```
 553
 554 The two following functions are used to associate client with events
 555 (subscription).
 556
 557 ```C
 558 /*
 559  * Establishes for the client link identified by 'req' a subscription
 560  * to the 'event'.
 561  * Returns 0 in case of successful subscription or -1 in case of error.
 562  */
 563 int afb_req_subscribe(struct afb_req req, struct afb_event event);
 564
 565 /*
 566  * Revokes the subscription established to the 'event' for the client
 567  * link identified by 'req'.
 568  * Returns 0 in case of successful subscription or -1 in case of error.
 569  */
 570 int afb_req_unsubscribe(struct afb_req req, struct afb_event event);
 571 ```
 572
 573 The following functions must be used to make request in the name of the
 574 client (with its permissions).
 575
 576 ```C
 577 /*
 578  * Makes a call to the method of name 'api' / 'verb' with the object 'args'.
 579  * This call is made in the context of the request 'req'.
 580  * On completion, the function 'callback' is invoked with the
 581  * 'closure' given at call and two other parameters: 'iserror' and 'result'.
 582  * 'status' is 0 on success or negative when on an error reply.
 583  * 'result' is the json object of the reply, you must not call json_object_put
 584  * on the result.
 585  *
 586  * For convenience, the function calls 'json_object_put' for 'args'.
 587  * Thus, in the case where 'args' should remain available after
 588  * the function returns, the function 'json_object_get' shall be used.
 589  */
 590 void afb_req_subcall(
 591                 struct afb_req req,
 592                 const char *api,
 593                 const char *verb,
 594                 struct json_object *args,
 595                 void (*callback)(void *closure, int status, struct json_object *result),
 596                 void *closure);
 597
 598 /*
 599  * Makes a call to the method of name 'api' / 'verb' with the object 'args'.
 600  * This call is made in the context of the request 'req'.
 601  * This call is synchronous, it waits untill completion of the request.
 602  * It returns 0 on success or a negative value on error answer.
 603  * The object pointed by 'result' is filled and must be released by the caller
 604  * after its use by calling 'json_object_put'.
 605  *
 606  * For convenience, the function calls 'json_object_put' for 'args'.
 607  * Thus, in the case where 'args' should remain available after
 608  * the function returns, the function 'json_object_get' shall be used.
 609  */
 610 int afb_req_subcall_sync(
 611                 struct afb_req req,
 612                 const char *api,
 613                 const char *verb,
 614                 struct json_object *args,
 615                 struct json_object **result);
 616 ```
 617
 618 The following function is used by logging macros and should normally
 619 not be used.
 620 Instead, you should use the macros:
 621
 622 - **AFB_REQ_ERROR**
 623 - **AFB_REQ_WARNING**
 624 - **AFB_REQ_NOTICE**
 625 - **AFB_REQ_INFO**
 626 - **AFB_REQ_DEBUG**
 627
 628 ```C
 629 /*
 630  * Send associated to 'req' a message described by 'fmt' and following parameters
 631  * to the journal for the verbosity 'level'.
 632  *
 633  * 'file', 'line' and 'func' are indicators of position of the code in source files
 634  * (see macros __FILE__, __LINE__ and __func__).
 635  *
 636  * 'level' is defined by syslog standard:
 637  *      EMERGENCY         0        System is unusable
 638  *      ALERT             1        Action must be taken immediately
 639  *      CRITICAL          2        Critical conditions
 640  *      ERROR             3        Error conditions
 641  *      WARNING           4        Warning conditions
 642  *      NOTICE            5        Normal but significant condition
 643  *      INFO              6        Informational
 644  *      DEBUG             7        Debug-level messages
 645  */
 646 void afb_req_verbose(struct afb_req req, int level, const char *file, int line, const char * func, const char *fmt, ...);
 647 ```
 648
 649 ## Logging macros
 650
 651 The following macros must be used for logging:
 652
 653 ```C
 654 AFB_ERROR(fmt,...)
 655 AFB_WARNING(fmt,...)
 656 AFB_NOTICE(fmt,...)
 657 AFB_INFO(fmt,...)
 658 AFB_DEBUG(fmt,...)
 659 ```
 660
 661 The following macros can be used for logging in the context
 662 of a request **req** of type **afb_req**:
 663
 664 ```C
 665 AFB_REQ_ERROR(req,fmt,...)
 666 AFB_REQ_WARNING(req,fmt,...)
 667 AFB_REQ_NOTICE(req,fmt,...)
 668 AFB_REQ_INFO(req,fmt,...)
 669 AFB_REQ_DEBUG(req,fmt,...)
 670 ```
 671
 672 By default, the logging macros add file, line and function
 673 indication.