Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add logging for json #418

Open
wants to merge 3 commits into
base: v2.x/staging
Choose a base branch
from
Open

Add logging for json #418

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3591865
Add logging for json
1000TurquoisePogs Nov 17, 2023
f337aaa
Merge branch 'v2.x/staging' into bugfix/log-json
1000TurquoisePogs Mar 28, 2024
89c07fe
Remove TODOs
1000TurquoisePogs Mar 28, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
61 changes: 27 additions & 34 deletions c/json.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,8 @@
#include "unixfile.h"
#include "json.h"
#include "charsets.h"
#include "logging.h"


#ifdef __ZOWE_OS_WINDOWS
typedef int64_t ssize_t;
Expand Down Expand Up @@ -77,20 +79,8 @@ ssize_t write(int fd, const void *buf, size_t count);
# define SOURCE_CODE_CHARSET CCSID_UTF_8
#endif

#define JSON_DEBUG(...) /* fprintf(stderr, __VA_ARGS__) */
#define DUMPBUF($b, $l) /* dumpBufferToStream($b, $l, stderr) */

/* JOE ERROR() is a defined macro in windows, so it needs a more specific name here */

#ifdef METTLE
# define JSONERROR(...) /* TODO */
#else
/* TODO Implement good error handling: the caller must have a way to know if
* an error happened. Most methods currently are void and there's no error
* flag on the printer structure */
# define JSONERROR(...) fprintf(stderr, __VA_ARGS__)
#endif

static
void jsonWriteEscapedString(jsonPrinter *p, char *s, int len);

Expand Down Expand Up @@ -185,7 +175,7 @@ void jsonWriteBufferInternal(jsonPrinter *p, char *text, int len) {
if (jsonShouldStopWriting(p)) {
return;
}
JSON_DEBUG("write buffer internal: text at %p, len %d\n", text, len);
zowelog(NULL, LOG_COMP_JSON, ZOWE_LOG_DEBUG, "write buffer internal: text at %p, len %d\n", text, len);
DUMPBUF(text, len);
if (p->isCustom) {
p->customWrite(p, text, len);
Expand All @@ -198,7 +188,7 @@ void jsonWriteBufferInternal(jsonPrinter *p, char *text, int len) {
} else if (p->fd == _fileno(stderr)){
newWriteReturn = fwrite(text, 1, len, stderr);
} else {
JSONERROR("JSON: can only write to stderr or stdout on Windows, not p->fd=%d\n",p->fd);
zowelog(NULL, LOG_COMP_JSON, ZOWE_LOG_SEVERE, "JSON: can only write to stderr or stdout on Windows, not p->fd=%d\n",p->fd);
jsonSetIOErrorFlag(p);
}
#elif !defined(METTLE)
Expand All @@ -209,15 +199,13 @@ void jsonWriteBufferInternal(jsonPrinter *p, char *text, int len) {
#endif
loopCount++;
if (newWriteReturn < 0) {
/* TODO: Replace by zowelog(...) */
JSONERROR("JSON: write error, rc %d, return code %d, reason code %08X\n",
zowelog(NULL, LOG_COMP_JSON, ZOWE_LOG_SEVERE, "JSON: write error, rc %d, return code %d, reason code %08X\n",
newWriteReturn, returnCode, reasonCode);
jsonSetIOErrorFlag(p);
break;
}
if (loopCount > 10) {
/* TODO: Replace by zowelog(...) */
JSONERROR("JSON: write error, too many attempts\n");
zowelog(NULL, LOG_COMP_JSON, ZOWE_LOG_SEVERE, "JSON: write error, too many attempts\n");
jsonSetIOErrorFlag(p);
break;
}
Expand Down Expand Up @@ -276,7 +264,7 @@ convertToUtf8(jsonPrinter *p, size_t len, char text[len], int inputCCSID) {
p->_conversionBufferSize, "JSON conversion buffer");
if (newBuf == NULL) {
/* the old buffer will be free'd by freeJsonPrinter() if allocated */
JSONERROR("JSON: error, not enough memory to convert\n");
zowelog(NULL, LOG_COMP_JSON, ZOWE_LOG_SEVERE, "JSON: error, not enough memory to convert\n");
return -1;
}
p->_conversionBufferSize = newSize;
Expand All @@ -288,14 +276,14 @@ convertToUtf8(jsonPrinter *p, size_t len, char text[len], int inputCCSID) {
if (convRc == CHARSET_CONVERSION_SUCCESS) {
return convesionOutputLength;
} else if (convRc != CHARSET_SHORT_BUFFER) {
JSONERROR("JSON: conversion error, rc %d, reason %d\n", convRc,
zowelog(NULL, LOG_COMP_JSON, ZOWE_LOG_SEVERE, "JSON: conversion error, rc %d, reason %d\n", convRc,
reasonCode);
return -1;
}
} while (reallocLimit-- > 0);
if (reallocLimit == 0) {
//the old buffer will be free'd by freeJsonPrinter() if allocated
JSONERROR("JSON: error, not enough memory to convert\n");
zowelog(NULL, LOG_COMP_JSON, ZOWE_LOG_SEVERE, "JSON: error, not enough memory to convert\n");
return -1;
}
return len;
Expand All @@ -322,11 +310,11 @@ writeBufferWithEscaping(jsonPrinter *p, size_t len, char text[len]) {

UTF8_GET_NEXT_CHAR(len, text, &i, &utf8Char, &getCharErr);
if (getCharErr != 0) {
JSONERROR("JSON: invalid UTF-8, rc %d\n", getCharErr);
zowelog(NULL, LOG_COMP_JSON, ZOWE_LOG_SEVERE, "JSON: invalid UTF-8, rc %d\n", getCharErr);
return -1;
}

JSON_DEBUG("character at %p + %d, len %d, char %x\n", text, i, len, utf8Char);
zowelog(NULL, LOG_COMP_JSON, ZOWE_LOG_DEBUG, "character at %p + %d, len %d, char %x\n", text, i, len, utf8Char);
if ((utf8Char <= effectiveControlCharBoundary) ||
(utf8Char == UTF8_BACKSLASH) ||
(utf8Char == UTF8_QUOTE)) {
Expand Down Expand Up @@ -359,7 +347,7 @@ writeBufferWithEscaping(jsonPrinter *p, size_t len, char text[len]) {
CHARSET_OUTPUT_USE_BUFFER, &ptrToUtf8Buf, sizeof (escapeUtf),
CCSID_UTF_8, NULL, &convesionOutputLength, &reasonCode);
if (convRc != CHARSET_CONVERSION_SUCCESS) {
JSONERROR("JSON: conversion error, rc %d, reason %d\n",
zowelog(NULL, LOG_COMP_JSON, ZOWE_LOG_SEVERE, "JSON: conversion error, rc %d, reason %d\n",
convRc, reasonCode);
return -1;
}
Expand Down Expand Up @@ -391,23 +379,23 @@ void jsonConvertAndWriteBuffer(jsonPrinter *p, char *text, size_t len,
if (inputCCSID != CCSID_UTF_8) {
ssize_t newLen;

JSON_DEBUG("before conversion, len %d:\n", len);
zowelog(NULL, LOG_COMP_JSON, ZOWE_LOG_DEBUG, "before conversion, len %d:\n", len);
DUMPBUF(text, len);
newLen = convertToUtf8(p, len, text, inputCCSID);
if (newLen < 0) {
JSONERROR("jsonConvertAndWriteBuffer() error: newLen = %d\n",
zowelog(NULL, LOG_COMP_JSON, ZOWE_LOG_SEVERE, "jsonConvertAndWriteBuffer() error: newLen = %d\n",
(int)newLen);
return;
}
JSON_DEBUG("utf8, len %d:\n", newLen);
zowelog(NULL, LOG_COMP_JSON, ZOWE_LOG_DEBUG, "utf8, len %d:\n", newLen);
text = p->_conversionBuffer;
len = newLen;
DUMPBUF(text, len);
}
if (escape) {
ssize_t bytesWritten = writeBufferWithEscaping(p, len, text);
if (bytesWritten < 0){
JSONERROR("jsonConvertAndWriteBuffer() error: bytesWritten = %zd\n",
zowelog(NULL, LOG_COMP_JSON, ZOWE_LOG_SEVERE, "jsonConvertAndWriteBuffer() error: bytesWritten = %zd\n",
bytesWritten);
return;
}
Expand Down Expand Up @@ -1178,13 +1166,18 @@ int jsonTokenizerLookahead(JsonTokenizer *t) {

static
void jsonTokenizerSkipWhitespace(JsonTokenizer *t) {
while (TRUE) {
int loop = 0;
while (loop < 1024) {
char c = jsonTokenizerLookahead(t);
if (isspace(c)) {
jsonTokenizerRead(t);
} else {
break;
}
loop++;
}
if (loop>=1024) {
zowelog(NULL, LOG_COMP_JSON, ZOWE_LOG_SEVERE, "Loop caught in jsonTokenizerSkipWhitespace\n");
}
}

Expand Down Expand Up @@ -1792,6 +1785,9 @@ static Json *jsonGetObject(JsonParser* parser) {
if (jsonIsTokenUnmatched(colonToken)) {
return parser->jsonError;
}

zowelog(NULL, LOG_COMP_JSON, ZOWE_LOG_DEBUG, "json parse object key=%s\n", keyToken->text);

Json *valueJSON = jsonParse(parser);
if (jsonIsError(valueJSON)) {
return parser->jsonError;
Expand Down Expand Up @@ -2482,10 +2478,7 @@ static Json *jsonParseFileInternal(ShortLivedHeap *slh, const char *filename, ch
UnixFile *file = NULL;
int fileLen = 0;

/*
printf("JOE jsonParseFile\n");
fflush(stdout);
*/
zowelog(NULL, LOG_COMP_JSON, ZOWE_LOG_DEBUG, "JSON parse file=%s\n",filename);

file = fileOpen(filename, FILE_OPTION_READ_ONLY, 0, 1024, &returnCode, &reasonCode);
status = fileInfo(filename, &info, &returnCode, &reasonCode);
Expand Down Expand Up @@ -2627,7 +2620,7 @@ static void copyJson(JsonBuilder *builder, Json *parent, char *parentKey, Json *
char *s = jsonAsString(json);
jsonBuildString(builder,parent,parentKey,s,strlen(s),&errorCode);
} else {
JSONERROR("*** PANIC *** unexpected json type %d\n",json->type);
zowelog(NULL, LOG_COMP_JSON, ZOWE_LOG_SEVERE, "*** PANIC *** unexpected json type %d\n",json->type);
return;
}
}
Expand Down
2 changes: 2 additions & 0 deletions h/logging.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,7 @@ ZOWE_PRAGMA_PACK_RESET
#define LOG_COMP_ZOS 0x008F000100130000LLU
#define LOG_COMP_HTTPCLIENT 0x008F000100140000LLU
#define LOG_COMP_JWT 0x008F000100150000LLU
#define LOG_COMP_JSON 0x008F000100160000LLU

#define LOG_DEST_DEV_NULL 0x008F0000
#define LOG_DEST_PRINTF_STDOUT 0x008F0001
Expand Down Expand Up @@ -126,6 +127,7 @@ typedef struct LogComponentsMap_tag {
{LOG_COMP_ZOS, "zos"},\
{LOG_COMP_HTTPCLIENT, "httpclient"},\
{LOG_COMP_JWT, "jwt"},\
{LOG_COMP_JSON, "json"},\
{0, NULL}\
};

Expand Down
Loading